Accounting API
Invoices

List All Invoices

This API endpoint (GET) retrieves all your invoices. The response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests. On successful completion, it returns an array of Invoice Object the number of available results and the flags used for filtering. Permissions: invoices.view

Query Parameters

page * Fetch the results from a specific page. It defaults to 1.



per_page * The number of results to fetch per page. The maximum is 50 and if it defaults to 10.



sort_by An optional identifier used for sorting results. Available options are price, payment, datebought and invoice_id.



filter Optional text used for filtering results by label.



order Determines in which order the results are returned. The available options are asc (ascending) and desc (descending). The default value is desc.



warehouse_id The id of a warehouse to use for filtering. If provided, it will return the invoices that are associated with this warehouse.



affiliate_program_id The id of an affiliate program to use for filtering. If provided, it will return the invoices that are associated with this affiliate program.



discount_id The id of a discount to use for filtering. If provided, it will return the invoices that are associated with this discount.



customer_id The id of a customer to use for filtering. If provided, it will return the invoices that are associated with this customer.



client_id The id of a warehouse to use for filtering. If provided, it will return the invoices that are associated with this client.



subscription_id The id of a subscription to use for filtering. If provided, it will return the invoices that are associated with this subscription.



affiliate_partner_id The id of an affiliate to use for filtering. If provided, it will return the invoices that are associated with this affiliate.



asset_id The id of an asset to use for filtering. If provided, it will return the invoices that are associated with this asset.



minimum_price It will filter invoices whose total price is at least the provided value.



maximum_price It will filter invoices whose total price does not exceed the provided value.



currency currency code Filters invoices by currency.



gateway strings payment code Filter invoices by payment method.



shipping Used to filter invoices by whether they have shipping enabled. The available options are enabled and disabled.



status Used to filter invoices by their paid status. The available options are paid and unpaid.