Function InvoicesApiAxiosParamCreator

InvoicesApi - axios parameter creator export

  • InvoicesApiAxiosParamCreator(configuration?): {
        apiInvoicesGet: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiInvoicesIdGet: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiInvoicesPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadInvoice: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        finalizeInvoice: ((id: string, invoiceFinalizeDeets?: InvoiceFinalizeDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        invoicePaymentDetails: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        payInvoice: ((id: string, invoicePayDeets?: InvoicePayDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiInvoicesGet: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiInvoicesIdGet: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiInvoicesPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadInvoice: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        finalizeInvoice: ((id: string, invoiceFinalizeDeets?: InvoiceFinalizeDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        invoicePaymentDetails: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        payInvoice: ((id: string, invoicePayDeets?: InvoicePayDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

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

      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

      Throws

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

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

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

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

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiInvoicesPost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      summary Download invoice pdf

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • finalizeInvoice: ((id: string, invoiceFinalizeDeets?: InvoiceFinalizeDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Finalize draft invoive

      Throws

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

        • Parameters

          • id: string
          • OptionalinvoiceFinalizeDeets: InvoiceFinalizeDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • payInvoice: ((id: string, invoicePayDeets?: InvoicePayDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Pay finalized invoice

      Throws

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

        • Parameters

          • id: string
          • OptionalinvoicePayDeets: InvoicePayDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility