A **Contract** is an agreement with a **Contractor** to deliver work, tracking the committed amount and reserve. In CapEx a contract belongs to a **Measure**; it accumulates **Invoices** and **Change Orders** and can carry **Documents** and a **Custom Field**. Contracts can be created and updated through the API.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/alasco-contract-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
description: '
## Introduction
The **CAPEX API** enables you to integrate your application with the CAPEX system. The CAPEX API is REST-based and follows JSON:API principles for structuring responses.
Starting from version 1.0, the API is stable. We are continuously improving our API, and new endpoints will be added. Any updates or changes within this major version will be backward-compatible and can be found in this documentation.
For getting access to the CAPEX API, please reach out to us at: `kontakt@alasco.de`.
The base URL for all endpoints is:
`https://api.alasco.de/capex/v1`
The CAPEX API supports compressed payloads. If you would like to make use of this, you have to specify the `Accept-Encoding` header. Supported encodings are `gzip` and `br`.
### Domain model
Objects relate as follows (each `→` is a navigable sub-resource):
- **Assets** and **Measures** are the CapEx-specific top-level objects; a **Measure** → **Contracts**, and invoices are submitted against an **Asset**.
- **Contractor** and **Contracting Entity** → **Contracts**.
- **Contract** → **Change Orders**, **Invoices**, contract terms, **Documents** and **Custom Fields**.
- **Invoice** → **Documents** and **Tags** (Change Orders also carry **Documents**).
### CAPEX API Overview
The CAPEX API provides endpoints to:
- Retrieve and manage invoices, invoice tags, and invoice documents
- Retrieve assets, contracts, contractors, and measures
The CAPEX API uses pagination. The page size is 100, and additional pages can be accessed using a `next` link.
'
title: CAPEX Annual Consumption Contract API
version: '1.0'
x-logo:
url: https://assets-global.website-files.com/656ef2eb27ad41897248f866/659eebec190ae7aaf4162f09_Logotype_Alasco_white_RGB%202.png
servers:
- url: https://api.alasco.de/capex/v1
tags:
- description: A **Contract** is an agreement with a **Contractor** to deliver work, tracking the committed amount and reserve. In CapEx a contract belongs to a **Measure**; it accumulates **Invoices** and **Change Orders** and can carry **Documents** and a **Custom Field**. Contracts can be created and updated through the API.
name: Contract
paths:
/contracting_entities/{contracting_entity_id}/contracts/:
get:
operationId: get_contracts_by_contracting_entity_contracting_entities__contracting_entity_id__contracts__get
parameters:
- in: path
name: contracting_entity_id
required: true
schema:
format: uuid
title: Contracting Entity Id
type: string
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contracts By Contracting Entity
tags:
- Contract
/contractors/{contractor_id}/contracts/:
get:
operationId: get_contracts_by_contractor_contractors__contractor_id__contracts__get
parameters:
- in: path
name: contractor_id
required: true
schema:
format: uuid
title: Contractor Id
type: string
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contracts By Contractor
tags:
- Contract
/contracts/:
get:
operationId: get_contracts_contracts__get
parameters:
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
You can filter on certain attributes by specifying them as a GET parameter along
with an operation, e.g. `filter[name.exact]=abc`.
Currently supported operations are:
* `exact`: Expects one value
* `contains`: Expects one value
* `less_than_equal`: Expects one value
* `greater_than_equal`: Expects one value
* `range`: Expects two values
* `in`: Expects one or multiple values
* `not_in`: Expects one or multiple values
* `is`: Expects one value
The following attributes support filtering:
| **Attribute** | `exact` | `contains` | `less_than_equal` | `greater_than_equal` | `range` | `in` | `not_in` | `is` |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| `id` | | | | | | x | x | |
| `name` | x | x | | | | | | |
| `contract_number` | x | x | | | | | | |
| `cost_center` | x | x | | | | | | |
| `status` | | | | | | x | x | |
| `contracting_entity` | | | | | | x | x | |
| `contractor` | | | | | | x | x | |
| `project` | | | | | | x | x | |
| `date_created` | | | x | x | x | | | |
| `date_contract` | | | x | x | x | | | x |
| `contract_type` | | | | | | x | x | |
| `is_reverse_charge` | | | | | | | | x |
| `measure (CapEx only)` | | | | | | x | x | |
| `contract_unit (FinCon only)` | | | | | | x | x | |
| `custom_fields.<uuid> (Operation depends on custom field type)` | x | x | x | x | x | x | x | x |
'
in: query
name: filter[attribute.operation]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can filter on certain attributes by specifying them as a GET parameter along
with an operation, e.g. `filter[name.exact]=abc`.
Currently supported operations are:
* `exact`: Expects one value
* `contains`: Expects one value
* `less_than_equal`: Expects one value
* `greater_than_equal`: Expects one value
* `range`: Expects two values
* `in`: Expects one or multiple values
* `not_in`: Expects one or multiple values
* `is`: Expects one value
The following attributes support filtering:
| **Attribute** | `exact` | `contains` | `less_than_equal` | `greater_than_equal` | `range` | `in` | `not_in` | `is` |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| `id` | | | | | | x | x | |
| `name` | x | x | | | | | | |
| `contract_number` | x | x | | | | | | |
| `cost_center` | x | x | | | | | | |
| `status` | | | | | | x | x | |
| `contracting_entity` | | | | | | x | x | |
| `contractor` | | | | | | x | x | |
| `project` | | | | | | x | x | |
| `date_created` | | | x | x | x | | | |
| `date_contract` | | | x | x | x | | | x |
| `contract_type` | | | | | | x | x | |
| `is_reverse_charge` | | | | | | | | x |
| `measure (CapEx only)` | | | | | | x | x | |
| `contract_unit (FinCon only)` | | | | | | x | x | |
| `custom_fields.<uuid> (Operation depends on custom field type)` | x | x | x | x | x | x | x | x |
'
title: Filter[Attribute.Operation]
- description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contracts
tags:
- Contract
post:
operationId: create_contract_contracts__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContractRequestCapex'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractDetailsResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Create Contract
tags:
- Contract
/contracts/{contract_id}/contract_terms/:
get:
operationId: get_contract_terms_contracts__contract_id__contract_terms__get
parameters:
- in: path
name: contract_id
required: true
schema:
format: uuid
title: Contract Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractTermsResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contract Terms
tags:
- Contract
/contracts/{id}/:
get:
operationId: get_contract_details_contracts__id___get
parameters:
- in: path
name: id
required: true
schema:
format: uuid
title: Id
type: string
- description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractDetailsResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contract Details
tags:
- Contract
patch:
operationId: update_contract_contracts__id___patch
parameters:
- in: path
name: id
required: true
schema:
format: uuid
title: Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateContractRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractDetailsResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Update Contract
tags:
- Contract
/measures/{id}/contracts/:
get:
operationId: get_contracts_by_measure_measures__id__contracts__get
parameters:
- in: path
name: id
required: true
schema:
format: uuid
title: Id
type: string
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
Contains links to related objects.
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
Contains links to related objects.
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListResponseCapex'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Get Contracts By Measure
tags:
- Contract
/contract_units/{contract_unit_id}/contracts/:
get:
operationId: get_contracts_by_contract_unit_contract_units__contract_unit_id__contracts__get
parameters:
- in: path
name: contract_unit_id
required: true
schema:
format: uuid
title: Contract Unit Id
type: string
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
in: query
name: include
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can get related objects by specifying them separated by comma as a GET `include` parameters.
In case of non-direct relation include parameter should be a relationship path - a dot-separated list of
relationship names.
Currently available objects are:
* contractor
* contracting_entity
* contract_unit
* contract_unit.project
* contract_unit.project.property
e.g. `include=contractor,contracting_entity,contract_unit,contract_unit.project,contract_unit.project.property`
'
title: Include
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListResponseFincon'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
API Token: []
summary: Get Contracts By Contract Unit
tags:
- Contract
components:
schemas:
BaseDataSchema:
properties:
attributes:
anyOf:
- {}
- type: 'null'
title: Attributes
id:
format: uuid
title: Id
type: string
relationships:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Relationships
type:
title: Type
type: string
required:
- id
- type
title: BaseDataSchema
type: object
GeneralTermsAttributes:
properties:
cash_discount_percentage:
description: '**Cash discount percentage** · **Skontosatz**'
title: Cash Discount Percentage
type: number
cash_discount_period_final:
anyOf:
- type: integer
- type: 'null'
description: '**Cash discount period (final)** · **Skontofrist (Schlussrechnung)**'
title: Cash Discount Period Final
cash_discount_period_installment:
anyOf:
- type: integer
- type: 'null'
description: '**Cash discount period (installment)** · **Skontofrist (Abschlagsrechnung)**'
title: Cash Discount Period Installment
cash_discount_period_partial_final:
anyOf:
- type: integer
- type: 'null'
description: '**Cash discount period (partial final)** · **Skontofrist (Teilschlussrechnung)**'
title: Cash Discount Period Partial Final
cash_discount_period_single:
anyOf:
- type: integer
- type: 'null'
description: '**Cash discount period (single invoice)** · **Skontofrist (Einzelrechnung)**'
title: Cash Discount Period Single
cash_discount_period_unit_final:
description: '**Cash discount period unit (final)** · **Skontofrist-Einheit (Schlussrechnung)**'
title: Cash Discount Period Unit Final
type: string
cash_discount_period_unit_installment:
description: '**Cash discount period unit (installment)** · **Skontofrist-Einheit (Abschlagsrechnung)**'
title: Cash Discount Period Unit Installment
type: string
cash_discount_period_unit_partial_final:
description: '**Cash discount period unit (partial final)** · **Skontofrist-Einheit (Teilschlussrechnung)**'
title: Cash Discount Period Unit Partial Final
type: string
cash_discount_period_unit_single:
description: '**Cash discount period unit (single invoice)** · **Skontofrist-Einheit (Einzelrechnung)**'
title: Cash Discount Period Unit Single
type: string
cash_discount_reference:
description: '**Cash discount reference** · **Skontoreferenz**'
title: Cash Discount Reference
type: string
cash_discount_reference_choices:
description: '**Cash discount reference choices** · **Auswahl Skontoreferenz**'
items:
type: string
title: Cash Discount Reference Choices
type: array
deduction_percentage:
description: '**Deduction percentage** · **Abzugssatz**'
title: Deduction Percentage
type: number
deduction_reference:
description: '**Deduction reference** · **Abzugsreferenz**'
title: Deduction Reference
type: string
deduction_reference_choices:
description: '**Deduction reference choices** · **Auswahl Abzugsreferenz**'
items:
type: string
title: Deduction Reference Choices
type: array
payment_period_final:
anyOf:
- type: integer
- type: 'null'
description: '**Payment period (final)** · **Zahlungsfrist (Schlussrechnung)**'
title: Payment Period Final
payment_period_installment:
anyOf:
- type: integer
- type: 'null'
description: '**Payment period (installment)** · **Zahlungsfrist (Abschlagsrechnung)**'
title: Payment Period Installment
payment_period_partial_final:
anyOf:
- type: integer
- type: 'null'
description: '**Payment period (partial final)** · **Zahlungsfrist (Teilschlussrechnung)**'
title: Payment Period Partial Final
payment_period_single:
anyOf:
- type: integer
- type: 'null'
description: '**Payment period (single invoice)** · **Zahlungsfrist (Einzelrechnung)**'
title: Payment Period Single
payment_period_unit_final:
description: '**Payment period unit (final)** · **Zahlungsfrist-Einheit (Schlussrechnung)**'
title: Payment Period Unit Final
type: string
payment_period_unit_installment:
description: '**Payment period unit (installment)** · **Zahlungsfrist-Einheit (Abschlagsrechnung)**'
title: Payment Period Unit Installment
type: string
payment_period_unit_partial_final:
description: '**Payment period unit (partial final)** · **Zahlungsfrist-Einheit (Teilschlussrechnung)**'
title: Payment Period Unit Partial Final
type: string
payment_period_unit_single:
description: '**Payment period unit (single invoice)** · **Zahlungsfrist-Einheit (Einzelrechnung)**'
title: Payment Period Unit Single
type: string
required:
- deduction_reference_choices
- cash_discount_reference_choices
- cash_discount_percentage
- deduction_percentage
- deduction_reference
- cash_discount_reference
- cash_discount_period_unit_single
- cash_discount_period_unit_installment
- cash_discount_period_unit_partial_final
- cash_discount_period_unit_final
- payment_period_unit_single
- payment_period_unit_installment
- payment_period_unit_partial_final
- payment_period_unit_final
- cash_discount_period_single
- payment_period_single
- payment_period_installment
- cash_discount_period_installment
- cash_discount_period_partial_final
- cash_discount_period_final
- payment_period_partial_final
- payment_period_final
title: GeneralTermsAttributes
type: object
ContractDetailsResponseCapex:
properties:
data:
anyOf:
- $ref: '#/components/schemas/ContractDataCapex'
- type: 'null'
errors:
anyOf:
- ite
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alasco/refs/heads/main/openapi/alasco-contract-api-openapi.yml