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?: null | string

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

• before?: null | string

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

• first?: null | number

  Return the first n elements from the list

• invoicedSince?: null | string

  List invoices that are invoiced since the given date time.

  Example

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

• invoicedUntil?: null | string

  List invoices that are invoiced until the given date time.

  Example

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

• last?: null | number

  Return the last n elements from the list.

• paymentTypes?: null | PaymentTypeEnum | PaymentTypeEnum[]

  Only list invoices with the given payment types

• statuses?: null | InvoiceStatusEnum | InvoiceStatusEnum[]

  Only list invoices with the given statuses

• subscriptionId?: null | string

  Only list invoices for the subscription with the given ID

• updatedSince?: null | string

  List invoices that are updated since the given date time.

  Example

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

• updatedUntil?: null | string

  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