Function PaymentCyclesApiFactory

PaymentCyclesApi - factory interface export

  • PaymentCyclesApiFactory(configuration?, basePath?, axios?): {
        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<PaymentCycleFinalizeResponse>;
        getPaymentCycleById(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycle>;
        getPaymentCycleEntryById(id: string, entryId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
        listPaymentCycleEntries(id: string, status?: PaymentCycleEntryStatus, name?: string, email?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntryListResponse>;
        listPaymentCycles(feeDirection?: FeeDirection, status?: PaymentCycleStatus, name?: string, 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<PaymentCycle>;
        updatePaymentCycleEntry(id: string, entryId: string, paymentCycleEntryUpdateDeets?: PaymentCycleEntryUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    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<PaymentCycleFinalizeResponse>;
        getPaymentCycleById(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycle>;
        getPaymentCycleEntryById(id: string, entryId: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
        listPaymentCycleEntries(id: string, status?: PaymentCycleEntryStatus, name?: string, email?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntryListResponse>;
        listPaymentCycles(feeDirection?: FeeDirection, status?: PaymentCycleStatus, name?: string, 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<PaymentCycle>;
        updatePaymentCycleEntry(id: string, entryId: string, paymentCycleEntryUpdateDeets?: PaymentCycleEntryUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleEntry>;
    }

    • bulkCreatePaymentCycleEntry:function
    • createPaymentCycle:function
    • createPaymentCycleEntry:function
    • 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
    • getPaymentCycleById:function
      • getPaymentCycleById(id, options?): AxiosPromise<PaymentCycle>

      • summary Retrieve payment cycle details by id

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<PaymentCycle>

        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?, limit?, page?, userId?, options?): 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 AxiosPromise<PaymentCycleEntryListResponse>

        Throws

    • listPaymentCycles:function
      • listPaymentCycles(feeDirection?, status?, name?, limit?, page?, userId?, options?): 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 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 Delete a 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<PaymentCycle>

      • summary Update payment cycle details

        Parameters

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

          Override http request option.

        Returns AxiosPromise<PaymentCycle>

        Throws

    • updatePaymentCycleEntry:function

Settings

Member Visibility