Function PaymentCyclesApiFactory

Returns {
    bulkCreatePaymentCycleEntry(id: string, paymentCycleBulkEntryCreateDeets?: PaymentCycleBulkEntryCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntryBulkResultResponseListResponse>;
    createPaymentCycle(paymentCycleCreateDeets?: PaymentCycleCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycle>;
    createPaymentCycleEntry(id: string, paymentCycleEntryCreateDeets?: PaymentCycleEntryCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
    deletePaymentCycle(id: string, options?: RawAxiosRequestConfig): AxiosPromise<LogicResult>;
    deletePaymentCycleEntry(id: string, entryId: string, options?: RawAxiosRequestConfig): AxiosPromise<LogicResult>;
    finalizePaymentCycleEntry(id: string, paymentCycleFinalizeDeets?: PaymentCycleFinalizeDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleResponse>;
    getPaymentCycleById(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleResponse>;
    getPaymentCycleEntryById(id: string, entryId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
    listPaymentCycleEntries(id: string, status?: TransactionStatusEnum, name?: string, email?: string, sortByFieldName?: PaymentCycleEntrySortFields, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntryListResponse>;
    listPaymentCycles(feeDirection?: FeeDirection, status?: PaymentCycleStatus, name?: string, greaterThanPaymentDate?: string, sortByFieldName?: PaymentCycleSortFields, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleListResponse>;
    paymentCyclePayments(id: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleListResponse>;
    paymentEntryAvatar(id: string, entryId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    updatePaymentCycle(id: string, paymentCycleUpdateDeets?: PaymentCycleUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleResponse>;
    updatePaymentCycleEntry(id: string, entryId: string, paymentCycleEntryUpdateDeets?: PaymentCycleEntryUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
}

• bulkCreatePaymentCycleEntry:function

  • bulkCreatePaymentCycleEntry(id, paymentCycleBulkEntryCreateDeets?, options?): AxiosPromise<PaymentCycleEntryBulkResultResponseListResponse>

  • summary Bulk Create a payment entries for a payment cycle

    Parameters

    • id: string
    • OptionalpaymentCycleBulkEntryCreateDeets: PaymentCycleBulkEntryCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleEntryBulkResultResponseListResponse>

    Throws

• createPaymentCycle:function

  • createPaymentCycle(paymentCycleCreateDeets?, options?): AxiosPromise<PaymentCycle>

  • summary Create payment cycle details

    Parameters

    • OptionalpaymentCycleCreateDeets: PaymentCycleCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycle>

    Throws

• createPaymentCycleEntry:function

  • createPaymentCycleEntry(id, paymentCycleEntryCreateDeets?, options?): AxiosPromise<PaymentCycleEntry>

  • summary Create a payment entry for a payment cycle

    Parameters

    • id: string
    • OptionalpaymentCycleEntryCreateDeets: PaymentCycleEntryCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleEntry>

    Throws

• deletePaymentCycle:function

  • deletePaymentCycle(id, options?): AxiosPromise<LogicResult>

  • summary Delete a payment cycle and all associated payment cycle entries.

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LogicResult>

    Throws

• deletePaymentCycleEntry:function

  • deletePaymentCycleEntry(id, entryId, options?): AxiosPromise<LogicResult>

  • summary Delete a payment entry for a payment cycle

    Parameters

    • id: string
    • entryId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LogicResult>

    Throws

• finalizePaymentCycleEntry:function

  • finalizePaymentCycleEntry(id, paymentCycleFinalizeDeets?, options?): AxiosPromise<PaymentCycleResponse>

  • summary Finalize to generate and pay invoice

    Parameters

    • id: string
    • OptionalpaymentCycleFinalizeDeets: PaymentCycleFinalizeDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleResponse>

    Throws

• getPaymentCycleById:function

  • getPaymentCycleById(id, options?): AxiosPromise<PaymentCycleResponse>

  • summary Retrieve payment cycle details by id

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleResponse>

    Throws

• getPaymentCycleEntryById:function

  • getPaymentCycleEntryById(id, entryId, options?): AxiosPromise<PaymentCycleEntry>

  • summary Get payment entry by id

    Parameters

    • id: string
    • entryId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleEntry>

    Throws

• listPaymentCycleEntries:function

  • listPaymentCycleEntries(id, status?, name?, email?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): AxiosPromise<PaymentCycleEntryListResponse>

  • 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 AxiosPromise<PaymentCycleEntryListResponse>

    Throws

• listPaymentCycles:function

  • listPaymentCycles(feeDirection?, status?, name?, greaterThanPaymentDate?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): AxiosPromise<PaymentCycleListResponse>

  • 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 AxiosPromise<PaymentCycleListResponse>

    Throws

• paymentCyclePayments:function

  • paymentCyclePayments(id, limit?, page?, userId?, options?): AxiosPromise<PaymentCycleListResponse>

  • 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 AxiosPromise<PaymentCycleListResponse>

    Throws

• paymentEntryAvatar:function

  • paymentEntryAvatar(id, entryId, options?): AxiosPromise<void>

  • summary Get avatar of payment entry for a payment cycle

    Parameters

    • id: string
    • entryId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePaymentCycle:function

  • updatePaymentCycle(id, paymentCycleUpdateDeets?, options?): AxiosPromise<PaymentCycleResponse>

  • summary Update payment cycle details

    Parameters

    • id: string
    • OptionalpaymentCycleUpdateDeets: PaymentCycleUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleResponse>

    Throws

• updatePaymentCycleEntry:function

  • updatePaymentCycleEntry(id, entryId, paymentCycleEntryUpdateDeets?, options?): AxiosPromise<PaymentCycleEntry>

  • summary Update a payment entry for a payment cycle

    Parameters

    • id: string
    • entryId: string
    • OptionalpaymentCycleEntryUpdateDeets: PaymentCycleEntryUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaymentCycleEntry>

    Throws