> ## 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 general sales contract
> Get an existing general sales contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the general sales contract.
## OpenAPI
````json GET /api/v1/contracts/general
{
"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/general": {
"get": {
"tags": [
"GeneralSalesContracts"
],
"summary": "Get a general sales contract",
"description": "Get an existing general sales contract. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the general sales contract.",
"operationId": "GetGeneralSalesContract",
"parameters": [
{
"name": "reference",
"in": "query",
"description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).",
"schema": {
"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/GeneralSalesContract"
}
}
}
},
"404": {
"description": "The requested general sales contract was not found."
}
},
"x-d360-narrative-url": "Get a general sales contract
This endpoint retrieves an existing, finalized general sales contract.
A general sales contract covers \"other contracts\" that are not lease contracts, for example an agreement covering maintenance, where Bloxs' user is the invoicing party.
Integrators call this endpoint to display a full overview of a specific finalized contract in a third-party application.
The contract can be identified by its internal reference, its external identifier, or both.
Request Fields
Field | Type | Required | Description |
|---|
reference | string | Conditional | Internal identifier of the contract, generated by Bloxs. Either reference or externalIdentifier must be provided. If both are given, the contract must match both values. Maximum length 100 characters. |
externalIdentifier | string | Conditional | External identifier of the contract, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the contract must match both values. Maximum length 100 characters. |
Response Fields
Field | Type | Required | Description |
|---|
reference | string | No | Internal identifier of the contract, generated by Bloxs. Maximum length 100 characters. |
externalIdentifier | string | No | External identifier of the contract, as set by the integrating system. Maximum length 100 characters. |
ownerReference | string | No | Reference of the owner of the object subject to the contract. Must be a reference assigned by Bloxs. Maximum length 100 characters. |
relationReference | string | No | Reference of the primary tenant who is financially responsible for the contract. Must be a reference assigned by Bloxs. Maximum length 100 characters. |
extraRelationReferences | string | No | Reference of a co-tenant on the contract. Must be a reference assigned by Bloxs. On this endpoint the field returns a single value, not a list. 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. Can be left empty. Also used as the date the contract is automatically renewed, when applicable. ISO 8601 format. |
automaticExtends | boolean | Yes | Indicates whether the contract renews automatically. Default value is false. |
noticeDate | string (date-time) | No | Latest date the contract can be cancelled before an automatic extension takes effect. Only relevant when automaticExtends is true. Calculated automatically by Bloxs from noticePeriod and endDate; left empty if endDate is empty. ISO 8601 format. |
noticePeriod | integer | No | Notice period of the contract, in months. Relevant when automaticExtends is true. |
lastModified | string (date-time) | Yes | Timestamp of the last modification to the contract in Bloxs. ISO 8601 format, UTC. |