Function PaymentCyclesApiAxiosParamCreator

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

• bulkCreatePaymentCycleEntry: ((id: string, paymentCycleBulkEntryCreateDeets?: PaymentCycleBulkEntryCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Bulk Create a payment entries for a payment cycle

  Throws

  • • (id, paymentCycleBulkEntryCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalpaymentCycleBulkEntryCreateDeets: PaymentCycleBulkEntryCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createPaymentCycle: ((paymentCycleCreateDeets?: PaymentCycleCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Create payment cycle details

  Throws

  • • (paymentCycleCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalpaymentCycleCreateDeets: PaymentCycleCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createPaymentCycleEntry: ((id: string, paymentCycleEntryCreateDeets?: PaymentCycleEntryCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Create a payment entry for a payment cycle

  Throws

  • • (id, paymentCycleEntryCreateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalpaymentCycleEntryCreateDeets: PaymentCycleEntryCreateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deletePaymentCycle: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deletePaymentCycleEntry: ((id: string, entryId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Delete a payment entry for a payment cycle

  Throws

  • • (id, entryId, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • entryId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• finalizePaymentCycleEntry: ((id: string, paymentCycleFinalizeDeets?: PaymentCycleFinalizeDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Finalize to generate and pay invoice

  Throws

  • • (id, paymentCycleFinalizeDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalpaymentCycleFinalizeDeets: PaymentCycleFinalizeDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPaymentCycleById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve payment cycle details by id

  Throws

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPaymentCycleEntryById: ((id: string, entryId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Get payment entry by id

  Throws

  • • (id, entryId, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • entryId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listPaymentCycleEntries: ((id: string, status?: TransactionStatusEnum, name?: string, email?: string, sortByFieldName?: PaymentCycleEntrySortFields, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve a list of payment entries for a cycles

  Throws

  • • (id, status?, name?, email?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listPaymentCycles: ((feeDirection?: FeeDirection, status?: PaymentCycleStatus, name?: string, greaterThanPaymentDate?: string, sortByFieldName?: PaymentCycleSortFields, sortByAscending?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve a list of payments cycles

  Throws

  • • (feeDirection?, status?, name?, greaterThanPaymentDate?, sortByFieldName?, sortByAscending?, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• paymentCyclePayments: ((id: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Retrieve a list of all related payments

  Throws

  • • (id, limit?, page?, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• paymentEntryAvatar: ((id: string, entryId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Get avatar of payment entry for a payment cycle

  Throws

  • • (id, entryId, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • entryId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePaymentCycle: ((id: string, paymentCycleUpdateDeets?: PaymentCycleUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Update payment cycle details

  Throws

  • • (id, paymentCycleUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • OptionalpaymentCycleUpdateDeets: PaymentCycleUpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePaymentCycleEntry: ((id: string, entryId: string, paymentCycleEntryUpdateDeets?: PaymentCycleEntryUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  summary Update a payment entry for a payment cycle

  Throws

  • • (id, entryId, paymentCycleEntryUpdateDeets?, options?): Promise<RequestArgs>

    • Parameters

      • id: string
      • entryId: string
      • OptionalpaymentCycleEntryUpdateDeets: PaymentCycleEntryUpdateDeets
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>