Class: InvoicesResource

You can use invoices to access all invoices in your project

Methods

fetchAll()

fetchAll(params?, includeRelations?): Promise<PaginatedResponse<FirmhouseInvoice>>;

Retrieve Invoices

Parameters

params?

Parameters to filter invoices by

after?

string | null

Return the elements in the list that come after the specified cursor.

before?

string | null

Return the elements in the list that come before the specified cursor

first?

number | null

Return the first n elements from the list

invoicedSince?

string | null

List invoices that are invoiced since the given date time.

Example

2024-01-15T00:00:00+01:00

invoicedUntil?

string | null

List invoices that are invoiced until the given date time.

Example

2024-01-15T00:00:00+01:00

last?

number | null

Return the last n elements from the list.

paymentTypes?

| PaymentTypeEnum | PaymentTypeEnum[] | null

Only list invoices with the given payment types

statuses?

| InvoiceStatusEnum | InvoiceStatusEnum[] | null

Only list invoices with the given statuses

subscriptionId?

string | null

Only list invoices for the subscription with the given ID

updatedSince?

string | null

List invoices that are updated since the given date time.

Example

2024-01-15T00:00:00+01:00

updatedUntil?

string | null

List invoices that are updated until the given date time.

Example

2024-01-15T00:00:00+01:00

includeRelations?

Relations to include in the response

collectionCases?

boolean

Include collectionCases relation

invoiceLineItems?

boolean

Include invoiceLineItems relation

invoiceReminders?

boolean

Include invoiceReminders relation

originalInvoice?

boolean

Include originalInvoice relation

payment?

boolean

Include payment relation

Returns

Promise<PaginatedResponse<FirmhouseInvoice>>

List of invoices with pagination info