Function PaymentCyclesApiFp

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

• bulkCreatePaymentCycleEntry:function

  • bulkCreatePaymentCycleEntry(id, paymentCycleBulkEntryCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntryBulkResultResponseListResponse>)>

  • summary Bulk Create a payment entries for a payment cycle

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntryBulkResultResponseListResponse>)>

    Throws

• createPaymentCycle:function

  • createPaymentCycle(paymentCycleCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

  • summary Create payment cycle details

    Parameters

    • OptionalpaymentCycleCreateDeets: PaymentCycleCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

    Throws

• createPaymentCycleEntry:function

  • createPaymentCycleEntry(id, paymentCycleEntryCreateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntry>)>

  • summary Create a payment entry for a payment cycle

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntry>)>

    Throws

• deletePaymentCycle:function

  • deletePaymentCycle(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogicResult>)>

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogicResult>)>

    Throws

• deletePaymentCycleEntry:function

  • deletePaymentCycleEntry(id, entryId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogicResult>)>

  • summary Delete a payment entry for a payment cycle

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogicResult>)>

    Throws

• finalizePaymentCycleEntry:function

  • finalizePaymentCycleEntry(id, paymentCycleFinalizeDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleFinalizeResponse>)>

  • summary Finalize to generate and pay invoice

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleFinalizeResponse>)>

    Throws

• getPaymentCycleById:function

  • getPaymentCycleById(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

  • summary Retrieve payment cycle details by id

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

    Throws

• getPaymentCycleEntryById:function

  • getPaymentCycleEntryById(id, entryId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntry>)>

  • summary Get payment entry by id

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntry>)>

    Throws

• listPaymentCycleEntries:function

  • listPaymentCycleEntries(id, status?, name?, email?, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntryListResponse>)>

  • summary Retrieve a list of payment entries for a cycles

    Parameters

    • id: string
    • Optionalstatus: PaymentCycleEntryStatus

      draft success warning error processing
    • Optionalname: string
    • Optionalemail: 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntryListResponse>)>

    Throws

• listPaymentCycles:function

  • listPaymentCycles(feeDirection?, status?, name?, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>

  • summary Retrieve a list of payments cycles

    Parameters

    • OptionalfeeDirection: FeeDirection

      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 completedWithErrors failed
    • Optionalname: 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>

    Throws

• paymentCyclePayments:function

  • paymentCyclePayments(id, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleListResponse>)>

    Throws

• paymentEntryAvatar:function

  • paymentEntryAvatar(id, entryId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Delete a payment entry for a payment cycle

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• updatePaymentCycle:function

  • updatePaymentCycle(id, paymentCycleUpdateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

  • summary Update payment cycle details

    Parameters

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

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycle>)>

    Throws

• updatePaymentCycleEntry:function

  • updatePaymentCycleEntry(id, entryId, paymentCycleEntryUpdateDeets?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentCycleEntry>)>

    Throws