Sales Invoices

Retrieve all invoices.

Get a list of all invoices.

get/sales-invoices

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/sales-invoices
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

order_field'id' | 'time_created' | 'time_invoiced' | 'time_paid' | 'time_due' | 'time_closed' | 'time_issued' | 'time_sent' | 'property' | 'reference' | 'username' | 'status' | 'sales_invoiced' | 'total_price_vat' | 'total_balance' | 'client_name'

The maximum number of invoices returned per page. Used for pagination.

srch_time'time_created' | 'time_invoiced' | 'time_paid' | 'time_due' | 'time_sent' | 'time_received' | 'time_closed' | 'time_issued'

Search date field

srch_contactstring uuid

ID of the contact that is associated with this document.

srch_propertystring uuid

ID of the property that is associated with this document.

srch_userstring uuid

ID of the user who created this document.

srch_status'DRAFT' | 'INVOICED' | 'VOID' | 'PAID' | 'PAID_PARTIALLY'

Search by status

srch_type'INVOICE' | 'CREDIT_NOTE' | 'INVOICE_CIS'

Search by type

srch_date_fromstring d/m/Y

Search by start date

srch_date_tostring d/m/Y

Search by end date

page_sizenumber

Results per page

pagenumber

Current page

order_direction'DESC' | 'ASC'

Sort results ascending or descending

Response

List of all invoices

Example response

[
  {
    "time_received": "2019-05-17",
    "time_sent": "2019-05-17",
    "time_paid": "2025-08-17",
    "time_invoiced": "2025-08-17",
    "time_due": 1755388800,
    "id": 12345,
    "time_modified": "2025-08-18",
    "time_created": "2025-08-17"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.