Skip to main content

List invoices

GET 
/api/invoices

Required permissions:

  • invoices.view: allows view of invoices for projects where the user is PM or Account.
  • invoices.view_other: allows view of all invoices.

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    project_id integer

    The id of the project to which the invoice must belong.

    issue_date date

    Filter invoices by the issue date.

    Examples:

    Filter invoices issued on a specific date.

    Example: 2024-01-01

    payment_date date

    Filter invoices by the payment date.

    Examples:

    Filter invoices paid on a specific date.

    Example: 2024-01-01

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of invoices.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    status stringrequired

    Possible values: [draft, sent, paid]

    The invoice status

    invoice_number stringnullable

    The invoice number

    purchase_order stringnullable

    The invoice purchase order reference

    value floatrequired

    The invoice value

    exchange_rate floatnullable

    The invoice custom exchange rate

    issue_date YYYY-MM-DDrequired

    The invoice issue date

    payment_date YYYY-MM-DDnullable

    The invoice payment date

    notes stringnullable

    The invoice notes

    project_id integerrequired

    Possible values: >= 1

    The ID of the project associated with this invoice

    budget_area_uid stringnullable

    The UID of the budget area associated with this invoice

    vat_rate_id integernullable

    The ID of the VAT rate associated with this invoice

    payment_term_id integernullable

    The ID of the payment term associated with this invoice

  • ]

Loading...