Class InvoicesClient

Hierarchy

GhlClient
- InvoicesClient

Constructors

constructor

new InvoicesClient(accessToken: string): InvoicesClient
Parameters
- accessToken: string
Returns InvoicesClient
Overrides GhlClient.constructor
- Defined in invoices/invoices.client.ts:34

Methods

generateInvoiceNumber

generateInvoiceNumber(
locationId: string,
): Promise<GenerateInvoiceNumberResponse>
Parameters
- locationId: string
Returns Promise<GenerateInvoiceNumberResponse>
- Defined in invoices/invoices.client.ts:38

findById

findById(invoiceId: string, locationId: string): Promise<InvoiceResponse>
Parameters
- invoiceId: string
- locationId: string
Returns Promise<InvoiceResponse>
- Defined in invoices/invoices.client.ts:47

update

update(invoiceId: string, dto: UpdateInvoiceDto): Promise<CreateInvoiceResponse>
Parameters
- invoiceId: string
- dto: UpdateInvoiceDto
Returns Promise<CreateInvoiceResponse>
- Defined in invoices/invoices.client.ts:56

remove

remove(invoiceId: string, locationId: string): Promise<CreateInvoiceResponse>
Parameters
- invoiceId: string
- locationId: string
Returns Promise<CreateInvoiceResponse>
- Defined in invoices/invoices.client.ts:63

voidById

voidById(invoiceId: string, locationId: string): Promise<CreateInvoiceResponse>
Parameters
- invoiceId: string
- locationId: string
Returns Promise<CreateInvoiceResponse>
- Defined in invoices/invoices.client.ts:72

send

send(invoiceId: string, dto: SendInvoiceDto): Promise<SendInvoiceResponse>
Parameters
- invoiceId: string
- dto: SendInvoiceDto
Returns Promise<SendInvoiceResponse>
- Defined in invoices/invoices.client.ts:82

recordPayment

recordPayment(
invoiceId: string,
dto: RecordInvoicePaymentDto,
): Promise<RecordInvoicePaymentResponse>
Parameters
- invoiceId: string
- dto: RecordInvoicePaymentDto
Returns Promise<RecordInvoicePaymentResponse>
- Defined in invoices/invoices.client.ts:89

create

create(dto: CreateInvoiceDto): Promise<CreateInvoiceResponse>
Parameters
- dto: CreateInvoiceDto
Returns Promise<CreateInvoiceResponse>
- Defined in invoices/invoices.client.ts:99

find

find(params: InvoicesSearchParams): Promise<ListInvoicesResponse>
Parameters
- params: InvoicesSearchParams
Returns Promise<ListInvoicesResponse>
- Defined in invoices/invoices.client.ts:103

createTemplate

createTemplate(dto: CreateInvoiceTemplateDto): Promise<InvoiceTemplateResponse>
Parameters
- dto: CreateInvoiceTemplateDto
Returns Promise<InvoiceTemplateResponse>
- Defined in invoices/invoices.client.ts:109

findTemplates

findTemplates(
params: InvoiceScheduleSearchParams,
): Promise<ListInvoiceTemplatesResponse>
Parameters
- params: InvoiceScheduleSearchParams
Returns Promise<ListInvoiceTemplatesResponse>
- Defined in invoices/invoices.client.ts:115

findTemplateById

findTemplateById(
templateId: string,
locationId: string,
): Promise<InvoiceTemplateResponse>
Parameters
- templateId: string
- locationId: string
Returns Promise<InvoiceTemplateResponse>
- Defined in invoices/invoices.client.ts:123

updateTemplate

updateTemplate(
templateId: string,
dto: CreateInvoiceTemplateDto,
): Promise<InvoiceTemplateResponse>
Parameters
- templateId: string
- dto: CreateInvoiceTemplateDto
Returns Promise<InvoiceTemplateResponse>
- Defined in invoices/invoices.client.ts:133

removeTemplate

removeTemplate(
templateId: string,
locationId: string,
): Promise<SuccessDeleteResponse>
Parameters
- templateId: string
- locationId: string
Returns Promise<SuccessDeleteResponse>
- Defined in invoices/invoices.client.ts:143

createSchedule

createSchedule(dto: CreateInvoiceScheduleDto): Promise<InvoiceScheduleResponse>
Parameters
- dto: CreateInvoiceScheduleDto
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:153

findSchedules

findSchedules(
params: InvoiceScheduleSearchParams,
): Promise<ListInvoiceSchedulesResponse>
Parameters
- params: InvoiceScheduleSearchParams
Returns Promise<ListInvoiceSchedulesResponse>
- Defined in invoices/invoices.client.ts:159

findScheduleById

findScheduleById(
scheduleId: string,
locationId: string,
): Promise<InvoiceScheduleResponse>
Parameters
- scheduleId: string
- locationId: string
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:167

updateSchedule

updateSchedule(
scheduleId: string,
dto: UpdateInvoiceScheduleDto,
): Promise<InvoiceScheduleResponse>
Parameters
- scheduleId: string
- dto: UpdateInvoiceScheduleDto
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:177

removeSchedule

removeSchedule(
scheduleId: string,
locationId: string,
): Promise<SuccessDeleteResponse>
Parameters
- scheduleId: string
- locationId: string
Returns Promise<SuccessDeleteResponse>
- Defined in invoices/invoices.client.ts:187

createScheduledInvoice

createScheduledInvoice(
scheduleId: string,
dto: InvoicesSchedule,
): Promise<InvoiceScheduleResponse>
Parameters
- scheduleId: string
- dto: InvoicesSchedule
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:197

manageAutoPayment

manageAutoPayment(
scheduleId: string,
dto: InvoicesAutoPaymentDto,
): Promise<InvoiceScheduleResponse>
Parameters
- scheduleId: string
- dto: InvoicesAutoPaymentDto
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:207

cancelScheduledInvoice

cancelScheduledInvoice(
scheduleId: string,
locationId: string,
): Promise<InvoiceScheduleResponse>
Parameters
- scheduleId: string
- locationId: string
Returns Promise<InvoiceScheduleResponse>
- Defined in invoices/invoices.client.ts:217

createText2Pay

createText2Pay(dto: Text2PayInvoiceDto): Promise<Text2PayResponse>
Parameters
- dto: Text2PayInvoiceDto
Returns Promise<Text2PayResponse>
- Defined in invoices/invoices.client.ts:227