> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a supplier contract > Get an existing supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the supplier contract. ## OpenAPI ````json GET /api/v1/contracts/supplier { "openapi": "3.0.4", "info": { "title": "Concept SalesContracts V1", "description": "Welcome to BETA version of the new Sales Concept Contracts API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "CommercialRentContracts" }, { "name": "Concept CommercialRent" }, { "name": "Concept PrivateRent" }, { "name": "GeneralSalesContracts" }, { "name": "Metadata" }, { "name": "PrivateRentContracts" }, { "name": "SupplierContracts" } ], "paths": { "/api/v1/contracts/supplier": { "get": { "tags": [ "SupplierContracts" ], "summary": "Get a supplier contract", "description": "Get an existing supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the supplier contract.", "operationId": "GetSupplierContract", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model). When given 'relationReference' should also be given", "schema": { "type": "string" } }, { "name": "relationReference", "in": "query", "description": "The internal identifier of the contract's relation. Required when 'reference' is given.", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "The external API identifier of the model.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierContract" } } } }, "404": { "description": "The requested supplier contract was not found." } }, "x-d360-narrative-url": "

Get a supplier contract

This endpoint retrieves an existing, finalised supplier contract from Bloxs, for example a contract for the regular servicing of heating and ventilation systems in rental properties.

A developer calls this endpoint to read the key terms of a specific finalised supplier contract into a third party system.

Request Fields

Field

Type

Required

Description

reference

string

No

The reference of the contract as generated by Bloxs. Either reference or externalIdentifier must be given. When reference is given, relationReference must also be given. Passed as a query parameter.

relationReference

string

No

The reference of the supplier the contract belongs to. Required when reference is given. Maximum length 100 characters. Passed as a query parameter.

externalIdentifier

string

No

The identifier of the contract within the system of the requesting party. This identifier is not generated by Bloxs. Either reference or externalIdentifier must be given. Passed as a query parameter.

Response Fields

Field

Type

Required

Description

reference

string

No

The reference of the contract as generated by Bloxs. Maximum length 100 characters.

externalIdentifier

string

No

The identifier of the contract within the system of the requesting party. Maximum length 100 characters.

ownerReference

string

No

The reference of the owner of the real estate object covered by the contract, as generated by Bloxs. Maximum length 100 characters.

relationReference

string

No

The reference of the supplier the contract belongs to. This is the same relation reference used across persons, organisations, suppliers, estate agents, financiers and owners in Bloxs. Maximum length 100 characters.

startDate

string (date-time)

Yes

Start date of the contract. ISO 8601 format.

endDate

string (date-time)

No

End date of the contract, or the date the contract automatically renews on. May be left empty if the contract has no fixed end date. ISO 8601 format.

automaticExtends

boolean

Yes

Whether the contract automatically renews at its end date. Default value false.

noticeDate

string (date-time)

No

The latest date on which the contract can be cancelled before automatic renewal takes effect. Only relevant when automaticExtends is true. Calculated by Bloxs from noticePeriod and endDate, and left empty if endDate is empty. ISO 8601 format.

noticePeriod

integer (int32)

No

Notice period of the contract in months. Relevant when automaticExtends is true.

" } } }, "components": { "schemas": { "SupplierContract": { "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "ownerReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "relationReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "automaticExtends": { "type": "boolean" }, "noticeDate": { "type": "string", "format": "date-time", "nullable": true }, "noticePeriod": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } } } } ````