Invoices | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Invoices

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Invoices(options: InvoicesOptions, http: Client): Invoices

Overrides ThBaseHandler.constructor
- Defined in src/v0/invoices.ts:108
Parameters
- options: InvoicesOptions
- http: Client
Returns Invoices

Properties

endpoint

endpoint: string

http

http: Client

options

options: InvoicesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/invoices'

Methods

create

create(requestObject: InvoicesCreateRequestObject): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:197
Parameters
- requestObject: InvoicesCreateRequestObject
Returns Promise<InvoicesResponse>

deleteOne

deleteOne(invoiceId: string): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:233
Parameters
- invoiceId: string
Returns Promise<InvoicesResponse>

generateUriQueryEmbed

generateUriQueryEmbed(base: string, query?: InvoicesQuery): string

- Defined in src/v0/invoices.ts:123
Parameters
- base: string
- Optional query: InvoicesQuery
Returns string

getAll

getAll(query?: InvoicesQuery): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:140
Parameters
- Optional query: InvoicesQuery
Returns Promise<InvoicesResponse>

getMeta

getMeta(): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:163
Returns Promise<InvoicesResponse>

getOne

getOne(requestObject: InvoicesGetOneRequestObject): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:179
Parameters
- requestObject: InvoicesGetOneRequestObject
Returns Promise<InvoicesResponse>

update

update(requestObject: InvoicesUpdateRequestObject): Promise<InvoicesResponse>

- Defined in src/v0/invoices.ts:215
Parameters
- requestObject: InvoicesUpdateRequestObject
Returns Promise<InvoicesResponse>

Generated using TypeDoc