Class InvoicesApi

InvoicesApi - object-oriented interface export InvoicesApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiInvoicesGet apiInvoicesIdGet apiInvoicesPost downloadInvoice finalizeInvoice invoicePaymentDetails payInvoice

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiInvoicesGet

  • apiInvoicesGet(limit?, page?, userId?, options?): Promise<AxiosResponse<Invoice[], any>>

  • 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 Promise<AxiosResponse<Invoice[], any>>

    Throws

    memberof InvoicesApi

apiInvoicesIdGet

  • apiInvoicesIdGet(id, options?): Promise<AxiosResponse<Invoice, any>>

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Invoice, any>>

    Throws

    memberof InvoicesApi

apiInvoicesPost

  • apiInvoicesPost(options?): Promise<AxiosResponse<Invoice, any>>

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Invoice, any>>

    Throws

    memberof InvoicesApi

downloadInvoice

  • downloadInvoice(id, options?): Promise<AxiosResponse<void, any>>

  • summary Download invoice pdf

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof InvoicesApi

finalizeInvoice

  • finalizeInvoice(id, invoiceFinalizeDeets?, options?): Promise<AxiosResponse<Invoice, any>>

  • summary Finalize draft invoive

    Parameters

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

      Override http request option.

    Returns Promise<AxiosResponse<Invoice, any>>

    Throws

    memberof InvoicesApi

invoicePaymentDetails

  • invoicePaymentDetails(id, options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof InvoicesApi

payInvoice

  • payInvoice(id, invoicePayDeets?, options?): Promise<AxiosResponse<Invoice, any>>

  • summary Pay finalized invoice

    Parameters

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

      Override http request option.

    Returns Promise<AxiosResponse<Invoice, any>>

    Throws

    memberof InvoicesApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods