Skip to content
Lexoh API

API Reference

OpenAPI JSON

Operation directory

Request details, responses and schemas are also available in the OpenAPI download.

Authentication 4
  • POST /v1/auth/login Log in with credentials

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • POST /v1/auth/logout Log out (POST)

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • GET /v1/auth/logout Log out (GET)

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • POST /v1/auth/mfa Validate MFA code

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

Single Sign-On 12
  • GET /v1/sso/providers List enabled SSO providers

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/authorize Initiate SSO login

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/callback SSO OAuth2 callback

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/sso/saml/metadata SAML SP metadata

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/saml/login Initiate SAML login

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/sso/saml/login SAML Login

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/saml/acs SAML Assertion Consumer Service

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/saml/exchange Exchange a one-time SAML handoff code

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/sso/admin/providers List SSO providers (admin)

    Required permissions

    • can_edit_settings or can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/sso/admin/provider Create SSO provider

    Required permissions

    • can_edit_settings or can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/sso/admin/provider Update SSO provider

    Required permissions

    • can_edit_settings or can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/sso/admin/provider Delete SSO provider

    Required permissions

    • can_edit_settings or can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

Access Cards 20
  • POST /v1/access Retrieve a single access card

    Required permissions

    • can_view_access_cards or can_view_guests

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_access_cards
    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/username Retrieve access card by username

    Required permissions

    • can_view_access_cards or can_view_guests

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_access_cards
    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/excel Download access cards as Excel

    Required permissions

    • can_view_access_cards or can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/list List access cards

    Required permissions

    • can_view_access_cards or can_view_guests

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/instruments/list List access instruments for snow operations

    Required permissions

    • can_view_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/access Create a new access card

    Required permissions

    • can_add_access_cards or can_add_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/access Update an access card

    Required permissions

    • can_edit_access_cards or can_edit_guests

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_access_cards
    • can_edit_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/access/lifecycle Update Lifecycle

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/credit/preview Preview a prepaid access-credit movement

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/commit Commit a prepaid access-credit movement

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/purchase Commit a prepaid access-credit purchase

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/consume Commit a prepaid access-credit consume

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/refund Commit a prepaid access-credit refund

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/adjustment Commit a prepaid access-credit adjustment

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/reversal Commit a prepaid access-credit reversal

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/credit/history Retrieve prepaid access-credit history

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/access Delete an access card

    Required permissions

    • can_delete_access_cards or can_delete_guests

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_delete_guests
    • can_delete_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/access/sms Send access card via SMS

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/email Send access card via email

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/access/device Send access card to device

    Required permissions

    All of the following rules are required:

    • can_view_access_cards or can_view_guests
    • can_control_devices

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_access_cards
    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

Entitlement Banks 9
  • POST /v1/entitlement-bank/list List entitlement banks

    Required permissions

    • can_view_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entitlement-bank/get Retrieve an entitlement bank and its assignments

    Required permissions

    • can_view_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entitlement-bank/owner-options List entitlement owners and active units

    Required permissions

    • can_view_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/entitlement-bank Create an entitlement bank

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/entitlement-bank Update a versioned entitlement bank

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/entitlement-bank/access-assignment Assign an access card to an entitlement bank

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entitlement-bank/credit Credit an entitlement bank

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entitlement-bank/consume Consume entitlement and create its settlement

    Required permissions

    • can_edit_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entitlement-bank/history Retrieve entitlement movement history

    Required permissions

    • can_view_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

Devices 17
  • PUT /v1/device Register a new device

    Required permissions

    • can_add_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device Retrieve a single device

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/telemetry/history Get device telemetry history

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/list List all devices

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/type List devices by type

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/location Get device locations

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/device/config Update device configuration

    Required permissions

    • can_edit_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/device/operational-config Update lane/equipment operational configuration

    Required permissions

    • can_edit_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/open Open gate

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/close Close gate

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/close-second Close secondary gate barrier

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/keep_open Keep gate open

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/lost_ticket Process lost ticket

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/reboot Reboot device

    Required permissions

    • can_edit_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/restart Restart device software

    Required permissions

    • can_edit_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/print Print ticket at device

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_access_cards, can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/device/filters Get device filter options

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

Network Agents 6
  • POST /v1/network-agent Retrieve a MikroTik network agent

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/network-agent/list List MikroTik network agents

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/network-agent/telemetry/history Retrieve network-agent telemetry history

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/network-agent/events Retrieve network-agent events

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/network-agent/commands Retrieve network-agent command history

    Required permissions

    • can_view_devices

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/network-agent/command Send a safe compiled network-agent command

    Required permissions

    • can_control_devices

    Authentication, MFA and resource-scope restrictions still apply.

Cameras & Evidence 17
  • POST /v1/camera Retrieve a single camera

    Required permissions

    • can_view_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/camera/list List cameras

    Required permissions

    • can_view_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/camera Create a new camera

    Required permissions

    • can_add_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/camera Update a camera

    Required permissions

    • can_edit_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/camera Delete a camera

    Required permissions

    • can_delete_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/camera/status/{id} Get camera status

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/camera/thumbnail/{id} Get camera thumbnail

    Required permissions

    • can_view_cameras

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/camera/event/thumbnail/{id} Get camera event thumbnail

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/camera/event/clip/{id} Get camera event clip

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/camera/event/vod/{id}/{param} Get camera event VOD

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/camera/event Retrieve a camera event

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/camera/event/list List camera events

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/camera/event Create a camera event

    Required permissions

    • can_add_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/camera/event Update a camera event

    Required permissions

    • can_edit_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/camera/event Delete a camera event

    Required permissions

    • can_delete_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/camera/event/evidence Upload camera evidence

    Required permissions

    • can_add_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/camera/event/evidence/{id}/access Create camera evidence access link

    Required permissions

    • can_view_camera_events

    Authentication, MFA and resource-scope restrictions still apply.

Sites 7
  • POST /v1/site Retrieve a site

    Required permissions

    • can_view_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/site Create a site

    Required permissions

    • can_add_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/site Update a site

    Required permissions

    • can_edit_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/site/snow-features Update snow features for a site

    Required permissions

    • can_edit_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/site Delete a site

    Required permissions

    • can_delete_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/site/list List sites

    Required permissions

    • can_view_sites

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/site/filters Site filter options

    Required permissions

    • can_view_sites

    Authentication, MFA and resource-scope restrictions still apply.

Zones 7
  • POST /v1/zone Retrieve a zone

    Required permissions

    • can_view_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/zone Create a new zone

    Required permissions

    • can_add_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/zone Update a zone

    Required permissions

    • can_edit_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/zone Delete a zone

    Required permissions

    • can_delete_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/zone/list List zones

    Required permissions

    • can_view_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/zone/filters Get zone filter options

    Required permissions

    • can_view_zones

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/zone/availability Get zone availability

    Required permissions

    • can_view_zones

    Authentication, MFA and resource-scope restrictions still apply.

Entries & Exits 18
  • POST /v1/entry Retrieve a parking entry

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/excel Download entries as Excel

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/list List parking entries

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/report Get entries for report view

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/reportExcel Download entry report as Excel

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/entry Update a parking entry

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/entry Create a manual parking entry

    Required permissions

    • can_add_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow Retrieve one snow entry with measurement evidence

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/list List snow entries with bounded operational filters

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/export Export the filtered snow-entry grid as CSV

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/entry/snow/manual Create an audited manual snow entry

    Required permissions

    • can_add_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/entry/snow Correct, soft-delete, or restore a versioned snow entry

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/delete Soft-delete a versioned snow entry

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/restore Restore a soft-deleted snow entry

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/bulk-preview Validate up to 100 versioned snow-entry changes

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/bulk-commit Atomically commit a validated snow-entry batch

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/work-context/preview Preview deterministic snow-entry work context

    Required permissions

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/work-context/resolve Resolve and freeze snow-entry work context

    Required permissions

    • can_edit_entries

    Authentication, MFA and resource-scope restrictions still apply.

Vehicles 18
  • POST /v1/vehicle Retrieve a vehicle

    Required permissions

    • can_view_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/vehicle Create a vehicle

    Required permissions

    • can_add_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/vehicle Update a vehicle

    Required permissions

    • can_edit_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/vehicle/operational-profile Update truck or trailer operational data

    Required permissions

    • can_edit_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/vehicle Delete a vehicle

    Required permissions

    • can_delete_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/vehicle/excel Download vehicles as Excel

    Required permissions

    • can_view_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/vehicle/list List vehicles

    Required permissions

    • can_view_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/vehicle/inventory/list Retrieve Vehicle Inventory

    Required permissions

    • can_view_vehicles

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/vehicle/filters Get vehicle filter options

    Required permissions

    • can_view_vehicles or can_add_access_cards

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/vehicle/load-profiles Retrieve a vehicle load profile

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/vehicle/load-profiles/list List versioned vehicle load profiles

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/vehicle/load-profiles Create a vehicle load-profile draft

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/vehicle/load-profiles Update a vehicle load-profile draft

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/vehicle/load-profiles/approve Approve a vehicle load-profile draft

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/vehicle/load-profiles/reject Reject a vehicle load-profile draft

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/vehicle/load-profiles/publish Publish an approved vehicle load profile

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/vehicle/load-profiles/retire Retire a published vehicle load profile

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/vehicle/load-profiles/history Retrieve vehicle load-profile history

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Customers 12
  • POST /v1/customer Retrieve a single customer

    Required permissions

    • can_view_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/customer/excel Download customers as Excel

    Required permissions

    • can_view_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/customer/list List customers

    Required permissions

    • can_view_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/customer Create a new customer

    Required permissions

    • can_add_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/customer Update a customer

    Required permissions

    • can_edit_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/customer Delete a customer

    Required permissions

    • can_delete_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/customer/filters Get customer filter options

    Required permissions

    • can_view_customers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/customers/{id}/workspace Retrieve customer relationship workspace

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/customer/note/command Mutate a customer note

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/customers/{id}/documents Upload a customer document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/customers/{id}/documents/{param}/download Download a customer document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/customers/{id}/documents/{param} Delete a customer document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Companies 6
  • POST /v1/companies Retrieve a single company

    Required permissions

    • can_view_companies

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/companies/list List companies

    Required permissions

    • can_view_companies

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/companies Create a new company

    Required permissions

    • can_add_companies

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/companies Update a company

    Required permissions

    • can_edit_companies

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/companies Delete a company

    Required permissions

    • can_delete_companies

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/companies/filters Get company filter options

    Required permissions

    • can_view_companies

    Authentication, MFA and resource-scope restrictions still apply.

Contacts 8
  • POST /v1/contact Retrieve a contact

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/contact/list List contacts for a customer or supplier

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_supplier_contacts
    • can_view_customer_contacts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/contact/duplicates Find duplicate contacts for a customer or supplier

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_supplier_contacts
    • can_view_customer_contacts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/contact/activity Retrieve contact commercial document activity

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/contact/merge Merge one contact into another

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/contact Create a contact

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/contact Update a contact

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/contact Delete a contact

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

CRM Follow-Ups 5
  • POST /v1/crm/followups/list List CRM follow-ups

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_customers, can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/crm/followups/options List CRM follow-up options

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_customers, can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/crm/followup Create a CRM follow-up

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_customers, can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/crm/followup Update a versioned CRM follow-up

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_customers, can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/crm/followup Cancel and deactivate a CRM follow-up

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_customers, can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

Suppliers 10
  • POST /v1/supplier/reminder/list Retrieve Reminders

    Required permissions

    • can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/supplier/reminder Insert Reminder

    Required permissions

    • can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/supplier/reminder Update Reminder

    Required permissions

    • can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/supplier/reminder Delete Reminder

    Required permissions

    • can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/supplier/email/list Retrieve Email Activity

    Required permissions

    • can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/supplier Retrieve a supplier

    Required permissions

    • can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/supplier/list List suppliers

    Required permissions

    • can_view_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/supplier Create a supplier

    Required permissions

    • can_add_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/supplier Update a supplier

    Required permissions

    • can_edit_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/supplier Delete a supplier

    Required permissions

    • can_delete_suppliers

    Authentication, MFA and resource-scope restrictions still apply.

Users 12
  • GET /v1/user Get current user from session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/user Retrieve a user by ID

    Required permissions

    • can_view_users

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/user Create a new user

    Required permissions

    • can_add_users

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/user Update a user

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/user Delete a user

    Required permissions

    • can_delete_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/user/list List users

    Required permissions

    • can_view_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/user/filters Get user filter options

    Required permissions

    • can_view_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/user/invite Invite a user by email

    Required permissions

    • can_add_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/user/new_password Send password reset

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/user/save_fcm Save FCM push token

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/user/mfa Generate MFA secret

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/user/mfa/confirm Confirm MFA setup

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

Roles & Permissions 5
  • POST /v1/roles Retrieve a role

    Required permissions

    • can_view_roles

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/roles/list List roles

    Required permissions

    • can_view_roles

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/roles Create a role

    Required permissions

    • can_add_roles

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/roles Update a role

    Required permissions

    • can_edit_roles

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/roles Delete a role

    Required permissions

    • can_delete_roles

    Authentication, MFA and resource-scope restrictions still apply.

Parking Pricing 7
  • POST /v1/pricing/calculate Calculate parking price

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/pricing Retrieve a pricing rule

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/pricing Create a pricing rule

    Required permissions

    • can_add_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/pricing Update a pricing rule

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/pricing Delete a pricing rule

    Required permissions

    • can_delete_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/pricing/list List pricing rules

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/pricing/filters Get pricing filter options

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

Promotions & Vouchers 15
  • POST /v1/promotions Retrieve a promotion

    Required permissions

    • can_view_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/promotions/code Retrieve a promotion code

    Required permissions

    • can_view_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/promotions Create a promotion

    Required permissions

    • can_add_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/promotions/code Create a promotion code

    Required permissions

    • can_add_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/promotions Update a promotion

    Required permissions

    • can_edit_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/promotions/code Update a promotion code

    Required permissions

    • can_edit_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/promotions Delete a promotion

    Required permissions

    • can_delete_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/promotions/code Delete a promotion code

    Required permissions

    • can_delete_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/promotions/list List promotions

    Required permissions

    • can_view_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/promotions/code/list List promotion codes

    Required permissions

    • can_view_promotions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/promotions/filters Get promotion filter options

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/promotions/sms Send promotion via SMS

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/promotions/email Send promotion via email

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/promotions/device Send promotion to device

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/promotions/code/apply Apply a voucher code

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Transactions 8
  • POST /v1/transaction Retrieve a transaction

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/transaction Create a transaction

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/transaction/excel Download transactions as Excel

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/transaction/list List transactions

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/transaction/reportExcel Download transaction report as Excel

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/transaction/email Send transaction receipt via email

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/transaction/sms Send transaction receipt via SMS

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/transaction/refund Refund a transaction

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

Payment Processors 6
  • POST /v1/payment/processor Retrieve Payment Processor

    Required permissions

    • can_edit_general_configs

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payment/processor/available Retrieve Available Payment Processors

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/payment/processor/list Retrieve Payment Processors

    Required permissions

    • can_edit_general_configs

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payment/processor Insert Payment Processor

    Required permissions

    • can_edit_general_configs

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payment/processor Update Payment Processor

    Required permissions

    • can_edit_general_configs

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/payment/processor Delete Payment Processor

    Required permissions

    • can_edit_general_configs

    Authentication, MFA and resource-scope restrictions still apply.

Customer Portal 8
  • POST /v1/public/commercial-document/customer-portal Public customer invoice portal payload

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/public/commercial-document/customer-portal/pay Public customer invoice portal online card payment

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/public/commercial-document/customer-portal/quote/pdf Public customer invoice portal visible quote PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/public/commercial-document/customer-portal/invoice/pdf Public customer invoice portal invoice PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/public/commercial-document/customer-portal/payment/receipt/pdf Public customer invoice portal payment receipt PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/public/commercial-document/customer-portal/creditcard Public customer invoice portal saved credit card create

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/public/commercial-document/customer-portal/creditcard Public customer invoice portal saved credit card update

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/public/commercial-document/customer-portal/creditcard Public customer invoice portal saved credit card delete

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Sales & Purchasing 53
  • POST /v1/commercial-document Retrieve a sales or purchase document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/list List sales and purchase documents

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_sales
    • can_view_purchases

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/invoice/email Send a sales invoice by email with a public customer payment link

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/commercial-document Create a sales or purchase document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/commercial-document/billed-sale Create a fully-paid billed sale (invoice + lines + payment) from an online or device payment

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/commercial-document/payment-event Record a non-settled gateway payment event for reconciliation without revenue

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/billed-sale/import Convert existing paid transactions into billed sales invoices

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/commercial-document Update a sales or purchase document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/status/transition Cancel or void an unposted commercial document with an audited project-billing restoration

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/commercial-document Delete a sales or purchase document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/convert Convert a quote to invoice or a purchase order to invoice

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/reservation/accept Accept a sales quote and reserve its inventory-tracked leaf lines

    Required permissions

    • can_accept_sales_quotes

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/reservation/release Release the undelivered inventory reserved by a sales document

    Required permissions

    • can_release_sales_reservations

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/reservation/summary Retrieve the inventory reservation summary for a sales document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/post Post a sales or purchase invoice to accounting

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_bill_sales
    • can_credit_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/pos/checkout Convert a POS quote to a posted, shipped and paid sales invoice

    Required permissions

    • can_bill_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/payment/list List payments received against a commercial document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/payment/receive Receive a payment against a sales invoice

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/credit/apply Apply a posted credit note against an open invoice without creating a duplicate ledger transaction

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_credit_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/financing/list List financing proposals attached to a commercial document

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/commercial-document/financing Save a financing proposal and generated payment schedule

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring Retrieve a recurring commercial template

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring/list List recurring commercial templates

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_sales
    • can_view_purchases

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/commercial-document/recurring Create a recurring commercial template

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/commercial-document/recurring Update a recurring commercial template

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/commercial-document/recurring Delete a recurring commercial template

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring/run/list List recurring commercial generation runs

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/recurring/generate Generate one draft document from a recurring template

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring/run/retry Retry a failed recurring commercial generation run

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring/run/approve Approve a generated recurring commercial draft

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/recurring/run-due Generate all due draft documents from recurring templates

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_add_sales
    • can_add_purchases

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/payment/receipt Receive one payment and allocate it across multiple sales invoices

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/payment/receipt/pdf Generate a customer payment receipt PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/payment/receipt/sms Send a customer payment receipt by SMS

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/quote/pdf Generate a sales quote PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/invoice/pdf Generate a sales invoice PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/sales-credit-note/pdf Generate a sales credit note PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/purchase-order/pdf Generate a purchase order PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/purchase-invoice/pdf Generate a purchase invoice PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/purchase-credit-note/pdf Generate a purchase credit note PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/delivery/pdf Generate a delivery slip PDF

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/report Sales and purchase report as JSON

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_purchases
    • can_view_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/report/excel Sales and purchase report as Excel

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_purchases
    • can_view_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/report/pdf Sales and purchase report as PDF

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_purchases
    • can_view_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/line Retrieve a sales or purchase document line

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/line/list List sales or purchase document lines

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/fulfillment/list List sales or purchase fulfillment events

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/commercial-document/line Create a sales or purchase document line

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/commercial-document/line Update a sales or purchase document line

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/commercial-document/line Delete a sales or purchase document line

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/line/receive Receive a purchase line into inventory

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/commercial-document/line/ship Ship a sales invoice line from inventory

    Required permissions

    • can_deliver_sales

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/line/return Return a credit-note line to or from inventory

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Products & Inventory 51
  • POST /v1/product/category Retrieve a product category

    Required permissions

    • can_view_product_categories

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/category/list List product categories

    Required permissions

    • can_view_product_categories

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/category Create a product category

    Required permissions

    • can_add_product_categories

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/category Update a product category

    Required permissions

    • can_edit_product_categories

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/group Retrieve a product group

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/group/list List product groups

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/group Create a product group

    Required permissions

    • can_add_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/group Update a product group

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/unit Retrieve a product unit

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/unit/list List product units

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/unit Create a product unit

    Required permissions

    • can_add_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/unit Update a product unit

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product Retrieve a product

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/list List products

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product Create a product

    Required permissions

    • can_add_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product Update a product

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/product Delete a product

    Required permissions

    • can_delete_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/price/calculate Calculate product price

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/kit Retrieve a product kit

    Required permissions

    • can_view_product_kits

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/kit/list List product kits

    Required permissions

    • can_view_product_kits

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/kit Create a product kit

    Required permissions

    • can_add_product_kits

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/kit Update a product kit

    Required permissions

    • can_edit_product_kits

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/product/kit Delete a product kit

    Required permissions

    • can_delete_product_kits

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/price-list Retrieve a product price list

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/price-list/list List product price lists

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/price-list Create a product price list

    Required permissions

    • can_add_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/price-list Update a product price list

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/price-list/customer Assign a product price list to a customer

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/location Retrieve Inventory Location

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/location/list Retrieve Inventory Locations

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/inventory/location Insert Inventory Location

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/inventory/location Update Inventory Location

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/price Retrieve a product price override

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/price/list List product price overrides

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/price Create a product price override

    Required permissions

    • can_add_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/price Update a product price override

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/quantity-price/list List quantity price breaks

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/quantity-price Create a quantity price break

    Required permissions

    • can_add_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/product/quantity-price Update a quantity price break

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/supplier-price/list List supplier product prices

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/supplier-price/import Import supplier product prices

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/supplier-price/export Export supplier product prices

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/supplier-price/export/excel Export supplier product prices as Excel

    Required permissions

    • can_view_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/stock Retrieve product stock

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/report Inventory status or reorder report

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/report/excel Inventory report as Excel

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/reorder/generate Generate purchase orders from reorder suggestions

    Required permissions

    • can_edit_pricings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/movement/list List inventory movements

    Required permissions

    • can_view_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/inventory/movement Create an inventory movement

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/product/inventory/transfer Transfer Inventory

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/product/inventory/count-adjustment Apply a counted inventory adjustment

    Required permissions

    • can_edit_products

    Authentication, MFA and resource-scope restrictions still apply.

Accounting 39
  • POST /v1/account/filters Retrieve an account

    Required permissions

    • can_view_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/account Retrieve Account

    Required permissions

    • can_view_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/account/list List accounts

    Required permissions

    • can_view_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/account Create an account

    Required permissions

    • can_add_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/account Update an account

    Required permissions

    • can_edit_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/account Delete an account

    Required permissions

    • can_delete_chart_of_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/default-account/list List accounting default accounts

    Required permissions

    • can_view_accounting_default_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/accounting/default-account Update accounting default account

    Required permissions

    • can_edit_accounting_default_accounts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/transaction Retrieve an accounting transaction piste

    Required permissions

    • can_view_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/transaction/list List accounting transaction pistes

    Required permissions

    • can_view_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/accounting/transaction Create an accounting transaction piste

    Required permissions

    • can_add_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/transaction/reverse Reverse an accounting transaction piste

    Required permissions

    • can_reverse_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/transaction/duplicate Duplicate an accounting transaction piste

    Required permissions

    • can_reverse_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/transaction/pdf Print an accounting transaction piste

    Required permissions

    • can_view_accounting_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/reconciliation/report Accounting reconciliation report

    Required permissions

    • can_view_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/reconciliation/report/excel Accounting reconciliation report Excel

    Required permissions

    • can_view_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/reconciliation/update Accounting reconciliation update

    Required permissions

    • can_edit_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/tax/rule Retrieve a tax rule

    Required permissions

    • can_view_tax_rules

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/tax/rule/list List tax rules

    Required permissions

    • can_view_tax_rules

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/accounting/tax/rule Create a tax rule

    Required permissions

    • can_add_tax_rules

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/accounting/tax/rule Update a tax rule

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_delete_tax_rules, can_edit_tax_rules

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/tax Retrieve a tax

    Required permissions

    • can_view_taxes

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/tax/list List taxes

    Required permissions

    • can_view_taxes

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/accounting/tax Create a tax

    Required permissions

    • can_add_taxes

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/accounting/tax Update a tax

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_delete_taxes, can_edit_taxes

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/tax/calculate Calculate taxes

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/accounting/period Retrieve an accounting period

    Required permissions

    • can_view_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/period/list List accounting periods

    Required permissions

    • can_view_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/accounting/period Create an accounting period

    Required permissions

    • can_add_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/accounting/period Update an accounting period

    Required permissions

    • can_edit_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/period/close Close an accounting period

    Required permissions

    • can_close_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/period/reopen Reopen an accounting period

    Required permissions

    • can_close_accounting_periods

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/general-ledger General ledger report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/trial-balance Trial balance report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/balance-sheet Balance sheet report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/income-statement Income statement report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/tax Tax accounting report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report Accounting report

    Required permissions

    • can_view_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/accounting/report/excel Accounting report Excel

    Required permissions

    • can_export_accounting_reports

    Authentication, MFA and resource-scope restrictions still apply.

Banking & Reconciliation 66
  • POST /v1/banking/workspace/overview Banking workspace overview

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/workspace/payees Workspace Payees

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/workspace/settlements Workspace Settlements

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/provider/list Bank provider metadata

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/connection/validate Validate bank connection

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/connection Retrieve bank connection

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/connection/list List bank connections

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/connection Save bank connection

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/banking/connection Update bank connection

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/banking/connection Disable bank connection

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch Retrieve bank payment batch

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/list List bank payment batches

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/payment-batch Create bank payment batch

    Required permissions

    • can_create_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/validate Validate bank payment batch

    Required permissions

    • can_create_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/request-approval Request bank payment batch approval

    Required permissions

    • can_create_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/approve Approve bank payment batch

    Required permissions

    • can_approve_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/reject Reject bank payment batch

    Required permissions

    • can_approve_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/cancel Cancel bank payment batch

    Required permissions

    • can_create_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/reverse Reverse Payment Batch

    Required permissions

    • can_reverse_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/settlement-exception Retrieve Settlement Exception

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/settlement-exception/list Retrieve Settlement Exceptions

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/settlement-exception/resolve Resolve Settlement Exception

    Required permissions

    • can_resolve_bank_payment_settlement_exceptions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/submit Submit bank payment batch

    Required permissions

    • can_deliver_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/generate-file Generate bank payment EFT/AFT file

    Required permissions

    • can_deliver_bank_payments

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/download-file Download Payment Batch File

    Required permissions

    • can_download_bank_payment_files

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/payment-batch/status Refresh bank payment batch status

    Required permissions

    • can_resolve_bank_payment_acknowledgements

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/request-for-payment Retrieve bank Request-for-Payment

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/request-for-payment/list List bank Request-for-Payments

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/request-for-payment Create bank Request-for-Payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/request-for-payment/submit Submit bank Request-for-Payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/request-for-payment/status Refresh Request-for-Payment status

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/request-for-payment/cancel Cancel Request-for-Payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment Retrieve bank real-time payment

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment/list List bank real-time payments

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/real-time-payment Create bank real-time payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment/submit Submit bank real-time payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment/status Refresh bank real-time payment status

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment/cancel Cancel bank real-time payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/real-time-payment/options Scotia real-time payment options

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment Retrieve bank wire payment

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment/list List bank wire payments

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/wire-payment Create bank wire payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment/validate Validate bank wire payment

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment/submit Submit bank wire payment

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment/status Refresh bank wire payment status

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/wire-payment/track Track bank wire payment

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/plaid/link-token Create Plaid Link token

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/plaid/public-token/exchange Exchange Plaid public token

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/transaction/import Import bank transactions

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/reconciliation-session/list Retrieve Reconciliation Sessions

    Required permissions

    • can_view_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/reconciliation-session Retrieve Reconciliation Session

    Required permissions

    • can_view_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/reconciliation-session Create Reconciliation Session

    Required permissions

    • can_edit_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/reconciliation-session/close Close Reconciliation Session

    Required permissions

    • can_edit_accounting_reconciliation

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/reconciliation-session/reopen Reopen Reconciliation Session

    Required permissions

    • can_reopen_bank_reconciliation_sessions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/imported-transaction/list List imported bank transactions

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/imported-transaction/post Post imported bank transaction

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/imported-transaction/match Match imported bank transaction

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/imported-transaction/bulk-post Bulk post imported bank transactions

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/import-mapping-rule/list List bank import mapping rules

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/banking/import-mapping-rule Save bank import mapping rule

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/banking/import-mapping-rule Save Import Mapping Rule

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/banking/import-mapping-rule Delete bank import mapping rule

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/provider-balances Retrieve provider bank balances

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/provider-accounts Retrieve provider entitled accounts

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/transaction/sync Sync bank transactions

    Required permissions

    • can_edit_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/banking/account/validate Validate destination bank account

    Required permissions

    • can_view_bank_settings

    Authentication, MFA and resource-scope restrictions still apply.

Payroll 52
  • POST /v1/payroll/employee Retrieve Employee

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/employee/list Retrieve Employees

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/employee Insert Employee

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/employee Update Employee

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/item Retrieve Item

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/item/list Retrieve Items

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/item Insert Item

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/item Update Item

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/item/employee Assign Employee Item

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/employee/category Retrieve Employee Category

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/employee/category/list Retrieve Employee Categories

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/employee/category Insert Employee Category

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/employee/category Update Employee Category

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/employee/category/item/list Retrieve Employee Category Items

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/employee/category/item Assign Employee Category Item

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/employee/category/item Assign Employee Category Item

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/payroll/employee/category/item Delete Employee Category Item

    Required permissions

    • can_edit_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run Retrieve Run

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/list Retrieve Runs

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/run Insert Run

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/run Update Run

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/simulate Simulate Run

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/generate Generate Run

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/run/draft Update Draft Run

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/complete Complete Run

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/post Post Run

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/cancel Cancel Run

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/eft/preview Run Eft Preview

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/eft/settings Save Run Eft Settings

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/run/eft/generate Generate Run Eft

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/remittance/report Remittance Report

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/remittance/post Post Remittance

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/remittance/eft/preview Remittance Eft Preview

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/remittance/eft/settings Save Remittance Eft Settings

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/remittance/eft/generate Generate Remittance Eft

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/tax/rates/list Retrieve Tax Rates

    Required permissions

    • can_view_payroll_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/paystub Pay Stub

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/paystub/pdf Pay Stub Pdf

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/entry Retrieve Entry

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/entry/list Retrieve Entries

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/entry Insert Entry

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/entry Update Entry

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/entry/line Insert Entry Line

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/entry/line Update Entry Line

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/banks/list Retrieve Banks Of Hours

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/banks Insert Bank Of Hours

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/payroll/banks Update Bank Of Hours

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/banks/history/list Retrieve Bank Of Hour History

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/payroll/banks/history Insert Bank Of Hour History

    Required permissions

    • can_edit_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/report Report

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/report/pdf Report Pdf

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/payroll/report/excel Report Excel

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

Measured Pricing & Snow Billing 16
  • POST /v1/commercial-document/snow-billing/sources/query Query priced snow Entries eligible for commercial billing

    Required permissions

    • can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/preview Preview an exact snow commercial document without mutating sources

    Required permissions

    • can_bill_project_work

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/create Create an immutable snow invoice from an accepted preview hash

    Required permissions

    • can_bill_project_work

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/credit Create a full snow credit note that reverses an immutable invoice

    Required permissions

    • can_bill_project_work

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/documents/query Query snow commercial documents

    Required permissions

    • can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/document Retrieve one snow commercial document and its immutable source lines

    Required permissions

    • can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/u4/queue Queue a locked snow document in the disabled U4 outbox

    Required permissions

    • can_bill_project_work

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/u4/query Query durable U4 outbox state without enabling municipal transport

    Required permissions

    • can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/commercial-document/snow-billing/u4/simulate Apply a deterministic non-production U4 QA outcome

    Required permissions

    • can_bill_project_work

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/entry/snow/pricing/preview Preview exact measured pricing for a snow entry

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/entry/snow/pricing/commit Commit an accepted measured-pricing preview

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/product/measured-price/list List versioned measured snow rates, price lists, taxes or catalog options

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/product/measured-price/draft Append a draft version of a measured rate, price list or tax

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/product/measured-price/approve Approve one immutable measured pricing version

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/product/measured-price/retire Retire one immutable measured pricing version

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/product/measured-price/simulate Simulate measured snow pricing without creating or updating an Entry

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

AI & Conversations 15
  • POST /v1/ai/nlp/clear Clear AI conversation

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/nlp/stream NLP query (streaming)

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/ai/nlp NLP query

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/ai/agent Route-backed AI agent

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/agent/stream Route-backed AI agent streaming

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/agent/tools List AI agent tools

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/agent/execute Execute AI agent tool

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/sessions/list List chat sessions

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/sessions/create Create chat session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/sessions/get Get chat session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/sessions/update Update chat session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/sessions/delete Delete chat session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/chat/message Send chat message

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_entries

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/ai/usage AI Usage Summary

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/ai/usage/logs AI Usage Logs

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

MCP & OAuth 17
  • POST /v1/mcp MCP JSON-RPC endpoint

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/mcp Mcp

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/mcp Mcp Sse

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/ai/mcp Mcp Sse

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/mcp/sse MCP SSE transport handshake

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/ai/mcp/sse Mcp Sse

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /.well-known/oauth-protected-resource MCP OAuth discovery

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /.well-known/oauth-protected-resource/v1/mcp Mcp Protected Resource Metadata

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /.well-known/oauth-authorization-server Mcp Authorization Server Metadata

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /oauth/authorize Mcp O Auth Authorize

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /oauth/token Mcp O Auth Token

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/mcp/token MCP token management

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/ai/mcp/token Mcp Token Revoke

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/ai/mcp/token/list Mcp Token List

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/ai/mcp/oauth/client Mcp O Auth Client Create

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/ai/mcp/oauth/client Mcp O Auth Client Revoke

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • GET /v1/ai/mcp/oauth/client/list Mcp O Auth Client List

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Analytics 8
  • POST /v1/analytics/revenue Analytics: revenue grouped by period

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/entries Analytics: entries grouped by period

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/top_zones Analytics: top zones

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/top_customers Analytics: top customers

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/peak_hours Analytics: peak hours

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/vs_prior Analytics: revenue vs prior period

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/payment_breakdown Analytics: payment method breakdown

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/analytics/day_of_week Analytics: day-of-week distribution

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Dashboards 7
  • POST /v1/dashboards/system Get the system overview dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/site Get the site overview dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/zones Get the zones overview dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/devices Get the devices overview dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/operations Get the live operations dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/revenue Get the revenue overview dashboard

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/dashboards/incidents Get the incident management dashboard

    Required permissions

    • can_view_incidents

    Authentication, MFA and resource-scope restrictions still apply.

Statistics 9
  • POST /v1/stats Get dashboard statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/entries Get entry statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/exits Get exit statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/transactions Get transaction statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/accesses Get access card usage statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/parking Get parking occupancy statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/devices Get device status statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/finance Get financial statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/stats/averages Get average duration statistics

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Alerts 3
  • POST /v1/alert Retrieve a single alert

    Required permissions

    • can_view_alerts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/alert/excel Download alerts as Excel

    Required permissions

    • can_view_alerts

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/alert/list List alerts

    Required permissions

    • can_view_alerts

    Authentication, MFA and resource-scope restrictions still apply.

Events 4
  • POST /v1/event Retrieve a single event

    Required permissions

    • can_view_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/event/list List events

    Required permissions

    • can_view_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/event/operations/list List operational events

    Required permissions

    • can_view_events

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/event/excel Download events as Excel

    Required permissions

    • can_view_events

    Authentication, MFA and resource-scope restrictions still apply.

Audit & History 5
  • POST /v1/audit/list List audit entries

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/audit/entity-types List audited entity types

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/history/list List entity history entries

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/history/entity List history for one entity

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/history/entity-types List audited entity types

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Incidents 5
  • POST /v1/incidents/query Query incidents

    Required permissions

    • can_view_incidents

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/incidents/{id}/workspace Retrieve an incident workspace tab

    Required permissions

    • can_view_incidents

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/incidents/{id}/evidence Upload incident evidence

    Required permissions

    • can_manage_incident_evidence

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/incidents/{id}/evidence/{param}/access Create incident evidence access grant

    Required permissions

    • can_manage_incident_evidence

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/incident/command Execute an incident command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Projects & Work Orders 18
  • POST /v1/work/projects/query Query projects

    Required permissions

    • can_view_projects

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/projects/{id}/workspace Retrieve one project workspace tab

    Required permissions

    • can_view_projects

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_project_time, can_view_work_orders, can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/tasks/query Query human project tasks

    Required permissions

    • can_view_projects

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/tasks/{id}/workspace Retrieve one project task workspace tab

    Required permissions

    • can_view_projects

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_project_time, can_view_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/my-work/query Retrieve work assigned to the signed-in user

    Required permissions

    • can_view_projects

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/time/query Query project time entries

    Required permissions

    • can_view_project_time

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/orders/query Query work orders

    Required permissions

    • can_view_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/orders/{id}/workspace Retrieve one work-order workspace

    Required permissions

    • can_view_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/billing/sources/query Query billable project-work sources for Sales

    Required permissions

    • can_view_project_financials

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/orders/{id}/documents Upload evidence to one work order

    Required permissions

    • can_manage_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/work/orders/{id}/documents Upload evidence to one work order (legacy multipart compatibility)

    Required permissions

    • can_manage_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/work/orders/{id}/documents/{param}/download Download evidence from one work order

    Required permissions

    • can_view_work_orders

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/work/project/command Execute idempotent project command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/work/task/command Execute idempotent project-task command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/work/time/command Execute idempotent time-entry command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/work/order/command Execute idempotent work-order command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/work/team/command Execute idempotent snow-operation team command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/work/billing/command Execute append-only project billing command

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Automated Tasks 11
  • POST /v1/tasks Retrieve a task

    Required permissions

    • can_view_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/tasks Create a task

    Required permissions

    • can_add_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/tasks Update a task

    Required permissions

    • can_edit_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/tasks Delete a task

    Required permissions

    • can_delete_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/list List tasks

    Required permissions

    • can_view_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/filters Get task filter options

    Required permissions

    • can_view_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/simulate Simulate a task

    Required permissions

    • can_run_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/run Run a task immediately

    Required permissions

    • can_run_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/runs List task runs

    Required permissions

    • can_view_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/runs/details Get task run details

    Required permissions

    • can_view_tasks

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tasks/runs/reverse Reverse a task run

    Required permissions

    • can_run_tasks

    Authentication, MFA and resource-scope restrictions still apply.

Schedules 6
  • POST /v1/schedules Retrieve a schedule

    Required permissions

    • can_view_schedules

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/schedules Create a schedule

    Required permissions

    • can_add_schedules

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/schedules Update a schedule

    Required permissions

    • can_edit_schedules

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/schedules Delete a schedule

    Required permissions

    • can_delete_schedules

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/schedules/list List schedules

    Required permissions

    • can_view_schedules

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/schedules/filters Get schedule filter options

    Required permissions

    • can_view_schedules

    Authentication, MFA and resource-scope restrictions still apply.

Holidays 6
  • POST /v1/holidays Retrieve a holiday

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PUT /v1/holidays Create a holiday

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • PATCH /v1/holidays Update a holiday

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • DELETE /v1/holidays Delete a holiday

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/holidays/list List holidays

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/holidays/filters Get holiday filter options

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Tags 6
  • POST /v1/tag Retrieve a tag

    Required permissions

    • can_view_tags

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/tag Create a tag

    Required permissions

    • can_add_tags

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/tag Update a tag

    Required permissions

    • can_edit_tags

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/tag Delete a tag

    Required permissions

    • can_delete_tags

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tag/list List tags

    Required permissions

    • can_view_tags

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/tag/filters Get tag filter options

    Required permissions

    • can_view_tags

    Authentication, MFA and resource-scope restrictions still apply.

Reports & Exports 14
  • GET /v1/report/generate Generate report (GET)

    Required permissions

    • can_export_reports

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/generate Generate report (POST)

    Required permissions

    • can_export_reports

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_view_guests

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/report/snow/catalog List bounded snow report definitions

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/snow/preview Preview a bounded snow report

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/snow/exports/create Queue a durable snow report export

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/snow/exports/query Query durable snow report exports

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/snow/exports/detail Read one durable snow report export

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/snow/exports/cancel Cancel a durable snow report export

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/report/snow/export/{id}/download Download a completed durable snow report export

    Required permissions

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/pdf/daily Generate daily PDF report

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/pdf/weekly Generate weekly PDF report

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/pdf/monthly Generate monthly PDF report

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/pdf/yearly Generate yearly PDF report

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/report/pdf/financial Generate financial PDF report

    Required permissions

    Depending on the action, filters or requested resource. These permissions are not all required for every request:

    • can_export_reports

    Authentication, MFA and resource-scope restrictions still apply.

Documents 5
  • POST /v1/document Retrieve a document metadata row

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/document/list List document metadata rows

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • PUT /v1/document/upload Upload a document to S3

    Required permissions

    • can_add_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • GET /v1/document/{id}/download Download a document from S3

    Required permissions

    • can_view_transactions

    Authentication, MFA and resource-scope restrictions still apply.

  • DELETE /v1/document Delete a document from S3 and soft-delete metadata

    Required permissions

    • can_delete_transactions

    Authentication, MFA and resource-scope restrictions still apply.

Email & SMS 4
  • POST /v1/sms/logs SMS Logs

    Required permissions

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/sms/summary SMS Summary

    Required permissions

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/email/queue Email Queue Status

    Required permissions

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/email/summary Email Queue Summary

    Required permissions

    • can_edit_users

    Authentication, MFA and resource-scope restrictions still apply.

Configuration 4
  • POST /v1/config Retrieve a configuration value

    Required permissions

    • can_view_settings or can_edit_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/config/list List configuration values

    Required permissions

    • can_view_settings or can_edit_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • PATCH /v1/config Save configuration values

    Required permissions

    • can_edit_settings

    Authentication, MFA and resource-scope restrictions still apply.

  • POST /v1/config/testmail Send test email

    Required permissions

    • can_edit_settings

    Authentication, MFA and resource-scope restrictions still apply.

Search 2
  • POST /v1/search Global search

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/search/reindex Reindex search data

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

EV Charging 4
  • POST /v1/chargingstation/list List charging station availabilities

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/chargingstation/start Start a charging session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/chargingstation/stop Stop a charging session

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

  • POST /v1/chargingstation/status Get charging session status

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

QR Codes 1
  • GET /v1/qrcode Generate QR code image

    Required permissions

    The exact permissions for this operation are not yet confirmed in this reference. Confirm the role requirements with Lexoh; this does not mean access is public. Authentication, MFA and resource/company-scope restrictions still apply. Additional rules may depend on your installed version.

Health & Version 4
  • GET / Server root health check

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • GET /health/live Kubernetes liveness probe

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • GET /health/ready Kubernetes readiness probe

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

  • GET /v1 API version check

    Required permissions

    No additional role permission for this operation. The stated authentication requirements still apply.

Call Lexoh 1-888-401-8019