# ScheduleTransfers
(*scheduleTransfers*)
## Overview
### Available Operations
* [listScheduleSummaries](#listschedulesummaries) - List Schedule Summaries
* [createAchDepositSchedule](#createachdepositschedule) - Create ACH Deposit Schedule
* [listAchDepositSchedules](#listachdepositschedules) - List ACH Deposit Schedules
* [getAchDepositSchedule](#getachdepositschedule) - Get ACH Deposit Schedule
* [updateAchDepositSchedule](#updateachdepositschedule) - Update ACH Deposit Schedules
* [cancelAchDepositSchedule](#cancelachdepositschedule) - Cancel ACH Deposit Schedule
* [createAchWithdrawalSchedule](#createachwithdrawalschedule) - Create ACH Withdrawal Schedule
* [listAchWithdrawalSchedules](#listachwithdrawalschedules) - List ACH Withdrawal Schedules
* [getAchWithdrawalSchedule](#getachwithdrawalschedule) - Get ACH Withdrawal Schedule
* [updateAchWithdrawalSchedule](#updateachwithdrawalschedule) - Update ACH Withdrawal Schedule
* [cancelAchWithdrawalSchedule](#cancelachwithdrawalschedule) - Cancel ACH Withdrawal Schedule
* [createCashJournalSchedule](#createcashjournalschedule) - Create Cash Journal Schedule
* [getCashJournalSchedule](#getcashjournalschedule) - Get Cash Journal Schedule
* [updateCashJournalSchedule](#updatecashjournalschedule) - Update Cash Journal Schedule
* [cancelCashJournalSchedule](#cancelcashjournalschedule) - Cancel Cash Journal Schedule
* [searchCashJournalSchedules](#searchcashjournalschedules) - Search Cash Journal Schedules
* [createCheckWithdrawalSchedule](#createcheckwithdrawalschedule) - Create Check Withdrawal Schedule
* [listCheckWithdrawalSchedules](#listcheckwithdrawalschedules) - List Check Withdrawal Schedules
* [getCheckWithdrawalSchedule](#getcheckwithdrawalschedule) - Get Check Withdrawal Schedule
* [updateCheckWithdrawalSchedule](#updatecheckwithdrawalschedule) - Update Check Withdrawal Schedule
* [cancelCheckWithdrawalSchedule](#cancelcheckwithdrawalschedule) - Cancel Check Withdrawal Schedule
* [createWireWithdrawalSchedule](#createwirewithdrawalschedule) - Create Wire Withdrawal Schedule
* [listWireWithdrawalSchedules](#listwirewithdrawalschedules) - List Wire Withdrawal Schedules
* [getWireWithdrawalSchedule](#getwirewithdrawalschedule) - Get Wire Withdrawal Schedule
* [updateWireWithdrawalSchedule](#updatewirewithdrawalschedule) - Update Wire Withdrawal Schedule
* [cancelWireWithdrawalSchedule](#cancelwirewithdrawalschedule) - Cancel Wire Withdrawal Schedule
## listScheduleSummaries
Lists transfer schedule summaries that match the filter in the request
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.listScheduleSummaries();
for await (const page of result) {
console.log(page);
}
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersListScheduleSummaries } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersListScheduleSummaries.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersListScheduleSummaries(apexascend);
if (res.ok) {
const { value: result } = res;
for await (const page of result) {
console.log(page);
}
} else {
console.log("scheduleTransfersListScheduleSummaries failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | *string* | :heavy_minus_sign: | A CEL string to filter results; See the [CEL Search](https://developer.apexclearing.com/apex-fintech-solutions/docs/cel-search) page in Guides for more information; Filter options include:
`account`
`mechanism`
`direction`
`state`
`start_date`
`end_date` | [object Object] |
| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of schedules to return. The service may return fewer than this value. If unspecified, at most 25 schedules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | [object Object] |
| `pageToken` | *string* | :heavy_minus_sign: | The page token to request | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.TransferScheduleSummariesListScheduleSummariesResponse](../../models/operations/transferschedulesummarieslistschedulesummariesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## createAchDepositSchedule
Creates an ACH deposit transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.createAchDepositSchedule({
bankRelationship: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/bankRelationships/651ef9de0dee00240813e60e",
scheduleDetails: {
amount: {},
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCreateAchDepositSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCreateAchDepositSchedule.js";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCreateAchDepositSchedule(apexascend, {
bankRelationship: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/bankRelationships/651ef9de0dee00240813e60e",
scheduleDetails: {
amount: {},
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCreateAchDepositSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achDepositScheduleCreate` | [components.AchDepositScheduleCreate](../../models/components/achdepositschedulecreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchDepositSchedulesCreateAchDepositScheduleResponse](../../models/operations/achdepositschedulescreateachdepositscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 409 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## listAchDepositSchedules
Return a list of ACH deposit schedules for the specified account and filter params
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.listAchDepositSchedules("01H8FB90ZRRFWXB4XC2JPJ1D4Y");
for await (const page of result) {
console.log(page);
}
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersListAchDepositSchedules } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersListAchDepositSchedules.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersListAchDepositSchedules(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
for await (const page of result) {
console.log(page);
}
} else {
console.log("scheduleTransfersListAchDepositSchedules failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `filter` | *string* | :heavy_minus_sign: | A CEL string to filter results; See the [CEL Search](https://developer.apexclearing.com/apex-fintech-solutions/docs/cel-search) page in Guides for more information; Filter options include:
`state`
`start_date`
`end_date` | [object Object] |
| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of schedules to return. The service may return fewer than this value. If unspecified, at most 25 schedules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | [object Object] |
| `pageToken` | *string* | :heavy_minus_sign: | The page token to request | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchDepositSchedulesListAchDepositSchedulesResponse](../../models/operations/achdepositscheduleslistachdepositschedulesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## getAchDepositSchedule
Gets an ACH deposit transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.getAchDepositSchedule("01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersGetAchDepositSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersGetAchDepositSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersGetAchDepositSchedule(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersGetAchDepositSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achDepositScheduleId` | *string* | :heavy_check_mark: | The achDepositSchedule id. | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchDepositSchedulesGetAchDepositScheduleResponse](../../models/operations/achdepositschedulesgetachdepositscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## updateAchDepositSchedule
Updates the amount of an ACH deposit transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.updateAchDepositSchedule({}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersUpdateAchDepositSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersUpdateAchDepositSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersUpdateAchDepositSchedule(apexascend, {}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersUpdateAchDepositSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achDepositScheduleId` | *string* | :heavy_check_mark: | The achDepositSchedule id. | [object Object] |
| `achDepositScheduleUpdate` | [components.AchDepositScheduleUpdate](../../models/components/achdepositscheduleupdate.md) | :heavy_check_mark: | N/A | |
| `updateMask` | *string* | :heavy_minus_sign: | A field mask representing the update. Note: only the 'schedule_details.amount' field of a schedule is currently updatable | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchDepositSchedulesUpdateAchDepositScheduleResponse](../../models/operations/achdepositschedulesupdateachdepositscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## cancelAchDepositSchedule
Cancels an ACH deposit transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.cancelAchDepositSchedule({
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDepositSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCancelAchDepositSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCancelAchDepositSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCancelAchDepositSchedule(apexascend, {
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achDepositSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCancelAchDepositSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achDepositScheduleId` | *string* | :heavy_check_mark: | The achDepositSchedule id. | [object Object] |
| `cancelAchDepositScheduleRequestCreate` | [components.CancelAchDepositScheduleRequestCreate](../../models/components/cancelachdepositschedulerequestcreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchDepositSchedulesCancelAchDepositScheduleResponse](../../models/operations/achdepositschedulescancelachdepositscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## createAchWithdrawalSchedule
Creates an ACH withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.createAchWithdrawalSchedule({
bankRelationship: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/bankRelationships/651ef9de0dee00240813e60e",
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCreateAchWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCreateAchWithdrawalSchedule.js";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCreateAchWithdrawalSchedule(apexascend, {
bankRelationship: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/bankRelationships/651ef9de0dee00240813e60e",
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCreateAchWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achWithdrawalScheduleCreate` | [components.AchWithdrawalScheduleCreate](../../models/components/achwithdrawalschedulecreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchWithdrawalSchedulesCreateAchWithdrawalScheduleResponse](../../models/operations/achwithdrawalschedulescreateachwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 409 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## listAchWithdrawalSchedules
Return a list of ACH withdrawal schedules for the specified account and filter params
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.listAchWithdrawalSchedules("01H8FB90ZRRFWXB4XC2JPJ1D4Y");
for await (const page of result) {
console.log(page);
}
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersListAchWithdrawalSchedules } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersListAchWithdrawalSchedules.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersListAchWithdrawalSchedules(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
for await (const page of result) {
console.log(page);
}
} else {
console.log("scheduleTransfersListAchWithdrawalSchedules failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `filter` | *string* | :heavy_minus_sign: | A CEL string to filter results; See the [CEL Search](https://developer.apexclearing.com/apex-fintech-solutions/docs/cel-search) page in Guides for more information; Filter options include:
`state`
`start_date`
`end_date` | [object Object] |
| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of schedules to return. The service may return fewer than this value. If unspecified, at most 25 schedules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | [object Object] |
| `pageToken` | *string* | :heavy_minus_sign: | The page token to request | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchWithdrawalSchedulesListAchWithdrawalSchedulesResponse](../../models/operations/achwithdrawalscheduleslistachwithdrawalschedulesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## getAchWithdrawalSchedule
Gets an ACH withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.getAchWithdrawalSchedule("01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersGetAchWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersGetAchWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersGetAchWithdrawalSchedule(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersGetAchWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achWithdrawalScheduleId` | *string* | :heavy_check_mark: | The achWithdrawalSchedule id. | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchWithdrawalSchedulesGetAchWithdrawalScheduleResponse](../../models/operations/achwithdrawalschedulesgetachwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## updateAchWithdrawalSchedule
Updates the amount of an ACH withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.updateAchWithdrawalSchedule({}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersUpdateAchWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersUpdateAchWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersUpdateAchWithdrawalSchedule(apexascend, {}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersUpdateAchWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achWithdrawalScheduleId` | *string* | :heavy_check_mark: | The achWithdrawalSchedule id. | [object Object] |
| `achWithdrawalScheduleUpdate` | [components.AchWithdrawalScheduleUpdate](../../models/components/achwithdrawalscheduleupdate.md) | :heavy_check_mark: | N/A | |
| `updateMask` | *string* | :heavy_minus_sign: | A field mask representing the update. Note: only the 'schedule_details.amount' field of a schedule is currently updatable | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchWithdrawalSchedulesUpdateAchWithdrawalScheduleResponse](../../models/operations/achwithdrawalschedulesupdateachwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## cancelAchWithdrawalSchedule
Cancels an ACH withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.cancelAchWithdrawalSchedule({
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCancelAchWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCancelAchWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCancelAchWithdrawalSchedule(apexascend, {
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/achWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCancelAchWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `achWithdrawalScheduleId` | *string* | :heavy_check_mark: | The achWithdrawalSchedule id. | [object Object] |
| `cancelAchWithdrawalScheduleRequestCreate` | [components.CancelAchWithdrawalScheduleRequestCreate](../../models/components/cancelachwithdrawalschedulerequestcreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.AchWithdrawalSchedulesCancelAchWithdrawalScheduleResponse](../../models/operations/achwithdrawalschedulescancelachwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## createCashJournalSchedule
Creates a Cash Journal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.createCashJournalSchedule({
destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D5Z",
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
sourceAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y",
});
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCreateCashJournalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCreateCashJournalSchedule.js";
import { TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCreateCashJournalSchedule(apexascend, {
destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D5Z",
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
sourceAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCreateCashJournalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [components.CashJournalScheduleCreate](../../models/components/cashjournalschedulecreate.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.CashJournalSchedulesCreateCashJournalScheduleResponse](../../models/operations/cashjournalschedulescreatecashjournalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 409 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## getCashJournalSchedule
Gets a Cash Journal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.getCashJournalSchedule("40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersGetCashJournalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersGetCashJournalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersGetCashJournalSchedule(apexascend, "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersGetCashJournalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cashJournalScheduleId` | *string* | :heavy_check_mark: | The cashJournalSchedule id. | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CashJournalSchedulesGetCashJournalScheduleResponse](../../models/operations/cashjournalschedulesgetcashjournalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## updateCashJournalSchedule
Updates the amount of a Cash Journal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.updateCashJournalSchedule({}, "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersUpdateCashJournalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersUpdateCashJournalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersUpdateCashJournalSchedule(apexascend, {}, "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersUpdateCashJournalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cashJournalScheduleId` | *string* | :heavy_check_mark: | The cashJournalSchedule id. | [object Object] |
| `cashJournalScheduleUpdate` | [components.CashJournalScheduleUpdate](../../models/components/cashjournalscheduleupdate.md) | :heavy_check_mark: | N/A | |
| `updateMask` | *string* | :heavy_minus_sign: | A field mask representing the update. Note: only the 'schedule_details.amount' field of a schedule is currently updatable | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CashJournalSchedulesUpdateCashJournalScheduleResponse](../../models/operations/cashjournalschedulesupdatecashjournalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## cancelCashJournalSchedule
Cancels a Cash Journal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.cancelCashJournalSchedule({
name: "cashJournalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCancelCashJournalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCancelCashJournalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCancelCashJournalSchedule(apexascend, {
name: "cashJournalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCancelCashJournalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cashJournalScheduleId` | *string* | :heavy_check_mark: | The cashJournalSchedule id. | [object Object] |
| `cancelCashJournalScheduleRequestCreate` | [components.CancelCashJournalScheduleRequestCreate](../../models/components/cancelcashjournalschedulerequestcreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CashJournalSchedulesCancelCashJournalScheduleResponse](../../models/operations/cashjournalschedulescancelcashjournalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## searchCashJournalSchedules
Search Cash Journal Schedules visible to the calling service account using the specified search parameters
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.searchCashJournalSchedules({
sourceAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y",
destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D5Z",
filter: "state == 'ACTIVE' && start_date > '2024-04-05' && end_date < '2024-08-10'",
pageSize: 100,
pageToken: "4ZHd3wAaMD1IQ0ZKS2BKV0FSRVdLW4VLWkY1R1B3MU4",
});
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersSearchCashJournalSchedules } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersSearchCashJournalSchedules.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersSearchCashJournalSchedules(apexascend, {
sourceAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y",
destinationAccount: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D5Z",
filter: "state == 'ACTIVE' && start_date > '2024-04-05' && end_date < '2024-08-10'",
pageSize: 100,
pageToken: "4ZHd3wAaMD1IQ0ZKS2BKV0FSRVdLW4VLWkY1R1B3MU4",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersSearchCashJournalSchedules failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.CashJournalSchedulesSearchCashJournalSchedulesRequest](../../models/operations/cashjournalschedulessearchcashjournalschedulesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
### Response
**Promise\<[operations.CashJournalSchedulesSearchCashJournalSchedulesResponse](../../models/operations/cashjournalschedulessearchcashjournalschedulesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## createCheckWithdrawalSchedule
Creates a Check withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
import { DeliveryMethod, TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.createCheckWithdrawalSchedule({
deliveryMethod: DeliveryMethod.Standard,
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCreateCheckWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCreateCheckWithdrawalSchedule.js";
import { DeliveryMethod, TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCreateCheckWithdrawalSchedule(apexascend, {
deliveryMethod: DeliveryMethod.Standard,
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCreateCheckWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `checkWithdrawalScheduleCreate` | [components.CheckWithdrawalScheduleCreate](../../models/components/checkwithdrawalschedulecreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CheckWithdrawalSchedulesCreateCheckWithdrawalScheduleResponse](../../models/operations/checkwithdrawalschedulescreatecheckwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 409 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## listCheckWithdrawalSchedules
Return a list of Check withdrawal schedules for the specified account and filter params
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.listCheckWithdrawalSchedules("01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersListCheckWithdrawalSchedules } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersListCheckWithdrawalSchedules.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersListCheckWithdrawalSchedules(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersListCheckWithdrawalSchedules failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `filter` | *string* | :heavy_minus_sign: | A CEL string to filter results; See the [CEL Search](https://developer.apexclearing.com/apex-fintech-solutions/docs/cel-search) page in Guides for more information; Filter options include:
`state`
`start_date`
`end_date` | [object Object] |
| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of schedules to return. The service may return fewer than this value. If unspecified, at most 25 schedules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | [object Object] |
| `pageToken` | *string* | :heavy_minus_sign: | The page token to request | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CheckWithdrawalSchedulesListCheckWithdrawalSchedulesResponse](../../models/operations/checkwithdrawalscheduleslistcheckwithdrawalschedulesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## getCheckWithdrawalSchedule
Gets a Check withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.getCheckWithdrawalSchedule("01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersGetCheckWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersGetCheckWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersGetCheckWithdrawalSchedule(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersGetCheckWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `checkWithdrawalScheduleId` | *string* | :heavy_check_mark: | The checkWithdrawalSchedule id. | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CheckWithdrawalSchedulesGetCheckWithdrawalScheduleResponse](../../models/operations/checkwithdrawalschedulesgetcheckwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## updateCheckWithdrawalSchedule
Updates the amount of a Check withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.updateCheckWithdrawalSchedule({}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersUpdateCheckWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersUpdateCheckWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersUpdateCheckWithdrawalSchedule(apexascend, {}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersUpdateCheckWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `checkWithdrawalScheduleId` | *string* | :heavy_check_mark: | The checkWithdrawalSchedule id. | [object Object] |
| `checkWithdrawalScheduleUpdate` | [components.CheckWithdrawalScheduleUpdate](../../models/components/checkwithdrawalscheduleupdate.md) | :heavy_check_mark: | N/A | |
| `updateMask` | *string* | :heavy_minus_sign: | A field mask representing the update. Note: only the 'schedule_details.amount' field of a schedule is currently updatable | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CheckWithdrawalSchedulesUpdateCheckWithdrawalScheduleResponse](../../models/operations/checkwithdrawalschedulesupdatecheckwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## cancelCheckWithdrawalSchedule
Cancels a Check withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.cancelCheckWithdrawalSchedule({
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/checkWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCancelCheckWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCancelCheckWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCancelCheckWithdrawalSchedule(apexascend, {
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/checkWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCancelCheckWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `checkWithdrawalScheduleId` | *string* | :heavy_check_mark: | The checkWithdrawalSchedule id. | [object Object] |
| `cancelCheckWithdrawalScheduleRequestCreate` | [components.CancelCheckWithdrawalScheduleRequestCreate](../../models/components/cancelcheckwithdrawalschedulerequestcreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.CheckWithdrawalSchedulesCancelCheckWithdrawalScheduleResponse](../../models/operations/checkwithdrawalschedulescancelcheckwithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## createWireWithdrawalSchedule
Creates a Wire withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
import { RecipientBankBankIdCreateType, TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.createWireWithdrawalSchedule({
beneficiary: {
account: "73849218650987",
},
recipientBank: {
bankId: {
id: "ABNANL2AXXX",
type: RecipientBankBankIdCreateType.Bic,
},
},
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCreateWireWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCreateWireWithdrawalSchedule.js";
import { RecipientBankBankIdCreateType, TimeUnit } from "@apexfintechsolutions/ascend-sdk/models/components";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCreateWireWithdrawalSchedule(apexascend, {
beneficiary: {
account: "73849218650987",
},
recipientBank: {
bankId: {
id: "ABNANL2AXXX",
type: RecipientBankBankIdCreateType.Bic,
},
},
scheduleDetails: {
clientScheduleId: "ABC-123",
scheduleProperties: {
startDate: {},
timeUnit: TimeUnit.Month,
unitMultiplier: 1,
},
},
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCreateWireWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `wireWithdrawalScheduleCreate` | [components.WireWithdrawalScheduleCreate](../../models/components/wirewithdrawalschedulecreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.WireWithdrawalSchedulesCreateWireWithdrawalScheduleResponse](../../models/operations/wirewithdrawalschedulescreatewirewithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 409 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## listWireWithdrawalSchedules
Return a list of Wire withdrawal schedules for the specified account and filter params
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.listWireWithdrawalSchedules("01H8FB90ZRRFWXB4XC2JPJ1D4Y");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersListWireWithdrawalSchedules } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersListWireWithdrawalSchedules.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersListWireWithdrawalSchedules(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersListWireWithdrawalSchedules failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `filter` | *string* | :heavy_minus_sign: | A CEL string to filter results; See the [CEL Search](https://developer.apexclearing.com/apex-fintech-solutions/docs/cel-search) page in Guides for more information; Filter options include:
`state`
`start_date`
`end_date` | [object Object] |
| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of schedules to return. The service may return fewer than this value. If unspecified, at most 25 schedules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | [object Object] |
| `pageToken` | *string* | :heavy_minus_sign: | The page token to request | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.WireWithdrawalSchedulesListWireWithdrawalSchedulesResponse](../../models/operations/wirewithdrawalscheduleslistwirewithdrawalschedulesresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## getWireWithdrawalSchedule
Gets a Wire withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.getWireWithdrawalSchedule("01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersGetWireWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersGetWireWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersGetWireWithdrawalSchedule(apexascend, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersGetWireWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `wireWithdrawalScheduleId` | *string* | :heavy_check_mark: | The wireWithdrawalSchedule id. | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.WireWithdrawalSchedulesGetWireWithdrawalScheduleResponse](../../models/operations/wirewithdrawalschedulesgetwirewithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## updateWireWithdrawalSchedule
Updates the amount of a Wire withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.updateWireWithdrawalSchedule({}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersUpdateWireWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersUpdateWireWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersUpdateWireWithdrawalSchedule(apexascend, {}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersUpdateWireWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `wireWithdrawalScheduleId` | *string* | :heavy_check_mark: | The wireWithdrawalSchedule id. | [object Object] |
| `wireWithdrawalScheduleUpdate` | [components.WireWithdrawalScheduleUpdate](../../models/components/wirewithdrawalscheduleupdate.md) | :heavy_check_mark: | N/A | |
| `updateMask` | *string* | :heavy_minus_sign: | A field mask representing the update. Note: only the 'schedule_details.amount' field of a schedule is currently updatable | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.WireWithdrawalSchedulesUpdateWireWithdrawalScheduleResponse](../../models/operations/wirewithdrawalschedulesupdatewirewithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
## cancelWireWithdrawalSchedule
Cancels a Wire withdrawal transfer schedule
### Example Usage
```typescript
import { Apexascend } from "@apexfintechsolutions/ascend-sdk";
const apexascend = new Apexascend({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const result = await apexascend.scheduleTransfers.cancelWireWithdrawalSchedule({
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
console.log(result);
}
run();
```
### Standalone function
The standalone function version of this method:
```typescript
import { ApexascendCore } from "@apexfintechsolutions/ascend-sdk/core.js";
import { scheduleTransfersCancelWireWithdrawalSchedule } from "@apexfintechsolutions/ascend-sdk/funcs/scheduleTransfersCancelWireWithdrawalSchedule.js";
// Use `ApexascendCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apexascend = new ApexascendCore({
security: {
apiKey: "ABCDEFGHIJ0123456789abcdefghij0123456789",
serviceAccountCreds: {
privateKey: "-----BEGIN PRIVATE KEY--{OMITTED FOR BREVITY}",
name: "FinFirm",
organization: "correspondents/00000000-0000-0000-0000-000000000000",
type: "serviceAccount",
},
},
});
async function run() {
const res = await scheduleTransfersCancelWireWithdrawalSchedule(apexascend, {
name: "accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireWithdrawalSchedules/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1",
}, "01H8FB90ZRRFWXB4XC2JPJ1D4Y", "40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1");
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("scheduleTransfersCancelWireWithdrawalSchedule failed:", res.error);
}
}
run();
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `accountId` | *string* | :heavy_check_mark: | The account id. | [object Object] |
| `wireWithdrawalScheduleId` | *string* | :heavy_check_mark: | The wireWithdrawalSchedule id. | [object Object] |
| `cancelWireWithdrawalScheduleRequestCreate` | [components.CancelWireWithdrawalScheduleRequestCreate](../../models/components/cancelwirewithdrawalschedulerequestcreate.md) | :heavy_check_mark: | N/A | |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
### Response
**Promise\<[operations.WireWithdrawalSchedulesCancelWireWithdrawalScheduleResponse](../../models/operations/wirewithdrawalschedulescancelwirewithdrawalscheduleresponse.md)\>**
### Errors
| Error Type | Status Code | Content Type |
| ---------------- | ---------------- | ---------------- |
| errors.Status | 400, 403, 404 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |