Function InvoicesApiFactory

InvoicesApi - factory interface export

  • InvoicesApiFactory(configuration?, basePath?, axios?): {
        apiInvoicesGet(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Invoice[]>;
        apiInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        apiInvoicesPost(options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        downloadInvoice(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        finalizeInvoice(id: string, invoiceFinalizeDeets?: InvoiceFinalizeDeets, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        invoicePaymentDetails(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        payInvoice(id: string, invoicePayDeets?: InvoicePayDeets, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
    }

  • Parameters

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

    Returns {
        apiInvoicesGet(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Invoice[]>;
        apiInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        apiInvoicesPost(options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        downloadInvoice(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        finalizeInvoice(id: string, invoiceFinalizeDeets?: InvoiceFinalizeDeets, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
        invoicePaymentDetails(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        payInvoice(id: string, invoicePayDeets?: InvoicePayDeets, options?: RawAxiosRequestConfig): AxiosPromise<Invoice>;
    }

    • apiInvoicesGet:function
      • apiInvoicesGet(limit?, page?, userId?, options?): AxiosPromise<Invoice[]>

      • Invoices represent the lifecyle of moving funds from start to finish. Once a Invoice completes it provides the resulting invoices and payment ledgers for double-entry Invoiceing. Most Invoices are single-use.

        summary Retrieve a list of Invoices

        Parameters

        • 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<Invoice[]>

        Throws

    • apiInvoicesIdGet:function
      • apiInvoicesIdGet(id, options?): AxiosPromise<Invoice>

      • Returns a single Invoice if found summary Find a Invoice by ID

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Invoice>

        Throws

    • apiInvoicesPost:function
      • apiInvoicesPost(options?): AxiosPromise<Invoice>

      • Invoices are used as funding sources that are attached to Orchestrations. summary Create a Invoice

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Invoice>

        Throws

    • downloadInvoice:function
      • downloadInvoice(id, options?): AxiosPromise<void>

      • summary Download invoice pdf

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • finalizeInvoice:function
      • finalizeInvoice(id, invoiceFinalizeDeets?, options?): AxiosPromise<Invoice>

      • summary Finalize draft invoive

        Parameters

        • id: string
        • OptionalinvoiceFinalizeDeets: InvoiceFinalizeDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Invoice>

        Throws

    • invoicePaymentDetails:function
      • invoicePaymentDetails(id, options?): AxiosPromise<void>

      • Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • payInvoice:function
      • payInvoice(id, invoicePayDeets?, options?): AxiosPromise<Invoice>

      • summary Pay finalized invoice

        Parameters

        • id: string
        • OptionalinvoicePayDeets: InvoicePayDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Invoice>

        Throws

Settings

Member Visibility