Contract Endpoints

Contracts

---

Contract

Supplier-side contracts. Use /SupplierContract to manage contracts with vendors and suppliers.

---

GET /SupplierContract

Summary: List of Contract

Description: Returns multiple Contract records. Requires authentication.

Query Parameters:

Name	Type	Description
count	integer	Number of contracts to return in the response.
includeinactive	boolean	Include inactive contracts in the response.
order	string	Field name to order by (primary).
order2	string	Field name to order by (secondary).
order3	string	Field name to order by (tertiary).
order4	string	Field name to order by (quaternary).
order5	string	Field name to order by (fifth).
orderdesc	boolean	Order descending on primary order field.
orderdesc2	boolean	Order descending on secondary order field.
orderdesc3	boolean	Order descending on tertiary order field.
orderdesc4	boolean	Order descending on quaternary order field.
orderdesc5	boolean	Order descending on fifth order field.
page_no	integer	Page number when using pagination.
page_size	integer	Page size when using pagination.
pageinate	boolean	Whether to use pagination in the response.
search	string	Filter results based on a search string.
supplier_id	integer	Filter by the specified supplier.

Response: 200 OK — Returns Contract_View schema.

---

POST /SupplierContract

Summary: Create Contract(s)

Request Body: Array of Contract objects.

Response: 201 Created — Returns Contract schema.

---

GET /SupplierContract/{id}

Summary: Get one Contract

Description: Returns a single Contract instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract ID.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.

Response: 200 OK — Returns Contract schema.

---

DELETE /SupplierContract/{id}

Summary: Delete Contract

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract ID.

Response: 200 OK

---

POST /SupplierContract/NextRef

Summary: Get Next Contract Reference

Request Body: Array of Contract objects.

Response: 200 OK

---

ContractHeader

Client-side contracts. Use /ClientContract to manage billing contracts assigned to clients.

---

GET /ClientContract

Summary: List of ContractHeader

Description: Returns multiple ContractHeader records. Requires authentication.

Query Parameters:

Name	Type	Description
client_id	integer	Filter by client ID.
count	integer	Number of records to return.
device_id	integer	Filter by device/asset ID.
excluderenewed	boolean	Exclude renewed contracts.
includeinactive	boolean	Include inactive contracts.
includelastrenewed	boolean	Include the last renewed contract.
isbillingplansetup	boolean	Filter by whether billing plan is set up.
isoracle	boolean	Filter Oracle-linked contracts.
order	string	Primary order field.
order2	string	Secondary order field.
order3	string	Tertiary order field.
order4	string	Quaternary order field.
order5	string	Fifth order field.
orderdesc	boolean	Descending on primary order.
orderdesc2	boolean	Descending on secondary order.
orderdesc3	boolean	Descending on tertiary order.
orderdesc4	boolean	Descending on quaternary order.
orderdesc5	boolean	Descending on fifth order.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
pending_recurring_invoice	boolean	Filter contracts with pending recurring invoices.
search	string	Filter by search string.
site_id	integer	Filter by site ID.
contract_type	integer	Return only contracts of the specified Contract Type.
contract_sub_type	integer	Return only contracts of the specified Contract Sub-Type.
labour_type	integer	Filter by labour type: 0 = Fixed, 1 = Pre-Pay.

Response: 200 OK — Returns ContractHeader_View schema.

---

POST /ClientContract

Summary: Create ContractHeader(s)

Request Body: Array of ContractHeader objects.

Response: 201 Created — Returns ContractHeader schema.

---

GET /ClientContract/{id}

Summary: Get one ContractHeader

Description: Returns a single ContractHeader instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract header ID.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra detail objects in the response.
includeperiods	boolean	Include contract periods in the response.

Response: 200 OK — Returns ContractHeader schema.

---

DELETE /ClientContract/{id}

Summary: Delete ContractHeader

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract header ID.

Response: 200 OK

---

POST /ClientContract/NextRef

Summary: Get Next ContractHeader Reference

Request Body: Array of ContractHeader objects.

Response: 200 OK

---

POST /ClientContract/Approval

Summary: Submit Contract Approval

Request Body: Array of ContractApproval objects.

Response: 200 OK

---

ContractRule

Automated contract assignment rules.

---

GET /ContractRule

Summary: List Contract Rules

Response: 200 OK

---

POST /ContractRule

Summary: Create Contract Rule(s)

Request Body: Array of ContractRule objects.

Response: 200 OK

---

GET /ContractRule/{id}

Summary: Get one ContractRule

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract rule ID.

Response: 200 OK

---

DELETE /ContractRule/{id}

Summary: Delete ContractRule

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract rule ID.

Response: 200 OK

---

ContractSchedule

Scheduled payment/billing entries attached to a client contract.

---

GET /ContractSchedule

Summary: List Contract Schedules

Response: 200 OK

---

POST /ContractSchedule

Summary: Create Contract Schedule(s)

Request Body: Array of ContractSchedule objects.

Response: 200 OK

---

GET /ContractSchedule/{id}

Summary: Get one ContractSchedule

Description: Returns a single ContractSchedule instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract schedule ID.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.

Response: 200 OK

---

DELETE /ContractSchedule/{id}

Summary: Delete ContractSchedule

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract schedule ID.

Response: 200 OK

---

ContractSchedulePlan

Planned contract schedule entries (upcoming visits/appointments linked to contracts).

---

GET /ContractSchedulePlan

Summary: List Contract Schedule Plans

Response: 200 OK

---

POST /ContractSchedulePlan

Summary: Create Contract Schedule Plan(s)

Request Body: Array of ContractSchedulePlan objects.

Response: 200 OK

---

GET /ContractSchedulePlan/{id}

Summary: Get one ContractSchedulePlan

Description: Returns a single ContractSchedulePlan instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract schedule plan ID.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.

Response: 200 OK

---

DELETE /ContractSchedulePlan/{id}

Summary: Delete ContractSchedulePlan

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Contract schedule plan ID.

Response: 200 OK

---

ContractTemplateHeader

Billing templates used as the basis for creating client contracts.

---

GET /BillingTemplate

Summary: List Billing Templates

Response: 200 OK

---

POST /BillingTemplate

Summary: Create Billing Template(s)

Request Body: Array of ContractTemplateHeader objects.

Response: 200 OK

---

GET /BillingTemplate/{id}

Summary: Get one ContractTemplateHeader

Description: Returns a single ContractTemplateHeader instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Billing template ID.

Query Parameters:

Name	Type	Description
client_id	integer	Client context for the template lookup.
includedetails	boolean	Include extra objects in the response.

Response: 200 OK

---

DELETE /BillingTemplate/{id}

Summary: Delete Billing Template

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	Billing template ID.

Response: 200 OK

---

PrepayHistory

Pre-pay balance history records for clients under pre-pay contracts.

---

GET /ClientPrepay

Summary: List of PrepayHistory

Description: Returns multiple PrepayHistory records. Requires authentication.

Query Parameters:

Name	Type	Description
advanced_search	string	Advanced search expression.
billing_date	string	Filter by billing date.
client_id	integer	Filter by client ID.
client_ids	string	Comma-separated list of client IDs to filter by.
contract_id	integer	Filter by contract ID.
count	integer	Number of records to return.
idonly	boolean	Return IDs only.
order	string	Primary order field.
order2	string	Secondary order field.
order3	string	Tertiary order field.
order4	string	Quaternary order field.
order5	string	Fifth order field.
orderdesc	boolean	Descending on primary order.
orderdesc2	boolean	Descending on secondary order.
orderdesc3	boolean	Descending on tertiary order.
orderdesc4	boolean	Descending on quaternary order.
orderdesc5	boolean	Descending on fifth order.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
ready_for_invoicing	boolean	Filter records ready for invoicing.
search	string	Filter by search string.

Response: 200 OK

---

POST /ClientPrepay

Summary: Create PrepayHistory record(s)

Request Body: Array of PrepayHistory objects.

Response: 200 OK

---

GET /ClientPrepay/{id}

Summary: Get one PrepayHistory

Description: Returns a single PrepayHistory instance. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	PrepayHistory record ID.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.

Response: 200 OK

---

DELETE /ClientPrepay/{id}

Summary: Delete PrepayHistory record

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	PrepayHistory record ID.

Response: 200 OK

---