Sales Invoices

Returns a single invoice.

Returns a single invoice.

get/sales-invoices/{uuid}

Request

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

Path parameters

uuidstring required

UUID of the document

Response

Success

contact_idstring uuid

ID of the contact that is associated with this document.

manager_contact_idstring uuid

Manager Id.

credit_note_idstring uuid

Credit Note Id.

department_idnumber

Department Id.

property_idstring uuid

Property Id.

type'INVOICE' | 'CREDIT_NOTE' | 'INVOICE_CIS'

Type

status'DRAFT' | 'INVOICED' | 'VOID' | 'PAID' | 'PAID_PARTIALLY'

Status Approval

time_receivedstring YYYY-MM-DD

When was document first received by user.

time_sentstring YYYY-MM-DD

When was document first sent.

time_paidstring YYYY-MM-DD

Invoice payment date. Fills when invoice is fully paid.

time_invoicedstring YYYY-MM-DD

Date of invoice

time_dueinteger

Due date.

total_discountnumber double

Total Discount

total_paymentsnumber double

Total Paid

total_costnumber double

Total Cost

total_balancenumber double

Total Balance

total_vatnumber double

Total vat

total_price_vatnumber double

Total price inc. VAT

total_pricenumber double

Total price ex. VAT

referencestring

Auto generated reference of the document.

reference_externalstring

Vendor invoice ID for external reference. Use this field to filter and retrieve all the orders that have this ID. Used for filtering.

idnumber

ID.

uuidstring uuid

UUID.

time_modifiedstring YYYY-MM-DD

Last modification date

time_createdstring YYYY-MM-DD

Creation date

status_approval'PENDING' | 'APPROVED' | 'REJECTED'

Status Approval

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.