Interface InvoicesRequestBuilder

Builds and executes requests for operations under /v2/customers/my/invoices

interface InvoicesRequestBuilder {
    byInvoice_uuid(invoice_uuid: string): WithInvoice_uuItemRequestBuilder;
    get(
        requestConfiguration?: RequestConfiguration<
            InvoicesRequestBuilderGetQueryParameters,
        >,
    ): Promise<undefined | InvoicesGetResponse>;
    toGetRequestInformation(
        requestConfiguration?: RequestConfiguration<
            InvoicesRequestBuilderGetQueryParameters,
        >,
    ): RequestInformation;
    withUrl(rawUrl: string): InvoicesRequestBuilder;
}

Hierarchy

BaseRequestBuilder<InvoicesRequestBuilder>
- InvoicesRequestBuilder

Index

Methods

byInvoice_uuid get toGetRequestInformation withUrl

Methods

byInvoice_uuid

byInvoice_uuid(invoice_uuid: string): WithInvoice_uuItemRequestBuilder
Gets an item from the ApiSdk.v2.customers.my.invoices.item collection
Parameters
- invoice_uuid: string
  UUID of the invoice
Returns WithInvoice_uuItemRequestBuilder
- Defined in src/dots/v2/customers/my/invoices/index.ts:61

get

get(
    requestConfiguration?: RequestConfiguration<
        InvoicesRequestBuilderGetQueryParameters,
    >,
): Promise<undefined | InvoicesGetResponse>
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<InvoicesRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns Promise<undefined | InvoicesGetResponse>
Throws
error when the service returns a 401 status code

Throws
error when the service returns a 429 status code

Throws
error when the service returns a 500 status code

Throws
error when the service returns a 4XX or 5XX status code
- Defined in src/dots/v2/customers/my/invoices/index.ts:71

toGetRequestInformation

toGetRequestInformation(
    requestConfiguration?: RequestConfiguration<
        InvoicesRequestBuilderGetQueryParameters,
    >,
): RequestInformation
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
Parameters
- OptionalrequestConfiguration: RequestConfiguration<InvoicesRequestBuilderGetQueryParameters>
  Configuration for the request such as headers, query parameters, and middleware options.
Returns RequestInformation
- Defined in src/dots/v2/customers/my/invoices/index.ts:77

withUrl

withUrl(rawUrl: string): InvoicesRequestBuilder
Parameters
- rawUrl: string
Returns InvoicesRequestBuilder
Inherited from BaseRequestBuilder.withUrl
- Defined in node_modules/@microsoft/kiota-abstractions/dist/es/src/baseRequestBuilder.d.ts:8