Sales Orders
Mobile

Returns a single sales order.

Returns a single sales order.

get/sales-orders/{uuid}

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/sales-orders/{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.

department_idnumber

Department Id.

property_idstring uuid

Property Id.

planner_idstring uuid

Planner Id.

type'INVOICE' | 'INVOICE_CIS'

Sales order type.

status'DRAFT' | 'ISSUED' | 'CLOSED' | 'CANCELLED'

Sales order status.

time_sentstring YYYY-MM-DD

When was document first sent.

time_receivedstring YYYY-MM-DD

When was document first received by user.

total_discountnumber double

Total Discount

total_costnumber double

Total Cost

total_pricenumber double

Total price ex. VAT

total_price_vatnumber double

Total price inc. VAT

total_vatnumber double

Total 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'

Sales order approval status.

status_delivery'PENDING' | 'RECEIVED' | 'RECEIVED_PARTIALLY'

Sales order delivery status.

status_financial'PENDING' | 'INVOICED' | 'INVOICED_PARTIALLY'

Sales order financial status.

Example response

{
  "time_sent": "2019-05-17",
  "time_received": "2019-05-17",
  "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.