> ## 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 contract lines of a supplier contracts > Get all contract lines used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the contract lines of the supplier contract. ## OpenAPI ````json GET /api/v1/contracts/supplier/lines { "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/lines": { "get": { "tags": [ "SupplierContracts" ], "summary": "Get contract lines of a supplier contracts", "description": "Get all contract lines used in the requested supplier contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the contract lines of the supplier contract.", "operationId": "GetSupplierContractRealEstateObjects", "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": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseContractLine" } } } } } }, "x-d360-narrative-url": "

Get contract lines of a supplier contracts

This endpoint retrieves all contract lines used in a finalised supplier contract.

A contract line represents an individual invoiced term of the agreement, for example a recurring service cost, linked to the real estate object it applies to.

A developer calls this endpoint to read the full cost build-up of a finalised supplier contract, for example to reconcile invoicing terms in 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

purchaseContractReference

string

No

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

purchaseContractExternalIdentifier

string

No

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

contractLineItemName

string

No

The name of the contract line item. Maximum length 256 characters.

realEstateObjectReference

string

No

The reference of the real estate object linked to the contract line, as generated by Bloxs. Maximum length 100 characters.

startDate

string (date)

Yes

Start date of the contract line. ISO 8601 date format.

endDate

string (date)

No

End date of the contract line. May be left empty if there is no fixed end date. ISO 8601 date format.

isStarted

boolean

Yes

Whether the contract line's start date has passed.

isEnded

boolean

Yes

Whether the contract line's end date has passed.

description

string

No

Free-text description of the contract line, printed on the invoice. Maximum length 512 characters.

taxRateCode

string

No

The code of the VAT rate applied to the contract line. Maximum length 100 characters.

amountExcl

number (double)

No

Amount of the contract line, excluding VAT. Decimals use a period as separator.

amountVAT

number (double)

No

VAT amount of the contract line. Decimals use a period as separator.

amountIncl

number (double)

No

Amount of the contract line, including VAT. Decimals use a period as separator.

amountPercentage

number (double)

No

Percentage used to calculate the contract line's amount, where the line is based on a percentage rather than a fixed amount.

" } } }, "components": { "schemas": { "PurchaseContractLine": { "type": "object", "properties": { "purchaseContractReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "purchaseContractExternalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "contractLineItemName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date", "nullable": true }, "isStarted": { "type": "boolean" }, "isEnded": { "type": "boolean" }, "description": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "taxRateCode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "amountExcl": { "type": "number", "format": "double", "nullable": true }, "amountVAT": { "type": "number", "format": "double", "nullable": true }, "amountIncl": { "type": "number", "format": "double", "nullable": true }, "amountPercentage": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false } } } } ````