Class PaymentCyclesApi

PaymentCyclesApi - object-oriented interface export PaymentCyclesApi

Hierarchy (view full)

BaseAPI
- PaymentCyclesApi

Index

Constructors

constructor

new PaymentCyclesApi(configuration?, basePath?, axios?): PaymentCyclesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PaymentCyclesApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

bulkCreatePaymentCycleEntry

bulkCreatePaymentCycleEntry(id, paymentCycleBulkEntryCreateDeets?, options?): Promise<AxiosResponse<PaymentCycleEntryBulkResultResponseListResponse, any>>
summary Bulk Create a payment entries for a payment cycle
Parameters
- id: string
- OptionalpaymentCycleBulkEntryCreateDeets: PaymentCycleBulkEntryCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleEntryBulkResultResponseListResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24135

createPaymentCycle

createPaymentCycle(paymentCycleCreateDeets?, options?): Promise<AxiosResponse<PaymentCycle, any>>
summary Create payment cycle details
Parameters
- OptionalpaymentCycleCreateDeets: PaymentCycleCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycle, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24147

createPaymentCycleEntry

createPaymentCycleEntry(id, paymentCycleEntryCreateDeets?, options?): Promise<AxiosResponse<PaymentCycleEntry, any>>
summary Create a payment entry for a payment cycle
Parameters
- id: string
- OptionalpaymentCycleEntryCreateDeets: PaymentCycleEntryCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleEntry, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24160

deletePaymentCycle

deletePaymentCycle(id, options?): Promise<AxiosResponse<LogicResult, any>>
summary Delete a payment cycle and all associated payment cycle entries.
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LogicResult, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24172

deletePaymentCycleEntry

deletePaymentCycleEntry(id, entryId, options?): Promise<AxiosResponse<LogicResult, any>>
summary Delete a payment entry for a payment cycle
Parameters
- id: string
- entryId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LogicResult, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24185

finalizePaymentCycleEntry

finalizePaymentCycleEntry(id, paymentCycleFinalizeDeets?, options?): Promise<AxiosResponse<PaymentCycleResponse, any>>
summary Finalize to generate and pay invoice
Parameters
- id: string
- OptionalpaymentCycleFinalizeDeets: PaymentCycleFinalizeDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24198

getPaymentCycleById

getPaymentCycleById(id, options?): Promise<AxiosResponse<PaymentCycleResponse, any>>
summary Retrieve payment cycle details by id
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24210

getPaymentCycleEntryById

getPaymentCycleEntryById(id, entryId, options?): Promise<AxiosResponse<PaymentCycleEntry, any>>
summary Get payment entry by id
Parameters
- id: string
- entryId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleEntry, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24223

listPaymentCycleEntries

listPaymentCycleEntries(id, status?, name?, email?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentCycleEntryListResponse, any>>
summary Retrieve a list of payment entries for a cycles
Parameters
- id: string
- Optionalstatus: TransactionStatusEnum
  Based on JammberMoney.dbo.TransactionStatuses draft pending posted processing sent accepted declined publicHold levied adjusted returned postedUnderThreshold paymentAssigned insufficentFunds offPlatform suspended payoutFailed awaitingPayout received payoutCompleted failed pendingBalance
- Optionalname: string
- Optionalemail: string
- OptionalsortByFieldName: PaymentCycleEntrySortFields
  The field to sort by createdDate amountSent amountPaid status memo
- OptionalsortByAscending: boolean
  Whether the list will be sorted in ascending order. Default value is true
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleEntryListResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24243

listPaymentCycles

listPaymentCycles(feeDirection?, status?, name?, greaterThanPaymentDate?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentCycleListResponse, any>>
summary Retrieve a list of payments cycles
Parameters
- OptionalfeeDirection: FeeDirection
  Defines the direction in which fees are charged. default (Use the platform default fee direction which is to the Payee) payer (Fees are charged to the Payer) payee (Fees are charged to the Payee) split (Fees are split equally between Payer and Payee. Any remaineder is paid by the Payee)
- Optionalstatus: PaymentCycleStatus
  draft locked processing invoicing cancelled completed partiallyCompleted failed
- Optionalname: string
- OptionalgreaterThanPaymentDate: string
- OptionalsortByFieldName: PaymentCycleSortFields
  The field to sort by createdDate paymentDate recipientsCount amountSent amountPaid status memo
- OptionalsortByAscending: boolean
  Whether the list will be sorted in ascending order. Default value is true
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleListResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24263

paymentCyclePayments

paymentCyclePayments(id, limit?, page?, userId?, options?): Promise<AxiosResponse<PaymentCycleListResponse, any>>
summary Retrieve a list of all related payments
Parameters
- id: string
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleListResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24278

paymentEntryAvatar

paymentEntryAvatar(id, entryId, options?): Promise<AxiosResponse<void, any>>
summary Get avatar of payment entry for a payment cycle
Parameters
- id: string
- entryId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24291

updatePaymentCycle

updatePaymentCycle(id, paymentCycleUpdateDeets?, options?): Promise<AxiosResponse<PaymentCycleResponse, any>>
summary Update payment cycle details
Parameters
- id: string
- OptionalpaymentCycleUpdateDeets: PaymentCycleUpdateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleResponse, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24304

updatePaymentCycleEntry

updatePaymentCycleEntry(id, entryId, paymentCycleEntryUpdateDeets?, options?): Promise<AxiosResponse<PaymentCycleEntry, any>>
summary Update a payment entry for a payment cycle
Parameters
- id: string
- entryId: string
- OptionalpaymentCycleEntryUpdateDeets: PaymentCycleEntryUpdateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleEntry, any>>
Throws
memberof PaymentCyclesApi
- Defined in src/api/api.ts:24318

Class PaymentCyclesApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PaymentCyclesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

bulkCreatePaymentCycleEntry

Parameters

Returns Promise<AxiosResponse<PaymentCycleEntryBulkResultResponseListResponse, any>>

Throws

createPaymentCycle

Parameters

Returns Promise<AxiosResponse<PaymentCycle, any>>

Throws

createPaymentCycleEntry

Parameters

Returns Promise<AxiosResponse<PaymentCycleEntry, any>>

Throws

deletePaymentCycle

Parameters

Returns Promise<AxiosResponse<LogicResult, any>>

Throws

deletePaymentCycleEntry

Parameters

Returns Promise<AxiosResponse<LogicResult, any>>

Throws

finalizePaymentCycleEntry

Parameters

Returns Promise<AxiosResponse<PaymentCycleResponse, any>>

Throws

getPaymentCycleById

Parameters

Returns Promise<AxiosResponse<PaymentCycleResponse, any>>

Throws

getPaymentCycleEntryById

Parameters

Returns Promise<AxiosResponse<PaymentCycleEntry, any>>

Throws

listPaymentCycleEntries

Parameters

Returns Promise<AxiosResponse<PaymentCycleEntryListResponse, any>>

Throws

listPaymentCycles

Parameters

Returns Promise<AxiosResponse<PaymentCycleListResponse, any>>

Throws

paymentCyclePayments

Parameters

Returns Promise<AxiosResponse<PaymentCycleListResponse, any>>

Throws

paymentEntryAvatar

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

updatePaymentCycle

Parameters

Returns Promise<AxiosResponse<PaymentCycleResponse, any>>

Throws

updatePaymentCycleEntry

Parameters

Returns Promise<AxiosResponse<PaymentCycleEntry, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration