> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-pro/models.md).

# Models

## The Address object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The AddressCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AddressCreateModel":{"required":["city","countryCode"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address."},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country."},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true}},"additionalProperties":false}}}}
```

## The AddressPatchModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AddressPatchModel":{"required":["city","countryCode"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address."},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country."},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true}},"additionalProperties":false}}}}
```

## The AttributeDefinition object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeDefinition":{"required":["self"],"type":"object","properties":{"description":{"type":"string","description":"A further description of the attribute","nullable":true},"knownValues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueReference"},"description":"Values that already have been defined for this definition.\nYou can add new values to the definition any time.","nullable":true},"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The AttributeDefinitionCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeDefinitionCreate":{"required":["name"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueCreate"},"description":"Create expected values for the attribute definition. You can add further values later at any time.","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the attribute."},"description":{"maxLength":500,"minLength":0,"type":"string","description":"A further description of the attribute.","nullable":true}},"additionalProperties":false},"AttributeValueCreate":{"required":["displayValue"],"type":"object","properties":{"displayValue":{"maxLength":50,"minLength":0,"type":"string","description":"The value for the attribute to be displayed."}},"additionalProperties":false}}}}
```

## The AttributeDefinitionList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeDefinitionList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDefinition"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"AttributeDefinition":{"required":["self"],"type":"object","properties":{"description":{"type":"string","description":"A further description of the attribute","nullable":true},"knownValues":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueReference"},"description":"Values that already have been defined for this definition.\nYou can add new values to the definition any time.","nullable":true},"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The AttributeDefinitionReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeDefinitionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The AttributeValueCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeValueCreate":{"required":["displayValue"],"type":"object","properties":{"displayValue":{"maxLength":50,"minLength":0,"type":"string","description":"The value for the attribute to be displayed."}},"additionalProperties":false}}}}
```

## The AttributeValueReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The AuthorizationRequest object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequest":{"required":["id","self"],"type":"object","properties":{"requestingCompany":{"$ref":"#/components/schemas/CompanyReference"},"approvingCompany":{"$ref":"#/components/schemas/CompanyReference"},"creator":{"$ref":"#/components/schemas/EmployeeReference"},"processor":{"$ref":"#/components/schemas/EmployeeReference"},"type":{"$ref":"#/components/schemas/AuthorizationRequestType"},"status":{"$ref":"#/components/schemas/AuthorizationRequestStatus"},"created":{"type":"string","description":"The date and time the authorization request was created.","format":"date-time"},"completed":{"type":"string","description":"The date and time the authorization request was completed.","format":"date-time","nullable":true},"note":{"type":"string","description":"A note on the authorization request. Supports html formatted text including inline css styles.","nullable":true},"id":{"type":"integer","description":"The identifier of the authorization request.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CompanyReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the company in the system.","format":"int64"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AuthorizationRequestType":{"enum":["orderAuthorization"],"type":"string"},"AuthorizationRequestStatus":{"enum":["new","inprocess","approved","denied"],"type":"string"}}}}
```

## The AuthorizationRequestCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequestCreate":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/AuthorizationRequestType"},"note":{"maxLength":10000,"minLength":0,"type":"string","description":"A note on the authorization request. Supports html formatted text including inline css styles.","nullable":true}},"additionalProperties":false},"AuthorizationRequestType":{"enum":["orderAuthorization"],"type":"string"}}}}
```

## The AuthorizationRequestList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequestList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizationRequest"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"AuthorizationRequest":{"required":["id","self"],"type":"object","properties":{"requestingCompany":{"$ref":"#/components/schemas/CompanyReference"},"approvingCompany":{"$ref":"#/components/schemas/CompanyReference"},"creator":{"$ref":"#/components/schemas/EmployeeReference"},"processor":{"$ref":"#/components/schemas/EmployeeReference"},"type":{"$ref":"#/components/schemas/AuthorizationRequestType"},"status":{"$ref":"#/components/schemas/AuthorizationRequestStatus"},"created":{"type":"string","description":"The date and time the authorization request was created.","format":"date-time"},"completed":{"type":"string","description":"The date and time the authorization request was completed.","format":"date-time","nullable":true},"note":{"type":"string","description":"A note on the authorization request. Supports html formatted text including inline css styles.","nullable":true},"id":{"type":"integer","description":"The identifier of the authorization request.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CompanyReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the company in the system.","format":"int64"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"AuthorizationRequestType":{"enum":["orderAuthorization"],"type":"string"},"AuthorizationRequestStatus":{"enum":["new","inprocess","approved","denied"],"type":"string"}}}}
```

## The AuthorizationRequestSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequestSortParameter":{"enum":["creationDate"],"type":"string"}}}}
```

## The AuthorizationRequestStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequestStatus":{"enum":["new","inprocess","approved","denied"],"type":"string"}}}}
```

## The AuthorizationRequestType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"AuthorizationRequestType":{"enum":["orderAuthorization"],"type":"string"}}}}
```

## The BillingCycle object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BillingCycle":{"enum":["none","daily","weekly","biweekly","monthly","annually","triennial"],"type":"string"}}}}
```

## The BomDefinition object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinition":{"required":["id","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the BOM definition.","format":"int64"},"type":{"$ref":"#/components/schemas/BomDefinitionType"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BomDefinitionItem"},"description":"The products which are items in this BOM definition.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"BomDefinitionType":{"enum":["base","combination","additive"],"type":"string"},"BomDefinitionItem":{"required":["id","product","quantity","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the BOM definition item.","format":"int64"},"product":{"$ref":"#/components/schemas/ProductReference"},"quantity":{"type":"integer","description":"The quantity of this product in the BOM definition.","format":"int32","default":1},"subscriptionPeriodCondition":{"type":"integer","description":"If set, this item only applies to orders of an offer with the matching subscription period.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The BomDefinitionCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinitionCreate":{"required":["serviceId"],"type":"object","properties":{"serviceId":{"type":"integer","description":"The identifier of the sales service this BOM definition belongs to.","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BomDefinitionItemCreate"},"description":"The products which are items in the BOM definition.","nullable":true}},"additionalProperties":false},"BomDefinitionItemCreate":{"required":["productId","quantity"],"type":"object","properties":{"productId":{"type":"integer","description":"The identifier of the sourcing product to add as a BOM item.","format":"int64"},"quantity":{"maximum":20,"minimum":1,"type":"integer","description":"The quantity of this product in the BOM definition.","format":"int32","default":1},"subscriptionPeriodCondition":{"maximum":2147483647,"minimum":0,"type":"integer","description":"If set, this item only applies to orders of an offer with the matching subscription period.","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The BomDefinitionItem object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinitionItem":{"required":["id","product","quantity","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the BOM definition item.","format":"int64"},"product":{"$ref":"#/components/schemas/ProductReference"},"quantity":{"type":"integer","description":"The quantity of this product in the BOM definition.","format":"int32","default":1},"subscriptionPeriodCondition":{"type":"integer","description":"If set, this item only applies to orders of an offer with the matching subscription period.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The BomDefinitionItemCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinitionItemCreate":{"required":["productId","quantity"],"type":"object","properties":{"productId":{"type":"integer","description":"The identifier of the sourcing product to add as a BOM item.","format":"int64"},"quantity":{"maximum":20,"minimum":1,"type":"integer","description":"The quantity of this product in the BOM definition.","format":"int32","default":1},"subscriptionPeriodCondition":{"maximum":2147483647,"minimum":0,"type":"integer","description":"If set, this item only applies to orders of an offer with the matching subscription period.","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The BomDefinitionList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinitionList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BomDefinition"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"BomDefinition":{"required":["id","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the BOM definition.","format":"int64"},"type":{"$ref":"#/components/schemas/BomDefinitionType"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BomDefinitionItem"},"description":"The products which are items in this BOM definition.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"BomDefinitionType":{"enum":["base","combination","additive"],"type":"string"},"BomDefinitionItem":{"required":["id","product","quantity","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the BOM definition item.","format":"int64"},"product":{"$ref":"#/components/schemas/ProductReference"},"quantity":{"type":"integer","description":"The quantity of this product in the BOM definition.","format":"int32","default":1},"subscriptionPeriodCondition":{"type":"integer","description":"If set, this item only applies to orders of an offer with the matching subscription period.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The BomDefinitionType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomDefinitionType":{"enum":["base","combination","additive"],"type":"string"}}}}
```

## The BomItem object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomItem":{"required":["quantity"],"type":"object","properties":{"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Quantity of the product in the bill of materials","format":"int32","default":1},"product":{"$ref":"#/components/schemas/ProductReference"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The BomItemCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"BomItemCreateModel":{"required":["productId","quantity"],"type":"object","properties":{"productId":{"type":"integer","description":"The id of the product for which an item in the bill of materials should be created.","format":"int64"},"quantity":{"maximum":20,"minimum":1,"type":"integer","description":"Quantity of the product in the bill of materials","format":"int32","default":1},"subscriptionPeriodCondition":{"maximum":2147483647,"minimum":0,"type":"integer","description":"If set to any value but null, this bom item will only be applied on orders of an offer with the matching subscription period.","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The CompanyReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CompanyReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the company in the system.","format":"int64"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The Context object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Context":{"enum":["customer","supplier","impersonated"],"type":"string"}}}}
```

## The ContextName object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."}}}}
```

## The CostCenter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CostCenter":{"required":["self"],"type":"object","properties":{"description":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"code":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The Currency object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"}}}}
```

## The Customer object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Customer":{"required":["id","name","self"],"type":"object","properties":{"uuid":{"type":"string","description":"The identifier of the customer.","format":"uuid"},"description":{"type":"string","description":"The description of the customer.","nullable":true},"active":{"type":"boolean","description":"True if the customer is active, false otherwise."},"contactName":{"type":"string","description":"The name of the contact person at the customer.","nullable":true},"contactEmail":{"type":"string","description":"The email address of the contact person at the customer.","nullable":true},"contactPhone":{"type":"string","description":"The phone number of the contact person at the customer.","nullable":true},"customAttribute1":{"type":"string","description":"Value of the first custom attribute as defined in the settings","nullable":true},"customAttribute2":{"type":"string","description":"Value of the second custom attribute as defined in the settings","nullable":true},"customAttribute3":{"type":"string","description":"Value of the third custom attribute as defined in the settings","nullable":true},"accountManager":{"$ref":"#/components/schemas/EmployeeReference"},"language":{"$ref":"#/components/schemas/Language"},"companyAddress":{"$ref":"#/components/schemas/Address"},"referredBy":{"$ref":"#/components/schemas/CustomerReferral"},"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Language":{"enum":["en","de","fr","it","pl","nb","nl","es"],"type":"string","description":"Language options for a customer or user interaction"},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"CustomerReferral":{"type":"object","properties":{"referredOn":{"type":"string","description":"Date on which the customer relationship was established","format":"date-time"},"company":{"$ref":"#/components/schemas/CustomerReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"}},"additionalProperties":false,"description":"Contains references to the entities who referred the customer to your organization.\nFor managed customers the employee reference contains the user who created the customer entry.\nFor partner customers the company reference contains the partner which referred this customer."},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The CustomerCreateModel object

````json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerCreateModel":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the customer."},"customerNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"description":{"maxLength":500,"minLength":0,"type":"string","description":"The description of the customer.","nullable":true},"active":{"type":"boolean","description":"True if the customer is active and is allowed to place orders, false otherwise."},"customAttribute1":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the first custom attribute as defined in the settings","nullable":true},"customAttribute2":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the second custom attribute as defined in the settings","nullable":true},"customAttribute3":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the third custom attribute as defined in the settings","nullable":true},"contactName":{"maxLength":200,"minLength":0,"type":"string","description":"The name of the contact person at the customer.","nullable":true},"contactEmail":{"maxLength":100,"minLength":0,"type":"string","description":"The mail of the contact person at the customer.","nullable":true},"contactPhone":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the contact person at the customer.","nullable":true},"language":{"$ref":"#/components/schemas/Language"},"tenantPermissions":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/RoleAssignment"},"description":"Can be used to grant access for employees of your organization to the newly created customer.\n\nThis is intended for employees without automatic access privileges, as administrators inherently have access to all new customers.\nSo rather use this for your sales employees for example.\n\nYou can use the ```/organization/employees``` endpoint to retrieve the required employee IDs.\nNote: If you provide IDs that do not belong to your organization, the create operation will fail.\nThe role \"user\" is not allowed here.","nullable":true},"accountManager":{"type":"integer","description":"The id of the responsible sales person for the customer.\nThis employee receives planner access to the customer, when not specified otherwise through the tenant permissions.","format":"int32","nullable":true},"companyAddress":{"$ref":"#/components/schemas/AddressCreateModel"},"billingAddress":{"$ref":"#/components/schemas/AddressCreateModel"}},"additionalProperties":false},"Language":{"enum":["en","de","fr","it","pl","nb","nl","es"],"type":"string","description":"Language options for a customer or user interaction"},"RoleAssignment":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"type":"integer","description":"The employee ID to assign the role to.","format":"int32"},"role":{"$ref":"#/components/schemas/UserRole"}},"additionalProperties":false,"description":"Assignment of a role to an employee for a customer."},"UserRole":{"enum":["administrator","planner","user"],"type":"string","description":"Roles available to be assigned to an employee as a user in Equipme. Options will be extended in the future."},"AddressCreateModel":{"required":["city","countryCode"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address."},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country."},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true}},"additionalProperties":false}}}}
````

## The CustomerList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Customer"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Customer":{"required":["id","name","self"],"type":"object","properties":{"uuid":{"type":"string","description":"The identifier of the customer.","format":"uuid"},"description":{"type":"string","description":"The description of the customer.","nullable":true},"active":{"type":"boolean","description":"True if the customer is active, false otherwise."},"contactName":{"type":"string","description":"The name of the contact person at the customer.","nullable":true},"contactEmail":{"type":"string","description":"The email address of the contact person at the customer.","nullable":true},"contactPhone":{"type":"string","description":"The phone number of the contact person at the customer.","nullable":true},"customAttribute1":{"type":"string","description":"Value of the first custom attribute as defined in the settings","nullable":true},"customAttribute2":{"type":"string","description":"Value of the second custom attribute as defined in the settings","nullable":true},"customAttribute3":{"type":"string","description":"Value of the third custom attribute as defined in the settings","nullable":true},"accountManager":{"$ref":"#/components/schemas/EmployeeReference"},"language":{"$ref":"#/components/schemas/Language"},"companyAddress":{"$ref":"#/components/schemas/Address"},"referredBy":{"$ref":"#/components/schemas/CustomerReferral"},"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Language":{"enum":["en","de","fr","it","pl","nb","nl","es"],"type":"string","description":"Language options for a customer or user interaction"},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"CustomerReferral":{"type":"object","properties":{"referredOn":{"type":"string","description":"Date on which the customer relationship was established","format":"date-time"},"company":{"$ref":"#/components/schemas/CustomerReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"}},"additionalProperties":false,"description":"Contains references to the entities who referred the customer to your organization.\nFor managed customers the employee reference contains the user who created the customer entry.\nFor partner customers the company reference contains the partner which referred this customer."},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The CustomerReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The CustomerReferral object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerReferral":{"type":"object","properties":{"referredOn":{"type":"string","description":"Date on which the customer relationship was established","format":"date-time"},"company":{"$ref":"#/components/schemas/CustomerReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"}},"additionalProperties":false,"description":"Contains references to the entities who referred the customer to your organization.\nFor managed customers the employee reference contains the user who created the customer entry.\nFor partner customers the company reference contains the partner which referred this customer."},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The CustomerSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerSortParameter":{"enum":["name"],"type":"string","description":"Parameters according to which a customer can be sorted."}}}}
```

## The CustomerUpdateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"CustomerUpdateModel":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the customer."},"customerNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"description":{"maxLength":500,"minLength":0,"type":"string","description":"The description of the customer.\nNote: Value null won't override the current value. You can provide an empty string to clear this field.","nullable":true},"active":{"type":"boolean","description":"True if the customer is active and is allowed to place orders, false otherwise."},"customAttribute1":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the first custom attribute as defined in the settings\nNote: Value null won't override the current value. You can provide an empty string to clear this field.","nullable":true},"customAttribute2":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the second custom attribute as defined in the settings\nNote: Value null won't override the current value. You can provide an empty string to clear this field.","nullable":true},"customAttribute3":{"maxLength":100,"minLength":0,"type":"string","description":"Value of the third custom attribute as defined in the settings\nNote: Value null won't override the current value. You can provide an empty string to clear this field.","nullable":true},"accountManagerId":{"type":"integer","description":"Id of the responsible sales person for the customer.\nOn update, this employee receives planner access to the customer.","format":"int32","nullable":true},"contactName":{"maxLength":200,"minLength":0,"type":"string","description":"The name of the contact person at the customer.","nullable":true},"contactEmail":{"maxLength":100,"minLength":0,"type":"string","description":"The email address of the contact person at the customer.","nullable":true},"contactPhone":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the contact person at the customer.","nullable":true}},"additionalProperties":false}}}}
```

## The Employee object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Employee":{"required":["id","self","username"],"type":"object","properties":{"employer":{"$ref":"#/components/schemas/CompanyReference"},"workplace":{"$ref":"#/components/schemas/LocationReference"},"supervisor":{"$ref":"#/components/schemas/EmployeeReference"},"employeeNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Employee number in the company. Usually created by the HR system/process.","nullable":true},"position":{"maxLength":150,"minLength":0,"type":"string","description":"The job position or job title of the employee","nullable":true},"privateEmail":{"maxLength":100,"minLength":0,"type":"string","description":"The private email address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"notes":{"maxLength":1000,"minLength":0,"type":"string","description":"Free text notes.","nullable":true},"created":{"type":"string","description":"The date and time the data record was created.","format":"date-time"},"onboardingDate":{"type":"string","description":"The employee onboarding date.","format":"date-time","nullable":true},"offboardingDate":{"type":"string","description":"The employee offboarding date.","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/EmployeeStatus"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"description":"The groups the employee belongs to (departments, teams etc.)","nullable":true},"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CompanyReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the company in the system.","format":"int64"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeStatus":{"enum":["onboarding","active","leave","offboarding","inactive"],"type":"string","description":"Status of an employee"},"Group":{"required":["id","name","self"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"category":{"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"type":"string","description":"The description of the group.","nullable":true},"email":{"type":"string","description":"The email address of the group.","nullable":true},"manager":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeReference"},"description":"A list of employee references assigned as managers for a group.","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"Assigned tags","nullable":true},"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."}}}}
```

## The EmployeeCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeCreateModel":{"required":["email","firstName","lastName","locationId","username"],"type":"object","properties":{"employeeNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Employee number in the company. Usually created by the HR system/process.","nullable":true},"onboardingDate":{"type":"string","description":"The employee onboarding date.","format":"date-time","nullable":true},"offboardingDate":{"type":"string","description":"The employee offboarding date.","format":"date-time","nullable":true},"invitation":{"$ref":"#/components/schemas/InvitationModel"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRole"},"description":"Specifies the roles assigned to the employee for logging in to Equipme. Default is \"user\".","nullable":true},"email":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The contact mail address."},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee."},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee."},"locationId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier of the location where the employee works.","format":"int32"},"notes":{"maxLength":1000,"minLength":0,"type":"string","description":"Free text notes.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"phonePrimary":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"position":{"maxLength":150,"minLength":0,"type":"string","description":"The job position or job title of the employee","nullable":true},"status":{"$ref":"#/components/schemas/EmployeeStatus"},"supervisorId":{"type":"integer","description":"The identifier of an employee who is the supervisor for this employee.","format":"int32","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"selfServiceEnabled":{"type":"boolean","description":"Controls whether the employee can access the self-service portal."}},"additionalProperties":false},"InvitationModel":{"type":"object","properties":{"loginMethod":{"$ref":"#/components/schemas/LoginMethod"},"message":{"maxLength":1000,"minLength":0,"type":"string","description":"Additional message which will displayed in the invitation mail below the regular information. Can be used to give the employee further information.","nullable":true}},"additionalProperties":false,"description":"Configures the invitation to be sent to the employee."},"LoginMethod":{"enum":["password","sso"],"type":"string"},"UserRole":{"enum":["administrator","planner","user"],"type":"string","description":"Roles available to be assigned to an employee as a user in Equipme. Options will be extended in the future."},"EmployeeStatus":{"enum":["onboarding","active","leave","offboarding","inactive"],"type":"string","description":"Status of an employee"}}}}
```

## The EmployeeFulfillmentReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeFulfillmentReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The EmployeeList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Employee"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Employee":{"required":["id","self","username"],"type":"object","properties":{"employer":{"$ref":"#/components/schemas/CompanyReference"},"workplace":{"$ref":"#/components/schemas/LocationReference"},"supervisor":{"$ref":"#/components/schemas/EmployeeReference"},"employeeNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Employee number in the company. Usually created by the HR system/process.","nullable":true},"position":{"maxLength":150,"minLength":0,"type":"string","description":"The job position or job title of the employee","nullable":true},"privateEmail":{"maxLength":100,"minLength":0,"type":"string","description":"The private email address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"notes":{"maxLength":1000,"minLength":0,"type":"string","description":"Free text notes.","nullable":true},"created":{"type":"string","description":"The date and time the data record was created.","format":"date-time"},"onboardingDate":{"type":"string","description":"The employee onboarding date.","format":"date-time","nullable":true},"offboardingDate":{"type":"string","description":"The employee offboarding date.","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/EmployeeStatus"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"description":"The groups the employee belongs to (departments, teams etc.)","nullable":true},"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CompanyReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the company in the system.","format":"int64"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeStatus":{"enum":["onboarding","active","leave","offboarding","inactive"],"type":"string","description":"Status of an employee"},"Group":{"required":["id","name","self"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"category":{"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"type":"string","description":"The description of the group.","nullable":true},"email":{"type":"string","description":"The email address of the group.","nullable":true},"manager":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeReference"},"description":"A list of employee references assigned as managers for a group.","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"Assigned tags","nullable":true},"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."}}}}
```

## The EmployeeReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The EmployeeSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeSortParameter":{"enum":["mail","firstName","lastName","workplace"],"type":"string","description":"Parameters according to which an employee can be sorted."}}}}
```

## The EmployeeStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeStatus":{"enum":["onboarding","active","leave","offboarding","inactive"],"type":"string","description":"Status of an employee"}}}}
```

## The EmployeeUpdateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"EmployeeUpdateModel":{"required":["email","firstName","lastName","locationId","username"],"type":"object","properties":{"email":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The contact mail address."},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee."},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee."},"locationId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier of the location where the employee works.","format":"int32"},"notes":{"maxLength":1000,"minLength":0,"type":"string","description":"Free text notes.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"phonePrimary":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"position":{"maxLength":150,"minLength":0,"type":"string","description":"The job position or job title of the employee","nullable":true},"status":{"$ref":"#/components/schemas/EmployeeStatus"},"supervisorId":{"type":"integer","description":"The identifier of an employee who is the supervisor for this employee.","format":"int32","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"selfServiceEnabled":{"type":"boolean","description":"Controls whether the employee can access the self-service portal."}},"additionalProperties":false},"EmployeeStatus":{"enum":["onboarding","active","leave","offboarding","inactive"],"type":"string","description":"Status of an employee"}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}}}
```

## The FulfillmentAction object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentAction":{"enum":["process","dispatchDelivery","rejectDelivery","confirmDelivery","processReturnedItem","complete","completeReturnDecommission","cancel"],"type":"string","description":"The action to take on the fulfillment order."}}}}
```

## The FulfillmentAssignment object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentAssignment":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/LocationReference"},"employee":{"$ref":"#/components/schemas/EmployeeFulfillmentReference"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"EmployeeFulfillmentReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The FulfillmentOrder object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentOrder":{"required":["customer","id","offer","order","orderedBy","self","service","status","transactionType"],"type":"object","properties":{"transactionType":{"$ref":"#/components/schemas/FulfillmentOrderTransactionType"},"status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillmentType":{"$ref":"#/components/schemas/FulfillmentType"},"isPreorder":{"type":"boolean","description":"Indicates whether this order is a preorder. Preorders should only be prepared until ready for delivery and then wait to be requested by the customer before shipment."},"partnerNote":{"type":"string","description":"A note shared with the intermediary partner. (Only for orders placed by partner customers)","nullable":true},"offer":{"$ref":"#/components/schemas/ServiceOfferReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentServiceOption"},"description":"Reference to the ordered product option versions.","nullable":true},"order":{"$ref":"#/components/schemas/SalesOrderReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"orderedBy":{"$ref":"#/components/schemas/EmployeeFulfillmentReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"preferredProvisionDate":{"type":"string","description":"The preferred provision date.","format":"date-time","nullable":true},"serviceInstance":{"$ref":"#/components/schemas/ServiceInstanceReference"},"targetServiceInstance":{"$ref":"#/components/schemas/TargetServiceInstanceReference"},"assignments":{"$ref":"#/components/schemas/FulfillmentAssignment"},"bomItems":{"type":"array","items":{"$ref":"#/components/schemas/BomItem"},"description":"Items in the bom which are required to fulfill the order.","nullable":true},"totalRecurringPrice":{"type":"number","description":"Sum of the recurring prices of the service offer and the ordered options in this item.","format":"double"},"totalPurchasePrice":{"type":"number","description":"Sum of the purchase prices of the service offer and the ordered options in this item.","format":"double"},"id":{"type":"integer","description":"The identifier of the order.","format":"int64"},"externalId":{"type":"string","description":"The identifier of the order in an external app.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"FulfillmentOrderTransactionType":{"enum":["order","return","change","swap","cancellation"],"type":"string","description":"The action triggered by a fulfillment order."},"FulfillmentStatus":{"enum":["new","inprocess","ready-for-delivery","delivery-requested-outbound","in-delivery-outbound","delivered-outbound","delivery-returned-outbound","processed","cancelled"],"type":"string","description":"Status of the fulfillment process."},"FulfillmentType":{"enum":["in-house","dropshipping"],"type":"string","description":"Types of fulfillment to complete a customer order."},"ServiceOfferReference":{"required":["currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","type"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"FulfillmentServiceOption":{"required":["offer","option","version"],"type":"object","properties":{"offer":{"$ref":"#/components/schemas/SalesVersionOfferReference"},"option":{"$ref":"#/components/schemas/ProductOptionReference"},"version":{"$ref":"#/components/schemas/ProductOptionVersionReference"}},"additionalProperties":false},"SalesVersionOfferReference":{"required":["id","purchasePrice","recurringPrice","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int64"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOptionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the option","format":"int32"},"name":{"type":"string","description":"Display name of the option","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOptionVersionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the version","format":"int32"},"name":{"type":"string","description":"Display name of the version","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SalesOrderReference":{"required":["created","id","orderNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the order is also the order number.","format":"int64"},"customerOrderNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Order reference number from the customer","nullable":true},"orderNumber":{"minLength":1,"type":"string","description":"Unique reference number of the sales order."},"created":{"type":"string","description":"The date and time when the order was placed. (ISO 8601 format)","format":"date-time"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeFulfillmentReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"TargetServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"},"FulfillmentAssignment":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/LocationReference"},"employee":{"$ref":"#/components/schemas/EmployeeFulfillmentReference"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"BomItem":{"required":["quantity"],"type":"object","properties":{"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Quantity of the product in the bill of materials","format":"int32","default":1},"product":{"$ref":"#/components/schemas/ProductReference"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The FulfillmentOrderList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentOrderList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentOrder"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"FulfillmentOrder":{"required":["customer","id","offer","order","orderedBy","self","service","status","transactionType"],"type":"object","properties":{"transactionType":{"$ref":"#/components/schemas/FulfillmentOrderTransactionType"},"status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillmentType":{"$ref":"#/components/schemas/FulfillmentType"},"isPreorder":{"type":"boolean","description":"Indicates whether this order is a preorder. Preorders should only be prepared until ready for delivery and then wait to be requested by the customer before shipment."},"partnerNote":{"type":"string","description":"A note shared with the intermediary partner. (Only for orders placed by partner customers)","nullable":true},"offer":{"$ref":"#/components/schemas/ServiceOfferReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"options":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentServiceOption"},"description":"Reference to the ordered product option versions.","nullable":true},"order":{"$ref":"#/components/schemas/SalesOrderReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"orderedBy":{"$ref":"#/components/schemas/EmployeeFulfillmentReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"preferredProvisionDate":{"type":"string","description":"The preferred provision date.","format":"date-time","nullable":true},"serviceInstance":{"$ref":"#/components/schemas/ServiceInstanceReference"},"targetServiceInstance":{"$ref":"#/components/schemas/TargetServiceInstanceReference"},"assignments":{"$ref":"#/components/schemas/FulfillmentAssignment"},"bomItems":{"type":"array","items":{"$ref":"#/components/schemas/BomItem"},"description":"Items in the bom which are required to fulfill the order.","nullable":true},"totalRecurringPrice":{"type":"number","description":"Sum of the recurring prices of the service offer and the ordered options in this item.","format":"double"},"totalPurchasePrice":{"type":"number","description":"Sum of the purchase prices of the service offer and the ordered options in this item.","format":"double"},"id":{"type":"integer","description":"The identifier of the order.","format":"int64"},"externalId":{"type":"string","description":"The identifier of the order in an external app.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"FulfillmentOrderTransactionType":{"enum":["order","return","change","swap","cancellation"],"type":"string","description":"The action triggered by a fulfillment order."},"FulfillmentStatus":{"enum":["new","inprocess","ready-for-delivery","delivery-requested-outbound","in-delivery-outbound","delivered-outbound","delivery-returned-outbound","processed","cancelled"],"type":"string","description":"Status of the fulfillment process."},"FulfillmentType":{"enum":["in-house","dropshipping"],"type":"string","description":"Types of fulfillment to complete a customer order."},"ServiceOfferReference":{"required":["currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","type"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"FulfillmentServiceOption":{"required":["offer","option","version"],"type":"object","properties":{"offer":{"$ref":"#/components/schemas/SalesVersionOfferReference"},"option":{"$ref":"#/components/schemas/ProductOptionReference"},"version":{"$ref":"#/components/schemas/ProductOptionVersionReference"}},"additionalProperties":false},"SalesVersionOfferReference":{"required":["id","purchasePrice","recurringPrice","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int64"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOptionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the option","format":"int32"},"name":{"type":"string","description":"Display name of the option","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOptionVersionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the version","format":"int32"},"name":{"type":"string","description":"Display name of the version","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SalesOrderReference":{"required":["created","id","orderNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the order is also the order number.","format":"int64"},"customerOrderNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Order reference number from the customer","nullable":true},"orderNumber":{"minLength":1,"type":"string","description":"Unique reference number of the sales order."},"created":{"type":"string","description":"The date and time when the order was placed. (ISO 8601 format)","format":"date-time"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeFulfillmentReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"phoneBusiness":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees workplace.","nullable":true},"phoneMobile":{"maxLength":50,"minLength":0,"type":"string","description":"The phone number of the employees business mobile phone.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"TargetServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"},"FulfillmentAssignment":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/LocationReference"},"employee":{"$ref":"#/components/schemas/EmployeeFulfillmentReference"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"BomItem":{"required":["quantity"],"type":"object","properties":{"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Quantity of the product in the bill of materials","format":"int32","default":1},"product":{"$ref":"#/components/schemas/ProductReference"}},"additionalProperties":false},"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The FulfillmentOrderTransactionType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentOrderTransactionType":{"enum":["order","return","change","swap","cancellation"],"type":"string","description":"The action triggered by a fulfillment order."}}}}
```

## The FulfillmentOrderUpdate object

````json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentOrderUpdate":{"type":"object","properties":{"externalId":{"maxLength":100,"minLength":0,"type":"string","description":"The identifier of the order in an external app. Note: ```null``` value will be ignored on update. Set to empty string to clear a current value.","nullable":true}},"additionalProperties":false}}}}
````

## The FulfillmentServiceOption object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentServiceOption":{"required":["offer","option","version"],"type":"object","properties":{"offer":{"$ref":"#/components/schemas/SalesVersionOfferReference"},"option":{"$ref":"#/components/schemas/ProductOptionReference"},"version":{"$ref":"#/components/schemas/ProductOptionVersionReference"}},"additionalProperties":false},"SalesVersionOfferReference":{"required":["id","purchasePrice","recurringPrice","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int64"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ProductOptionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the option","format":"int32"},"name":{"type":"string","description":"Display name of the option","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOptionVersionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the version","format":"int32"},"name":{"type":"string","description":"Display name of the version","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The FulfillmentStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentStatus":{"enum":["new","inprocess","ready-for-delivery","delivery-requested-outbound","in-delivery-outbound","delivered-outbound","delivery-returned-outbound","processed","cancelled"],"type":"string","description":"Status of the fulfillment process."}}}}
```

## The FulfillmentTransition object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentTransition":{"required":["action"],"type":"object","properties":{"action":{"$ref":"#/components/schemas/FulfillmentAction"},"activationDate":{"type":"string","description":"The (UTC) date on which the service should be activated (time component is ignored). Only applicable for the `complete` action.\nIf not provided, the service is activated immediately upon completion.","format":"date-time","nullable":true}},"additionalProperties":false},"FulfillmentAction":{"enum":["process","dispatchDelivery","rejectDelivery","confirmDelivery","processReturnedItem","complete","completeReturnDecommission","cancel"],"type":"string","description":"The action to take on the fulfillment order."}}}}
```

## The FulfillmentType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"FulfillmentType":{"enum":["in-house","dropshipping"],"type":"string","description":"Types of fulfillment to complete a customer order."}}}}
```

## The Group object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Group":{"required":["id","name","self"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"category":{"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"type":"string","description":"The description of the group.","nullable":true},"email":{"type":"string","description":"The email address of the group.","nullable":true},"manager":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeReference"},"description":"A list of employee references assigned as managers for a group.","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"Assigned tags","nullable":true},"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The GroupCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupCreate":{"required":["name","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the group."},"category":{"maxLength":50,"minLength":0,"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"maxLength":500,"minLength":0,"type":"string","description":"The description of the group.","nullable":true},"email":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The email of the group.","nullable":true}},"additionalProperties":false},"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."}}}}
```

## The GroupList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Group":{"required":["id","name","self"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"category":{"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"type":"string","description":"The description of the group.","nullable":true},"email":{"type":"string","description":"The email address of the group.","nullable":true},"manager":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeReference"},"description":"A list of employee references assigned as managers for a group.","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"Assigned tags","nullable":true},"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The GroupMemberReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupMemberReference":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the group member.","format":"int32"}},"additionalProperties":false}}}}
```

## The GroupReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The GroupServiceInstanceReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupServiceInstanceReference":{"required":["id"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The id of the service instance.","format":"int32"}},"additionalProperties":false}}}}
```

## The GroupSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupSortParameter":{"enum":["name"],"type":"string","description":"Parameters according to which groups can be sorted."}}}}
```

## The GroupType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupType":{"enum":["custom","company","department","project","team"],"type":"string","description":"Type of the group."}}}}
```

## The GroupUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"GroupUpdate":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the group."},"category":{"maxLength":50,"minLength":0,"type":"string","description":"A customizable category of the group. Can be used to categorize groups independent from the group type.","nullable":true},"companyName":{"maxLength":100,"minLength":0,"type":"string","description":"A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.","nullable":true},"description":{"maxLength":500,"minLength":0,"type":"string","description":"The description of the group.","nullable":true},"email":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The email of the group.","nullable":true}},"additionalProperties":false}}}}
```

## The InvitationModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"InvitationModel":{"type":"object","properties":{"loginMethod":{"$ref":"#/components/schemas/LoginMethod"},"message":{"maxLength":1000,"minLength":0,"type":"string","description":"Additional message which will displayed in the invitation mail below the regular information. Can be used to give the employee further information.","nullable":true}},"additionalProperties":false,"description":"Configures the invitation to be sent to the employee."},"LoginMethod":{"enum":["password","sso"],"type":"string"}}}}
```

## The Invoice object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Invoice":{"required":["created","id","self"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"primarySupplier":{"$ref":"#/components/schemas/SupplierReference"},"created":{"type":"string","description":"The timestamp of the creation of the invoice.","format":"date-time"},"dueDate":{"type":"string","description":"The due date of the invoice.","format":"date-time","nullable":true},"invoiceDate":{"type":"string","description":"The date on which the invoice was issued.","format":"date-time"},"invoiceId":{"type":"string","description":"The invoice id given by the supplier.","nullable":true},"vatId":{"type":"string","description":"The Vat ID of the recipient.","nullable":true},"transactionId":{"type":"string","description":"The transaction id of the payment.","nullable":true},"chargedTo":{"type":"string","description":"The cost center for the invoice.","nullable":true},"total":{"type":"number","description":"The total cost of the invoice.","format":"double"},"totalRecurring":{"type":"number","description":"The total recurring cost of the invoice.","format":"double"},"totalOneTime":{"type":"number","description":"The total one time cost of the invoice.","format":"double"},"currencyCode":{"type":"string","description":"TMP currency code of the invoice. This will always be the default currency of the customer.","nullable":true},"items":{"$ref":"#/components/schemas/ResourceListReference"},"id":{"type":"integer","description":"The id of the invoice.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceListReference":{"required":["self","total"],"type":"object","properties":{"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The InvoiceList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"InvoiceList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Invoice":{"required":["created","id","self"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"primarySupplier":{"$ref":"#/components/schemas/SupplierReference"},"created":{"type":"string","description":"The timestamp of the creation of the invoice.","format":"date-time"},"dueDate":{"type":"string","description":"The due date of the invoice.","format":"date-time","nullable":true},"invoiceDate":{"type":"string","description":"The date on which the invoice was issued.","format":"date-time"},"invoiceId":{"type":"string","description":"The invoice id given by the supplier.","nullable":true},"vatId":{"type":"string","description":"The Vat ID of the recipient.","nullable":true},"transactionId":{"type":"string","description":"The transaction id of the payment.","nullable":true},"chargedTo":{"type":"string","description":"The cost center for the invoice.","nullable":true},"total":{"type":"number","description":"The total cost of the invoice.","format":"double"},"totalRecurring":{"type":"number","description":"The total recurring cost of the invoice.","format":"double"},"totalOneTime":{"type":"number","description":"The total one time cost of the invoice.","format":"double"},"currencyCode":{"type":"string","description":"TMP currency code of the invoice. This will always be the default currency of the customer.","nullable":true},"items":{"$ref":"#/components/schemas/ResourceListReference"},"id":{"type":"integer","description":"The id of the invoice.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceListReference":{"required":["self","total"],"type":"object","properties":{"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The InvoiceReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"InvoiceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id of the invoice.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The Item object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Item":{"required":["costs","cycle","id","resource","self","startDate","status","type"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"location":{"$ref":"#/components/schemas/LocationReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"},"group":{"$ref":"#/components/schemas/GroupReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"resource":{"$ref":"#/components/schemas/ServiceInstanceReference"},"invoice":{"$ref":"#/components/schemas/InvoiceReference"},"type":{"$ref":"#/components/schemas/ItemType"},"cycle":{"$ref":"#/components/schemas/BillingCycle"},"status":{"$ref":"#/components/schemas/ItemStatus"},"description":{"type":"string","description":"The technical charge description.","nullable":true},"startDate":{"type":"string","description":"The start date for the charge.","format":"date-time"},"endDate":{"type":"string","description":"The end date for the charge.","format":"date-time"},"costs":{"type":"number","description":"Costs that are billed for the resource.","format":"double"},"currencyCode":{"type":"string","description":"Gets or sets the ISO 4217 currency code associated with the transaction.","nullable":true},"id":{"type":"integer","description":"The id of the billing item.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"ServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"InvoiceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id of the invoice.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ItemType":{"enum":["fee","tax","refund","discount","credit"],"type":"string"},"BillingCycle":{"enum":["none","daily","weekly","biweekly","monthly","annually","triennial"],"type":"string"},"ItemStatus":{"enum":["draft","pending","unbilled","invoiced","paid","overdue","canceled","refunded"],"type":"string"}}}}
```

## The ItemList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ItemList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Item":{"required":["costs","cycle","id","resource","self","startDate","status","type"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"location":{"$ref":"#/components/schemas/LocationReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"},"group":{"$ref":"#/components/schemas/GroupReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"resource":{"$ref":"#/components/schemas/ServiceInstanceReference"},"invoice":{"$ref":"#/components/schemas/InvoiceReference"},"type":{"$ref":"#/components/schemas/ItemType"},"cycle":{"$ref":"#/components/schemas/BillingCycle"},"status":{"$ref":"#/components/schemas/ItemStatus"},"description":{"type":"string","description":"The technical charge description.","nullable":true},"startDate":{"type":"string","description":"The start date for the charge.","format":"date-time"},"endDate":{"type":"string","description":"The end date for the charge.","format":"date-time"},"costs":{"type":"number","description":"Costs that are billed for the resource.","format":"double"},"currencyCode":{"type":"string","description":"Gets or sets the ISO 4217 currency code associated with the transaction.","nullable":true},"id":{"type":"integer","description":"The id of the billing item.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"GroupReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"ServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"InvoiceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id of the invoice.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ItemType":{"enum":["fee","tax","refund","discount","credit"],"type":"string"},"BillingCycle":{"enum":["none","daily","weekly","biweekly","monthly","annually","triennial"],"type":"string"},"ItemStatus":{"enum":["draft","pending","unbilled","invoiced","paid","overdue","canceled","refunded"],"type":"string"}}}}
```

## The ItemStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ItemStatus":{"enum":["draft","pending","unbilled","invoiced","paid","overdue","canceled","refunded"],"type":"string"}}}}
```

## The ItemType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ItemType":{"enum":["fee","tax","refund","discount","credit"],"type":"string"}}}}
```

## The Language object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Language":{"enum":["en","de","fr","it","pl","nb","nl","es"],"type":"string","description":"Language options for a customer or user interaction"}}}}
```

## The Location object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Location":{"required":["id","name","self","type"],"type":"object","properties":{"created":{"type":"string","description":"The date and time the data record was created.","format":"date-time"},"address":{"$ref":"#/components/schemas/Address"},"managers":{"type":"array","items":{"$ref":"#/components/schemas/LocationManger"},"description":"Current location managers.","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Additional Metadata attributes for the location.","nullable":true},"costCenter":{"$ref":"#/components/schemas/CostCenter"},"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"LocationManger":{"required":["id","self","username"],"type":"object","properties":{"managerPolicy":{"type":"string","nullable":true},"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataItem":{"required":["key","self"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"Metadata value","nullable":true},"scope":{"type":"string","description":"Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.","nullable":true},"key":{"maxLength":150,"minLength":0,"type":"string","description":"Metadata key used as a unique identifier for the metadata item."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CostCenter":{"required":["self"],"type":"object","properties":{"description":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"code":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."}}}}
```

## The LocationCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationCreateModel":{"required":["address","name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the location."},"address":{"$ref":"#/components/schemas/AddressCreateModel"},"managers":{"type":"array","items":{"$ref":"#/components/schemas/LocationManagerCreateModel"},"description":"The location managers.","nullable":true},"costCenterId":{"type":"integer","description":"Location cost center","format":"int32","nullable":true}},"additionalProperties":false},"AddressCreateModel":{"required":["city","countryCode"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address."},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country."},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true}},"additionalProperties":false},"LocationManagerCreateModel":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier of the user who is the manager of the location.","format":"int32"},"role":{"minLength":1,"type":"string","description":"The role of the manager at the location. Can be either 'location-manager' or 'location-executive'."}},"additionalProperties":false}}}}
```

## The LocationList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Location"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Location":{"required":["id","name","self","type"],"type":"object","properties":{"created":{"type":"string","description":"The date and time the data record was created.","format":"date-time"},"address":{"$ref":"#/components/schemas/Address"},"managers":{"type":"array","items":{"$ref":"#/components/schemas/LocationManger"},"description":"Current location managers.","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Additional Metadata attributes for the location.","nullable":true},"costCenter":{"$ref":"#/components/schemas/CostCenter"},"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"LocationManger":{"required":["id","self","username"],"type":"object","properties":{"managerPolicy":{"type":"string","nullable":true},"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataItem":{"required":["key","self"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"Metadata value","nullable":true},"scope":{"type":"string","description":"Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.","nullable":true},"key":{"maxLength":150,"minLength":0,"type":"string","description":"Metadata key used as a unique identifier for the metadata item."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CostCenter":{"required":["self"],"type":"object","properties":{"description":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"code":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."}}}}
```

## The LocationManagerCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationManagerCreateModel":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The identifier of the user who is the manager of the location.","format":"int32"},"role":{"minLength":1,"type":"string","description":"The role of the manager at the location. Can be either 'location-manager' or 'location-executive'."}},"additionalProperties":false}}}}
```

## The LocationManagerPatchModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationManagerPatchModel":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"type":"integer","description":"The identifier of the user who is the manager of the location.","format":"int32"},"role":{"minLength":1,"type":"string","description":"The role of the manager at the location. Can be either 'location-manager' or 'location-executive'."}},"additionalProperties":false}}}}
```

## The LocationManger object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationManger":{"required":["id","self","username"],"type":"object","properties":{"managerPolicy":{"type":"string","nullable":true},"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The LocationPatch object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationPatch":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the location."},"address":{"$ref":"#/components/schemas/AddressPatchModel"},"managers":{"type":"array","items":{"$ref":"#/components/schemas/LocationManagerPatchModel"},"description":"The location managers.","nullable":true},"addressId":{"type":"integer","format":"int32","nullable":true},"costCenterId":{"type":"integer","description":"Location Cost Center","format":"int32","nullable":true}},"additionalProperties":false},"AddressPatchModel":{"required":["city","countryCode"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address."},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country."},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true}},"additionalProperties":false},"LocationManagerPatchModel":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"type":"integer","description":"The identifier of the user who is the manager of the location.","format":"int32"},"role":{"minLength":1,"type":"string","description":"The role of the manager at the location. Can be either 'location-manager' or 'location-executive'."}},"additionalProperties":false}}}}
```

## The LocationReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The LocationSearchParameters object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationSearchParameters":{"type":"object","properties":{"metadataScope":{"$ref":"#/components/schemas/MetadataScope"},"metaDataFilter":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Search for locations based by metadata key and value.","nullable":true}},"additionalProperties":false},"MetadataScope":{"enum":["Supplier","Customer","Shared"],"type":"string"},"MetadataItem":{"required":["key","self"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"Metadata value","nullable":true},"scope":{"type":"string","description":"Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.","nullable":true},"key":{"maxLength":150,"minLength":0,"type":"string","description":"Metadata key used as a unique identifier for the metadata item."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The LocationSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationSortParameter":{"enum":["name"],"type":"string","description":"Parameters according to which a location can be sorted."}}}}
```

## The LocationType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."}}}}
```

## The LoginMethod object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"LoginMethod":{"enum":["password","sso"],"type":"string"}}}}
```

## The Manufacturer object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Manufacturer":{"required":["id","name","self"],"type":"object","properties":{"note":{"maxLength":1023,"minLength":0,"type":"string","description":"A note for the manufacturer","nullable":true},"id":{"type":"integer","description":"The identifier of the manufacturer.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the manufacturer"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ManufacturerList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ManufacturerList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Manufacturer"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Manufacturer":{"required":["id","name","self"],"type":"object","properties":{"note":{"maxLength":1023,"minLength":0,"type":"string","description":"A note for the manufacturer","nullable":true},"id":{"type":"integer","description":"The identifier of the manufacturer.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the manufacturer"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ManufacturerSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ManufacturerSortParameter":{"enum":["name"],"type":"string"}}}}
```

## The MetadataEntry object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The MetadataItem object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataItem":{"required":["key","self"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"Metadata value","nullable":true},"scope":{"type":"string","description":"Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.","nullable":true},"key":{"maxLength":150,"minLength":0,"type":"string","description":"Metadata key used as a unique identifier for the metadata item."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The MetadataItemCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataItemCreateModel":{"type":"object","properties":{"key":{"maxLength":150,"type":"string","description":"Key for the new metadata entry","nullable":true},"value":{"maxLength":500,"type":"string","description":"Metadata value","nullable":true}},"additionalProperties":false,"description":"DTO for creating a new metadata entry for a given resource which implements the logic"}}}}
```

## The MetadataList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"MetadataItem":{"required":["key","self"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"Metadata value","nullable":true},"scope":{"type":"string","description":"Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.","nullable":true},"key":{"maxLength":150,"minLength":0,"type":"string","description":"Metadata key used as a unique identifier for the metadata item."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The MetadataScope object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataScope":{"enum":["Supplier","Customer","Shared"],"type":"string"}}}}
```

## The MetadataValue object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"MetadataValue":{"required":["value"],"type":"object","properties":{"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The OfferType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"}}}}
```

## The Operation object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Operation":{"type":"object","properties":{"value":{"nullable":true},"path":{"type":"string","nullable":true},"op":{"type":"string","nullable":true},"from":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The Parcel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Parcel":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the parcel.","format":"int32"},"createdBy":{"$ref":"#/components/schemas/UserReference"},"created":{"type":"string","description":"Date on which the parcel entry was created. (ISO 8601 format)","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"deliveryNoteNumber":{"type":"string","description":"Identification number of the delivery note in the parcel","nullable":true},"originAddress":{"$ref":"#/components/schemas/Address"},"recipientName":{"type":"string","description":"For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.","nullable":true},"referenceNumber":{"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ParcelItem"},"description":"Items that are included in the parcel.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ParcelCreateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelCreateModel":{"required":["customerId","fulfillmentOrderIds","status"],"type":"object","properties":{"fulfillmentOrderIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int64"},"description":"Fulfillment items for which the parcel is created. Specify all fulfillment items whose service instances are sent with this package.\nAll fulfillment orders must belong to the same customer."},"customerId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Id of the customer who receives the parcel.","format":"int32"},"deliveryAddressId":{"type":"integer","description":"Address where the parcel is delivered to. The address needs to belong to the recipient company/customer.","format":"int32","nullable":true},"originAddressId":{"type":"integer","description":"Address from which the parcel is sent. The address needs to belong to the sender company (your customer entity).","format":"int32","nullable":true},"recipientName":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the recipient in addition to the delivery address.\nCorresponds to Address Line 1 in shipping information of the carrier.\nFor example, the name of the person to whom the shipment was entrusted.","nullable":true},"referenceNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryNoteNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Identification number of the delivery note in the parcel.","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true}},"additionalProperties":false},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."}}}}
```

## The ParcelItem object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ParcelList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Parcel"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Parcel":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the parcel.","format":"int32"},"createdBy":{"$ref":"#/components/schemas/UserReference"},"created":{"type":"string","description":"Date on which the parcel entry was created. (ISO 8601 format)","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"deliveryNoteNumber":{"type":"string","description":"Identification number of the delivery note in the parcel","nullable":true},"originAddress":{"$ref":"#/components/schemas/Address"},"recipientName":{"type":"string","description":"For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.","nullable":true},"referenceNumber":{"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ParcelItem"},"description":"Items that are included in the parcel.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ParcelSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelSortParameter":{"enum":["created","status"],"type":"string","description":"Parameters according to which a customer can be sorted."}}}}
```

## The ParcelStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."}}}}
```

## The ParcelUpdateModel object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ParcelUpdateModel":{"required":["status"],"type":"object","properties":{"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryNoteNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Identification number of the delivery note in the parcel.","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true}},"additionalProperties":false},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."}}}}
```

## The Product object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Product":{"required":["category","id","name","partNumber","self"],"type":"object","properties":{"source":{"type":"string","description":"A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.","nullable":true},"description":{"type":"string","description":"A short description of the product","nullable":true},"category":{"minLength":1,"type":"string","description":"Name of the technical category of the product."},"manufacturer":{"type":"string","description":"The name of the company which produces the product.","nullable":true},"ean":{"type":"string","description":"The European Article Number of the product","nullable":true},"defaultSourcingOffer":{"$ref":"#/components/schemas/ProductOffer"},"defaultSalesOffer":{"$ref":"#/components/schemas/ProductOffer"},"isStockProduct":{"type":"boolean","description":"Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.","nullable":true},"minimumStock":{"maximum":1000,"minimum":0,"type":"integer","description":"Minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed.\nRequires \"IsStockProduct\" to be set to true otherwise it will be ignored","format":"int32","nullable":true},"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOffer":{"required":["created","currency","id","price","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"created":{"type":"string","description":"The time when the offer got created.","format":"date-time"},"externalId":{"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"id":{"type":"integer","description":"The identifier of the product offer.","format":"int64"},"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"}}}}
```

## The ProductCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductCreate":{"required":["category","name","sourcingOffer"],"type":"object","properties":{"externalId":{"maxLength":256,"minLength":0,"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"source":{"type":"string","description":"A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.","nullable":true},"sourcingOffer":{"$ref":"#/components/schemas/ProductOfferCreate"},"name":{"maxLength":512,"minLength":0,"type":"string","description":"The name of the product"},"description":{"maxLength":2048,"minLength":0,"type":"string","description":"A short description of the product","nullable":true},"ean":{"maxLength":50,"minLength":0,"type":"string","description":"The European Article Number of the product","nullable":true},"partNumber":{"maxLength":256,"minLength":0,"type":"string","description":"The manufacturer part number of the product.","nullable":true},"manufacturer":{"maxLength":256,"minLength":0,"type":"string","description":"The name of the company which produces the product.","nullable":true},"category":{"minLength":1,"type":"string","description":"Name of the technical category of the product. For available categories see /categories route."},"salesOffer":{"$ref":"#/components/schemas/ProductOfferCreate"},"isStockProduct":{"type":"boolean","description":"Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.","nullable":true},"minimumStock":{"maximum":1000,"minimum":0,"type":"integer","description":"The minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed.\nRequires \"IsStockProduct\" to be set to true otherwise it will be ignored","format":"int32","nullable":true}},"additionalProperties":false},"ProductOfferCreate":{"required":["currency","price","scope"],"type":"object","properties":{"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"supplier":{"type":"string","description":"The supplier offering the product at given price.","nullable":true},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"maximum":7.922816251426434e+28,"minimum":0,"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"externalId":{"maxLength":256,"minLength":0,"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true}},"additionalProperties":false},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"}}}}
```

## The ProductList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Product":{"required":["category","id","name","partNumber","self"],"type":"object","properties":{"source":{"type":"string","description":"A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.","nullable":true},"description":{"type":"string","description":"A short description of the product","nullable":true},"category":{"minLength":1,"type":"string","description":"Name of the technical category of the product."},"manufacturer":{"type":"string","description":"The name of the company which produces the product.","nullable":true},"ean":{"type":"string","description":"The European Article Number of the product","nullable":true},"defaultSourcingOffer":{"$ref":"#/components/schemas/ProductOffer"},"defaultSalesOffer":{"$ref":"#/components/schemas/ProductOffer"},"isStockProduct":{"type":"boolean","description":"Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.","nullable":true},"minimumStock":{"maximum":1000,"minimum":0,"type":"integer","description":"Minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed.\nRequires \"IsStockProduct\" to be set to true otherwise it will be ignored","format":"int32","nullable":true},"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ProductOffer":{"required":["created","currency","id","price","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"created":{"type":"string","description":"The time when the offer got created.","format":"date-time"},"externalId":{"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"id":{"type":"integer","description":"The identifier of the product offer.","format":"int64"},"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"}}}}
```

## The ProductOffer object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOffer":{"required":["created","currency","id","price","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"created":{"type":"string","description":"The time when the offer got created.","format":"date-time"},"externalId":{"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"id":{"type":"integer","description":"The identifier of the product offer.","format":"int64"},"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"}}}}
```

## The ProductOfferCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOfferCreate":{"required":["currency","price","scope"],"type":"object","properties":{"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"supplier":{"type":"string","description":"The supplier offering the product at given price.","nullable":true},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"maximum":7.922816251426434e+28,"minimum":0,"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"externalId":{"maxLength":256,"minLength":0,"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true}},"additionalProperties":false},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"}}}}
```

## The ProductOfferList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOfferList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductOffer"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ProductOffer":{"required":["created","currency","id","price","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"created":{"type":"string","description":"The time when the offer got created.","format":"date-time"},"externalId":{"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"id":{"type":"integer","description":"The identifier of the product offer.","format":"int64"},"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"}}}}
```

## The ProductOfferScope object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"}}}}
```

## The ProductOfferSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOfferSortParameter":{"enum":["created"],"type":"string"}}}}
```

## The ProductOfferUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOfferUpdate":{"required":["currency","price"],"type":"object","properties":{"supplier":{"type":"string","description":"The supplier offering the product at given price.","nullable":true},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"maximum":7.922816251426434e+28,"minimum":0,"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"externalId":{"maxLength":256,"minLength":0,"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"}}}}
```

## The ProductOptionReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOptionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the option","format":"int32"},"name":{"type":"string","description":"Display name of the option","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ProductOptionVersionReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductOptionVersionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the version","format":"int32"},"name":{"type":"string","description":"Display name of the version","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ProductReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductReference":{"required":["id","name","partNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the product.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the product."},"partNumber":{"minLength":1,"type":"string","description":"The manufacturer part number of the product."},"externalId":{"type":"string","description":"The id of the product in an external application like an ERP. Can be used for synchronization correlation.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ProductSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductSortParameter":{"enum":["name"],"type":"string"}}}}
```

## The ProductUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ProductUpdate":{"required":["category","name"],"type":"object","properties":{"name":{"maxLength":512,"minLength":0,"type":"string","description":"The name of the product"},"description":{"maxLength":2048,"minLength":0,"type":"string","description":"A short description of the product","nullable":true},"ean":{"maxLength":50,"minLength":0,"type":"string","description":"The European Article Number of the product","nullable":true},"partNumber":{"maxLength":256,"minLength":0,"type":"string","description":"The manufacturer part number of the product.","nullable":true},"manufacturer":{"maxLength":256,"minLength":0,"type":"string","description":"The name of the company which produces the product.","nullable":true},"category":{"minLength":1,"type":"string","description":"Name of the technical category of the product. For available categories see /categories route."},"salesOffer":{"$ref":"#/components/schemas/ProductOfferCreate"},"isStockProduct":{"type":"boolean","description":"Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.","nullable":true},"minimumStock":{"maximum":1000,"minimum":0,"type":"integer","description":"The minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed.\nRequires \"IsStockProduct\" to be set to true otherwise it will be ignored","format":"int32","nullable":true}},"additionalProperties":false},"ProductOfferCreate":{"required":["currency","price","scope"],"type":"object","properties":{"scope":{"$ref":"#/components/schemas/ProductOfferScope"},"supplier":{"type":"string","description":"The supplier offering the product at given price.","nullable":true},"price":{"maximum":7.922816251426434e+28,"minimum":0,"type":"number","description":"The price of the offer.","format":"double"},"stockQuantity":{"maximum":7.922816251426434e+28,"minimum":0,"type":"integer","description":"The currently available stock quantity.","format":"int32","nullable":true},"currency":{"$ref":"#/components/schemas/Currency"},"externalId":{"maxLength":256,"minLength":0,"type":"string","description":"The id of the offer in an external application like an ERP. Can be used for synchronization correlation.","nullable":true}},"additionalProperties":false},"ProductOfferScope":{"enum":["sourcing","sales"],"type":"string"},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"}}}}
```

## The ResourceLink object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ResourceListReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ResourceListReference":{"required":["self","total"],"type":"object","properties":{"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ResourceReference\_Int32 object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ResourceReference\_Int64 object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The RoleAssignment object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"RoleAssignment":{"required":["employeeId","role"],"type":"object","properties":{"employeeId":{"type":"integer","description":"The employee ID to assign the role to.","format":"int32"},"role":{"$ref":"#/components/schemas/UserRole"}},"additionalProperties":false,"description":"Assignment of a role to an employee for a customer."},"UserRole":{"enum":["administrator","planner","user"],"type":"string","description":"Roles available to be assigned to an employee as a user in Equipme. Options will be extended in the future."}}}}
```

## The SalesContext object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesContext":{"required":["name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContextName"},"optional":{"type":"boolean","description":"If multiple contexts are defined, they can be set as optional. Otherwise, an assignment\nto the corresponding context entity is mandatory.","default":false},"changeAllowed":{"type":"boolean","description":"Defines whether the site or employee assignment of a service instance can be changed within the\nsubscription period. (Only if the \"location\" or \"employee\" context is configured for this service)","default":false}},"additionalProperties":false,"description":"A context defines which entity (e.g. employee or location) can be assigned to an instance of a product (e.g. during ordering)."},"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."}}}}
```

## The SalesOrder object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesOrder":{"required":["created","customer","id","items","orderedBy","orderNumber","self","status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/SalesOrderStatus"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"note":{"type":"string","description":"Note the customer can add to their order in a html format.","nullable":true},"orderedBy":{"$ref":"#/components/schemas/UserReference"},"items":{"$ref":"#/components/schemas/ResourceListReference"},"id":{"type":"integer","description":"The identifier of the order is also the order number.","format":"int64"},"customerOrderNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Order reference number from the customer","nullable":true},"orderNumber":{"minLength":1,"type":"string","description":"Unique reference number of the sales order."},"created":{"type":"string","description":"The date and time when the order was placed. (ISO 8601 format)","format":"date-time"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SalesOrderStatus":{"enum":["unknown","new","inprocess","processed","cancelled"],"type":"string","description":"Status of an order / order item"},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceListReference":{"required":["self","total"],"type":"object","properties":{"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The SalesOrderList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesOrderList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SalesOrder"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"SalesOrder":{"required":["created","customer","id","items","orderedBy","orderNumber","self","status"],"type":"object","properties":{"status":{"$ref":"#/components/schemas/SalesOrderStatus"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"note":{"type":"string","description":"Note the customer can add to their order in a html format.","nullable":true},"orderedBy":{"$ref":"#/components/schemas/UserReference"},"items":{"$ref":"#/components/schemas/ResourceListReference"},"id":{"type":"integer","description":"The identifier of the order is also the order number.","format":"int64"},"customerOrderNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Order reference number from the customer","nullable":true},"orderNumber":{"minLength":1,"type":"string","description":"Unique reference number of the sales order."},"created":{"type":"string","description":"The date and time when the order was placed. (ISO 8601 format)","format":"date-time"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SalesOrderStatus":{"enum":["unknown","new","inprocess","processed","cancelled"],"type":"string","description":"Status of an order / order item"},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceListReference":{"required":["self","total"],"type":"object","properties":{"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The SalesOrderReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesOrderReference":{"required":["created","id","orderNumber","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the order is also the order number.","format":"int64"},"customerOrderNumber":{"maxLength":100,"minLength":0,"type":"string","description":"Order reference number from the customer","nullable":true},"orderNumber":{"minLength":1,"type":"string","description":"Unique reference number of the sales order."},"created":{"type":"string","description":"The date and time when the order was placed. (ISO 8601 format)","format":"date-time"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The SalesOrderStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesOrderStatus":{"enum":["unknown","new","inprocess","processed","cancelled"],"type":"string","description":"Status of an order / order item"}}}}
```

## The SalesVersionOfferReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SalesVersionOfferReference":{"required":["id","purchasePrice","recurringPrice","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int64"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryAttributeDefinition object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryAttributeDefinition":{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/AttributeDefinitionReference"},"rank":{"type":"integer","description":"The display rank order of the attribute","format":"int32","nullable":true}},"additionalProperties":false},"AttributeDefinitionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryAttributeDefinitionChange object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryAttributeDefinitionChange":{"type":"object","properties":{"definitionId":{"type":"integer","description":"The attribute to be defined for products of this category","format":"int32"},"rank":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryCreate":{"required":["displayValue","name"],"type":"object","properties":{"parentCategoryId":{"type":"integer","description":"The identifier of the categories parent. Set to null if the category is a root category.","format":"int32","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The technical name of the category to identify category regardless localization. Must be unique and can not be updated afterwards."},"displayValue":{"maxLength":50,"minLength":0,"type":"string"},"description":{"maxLength":500,"minLength":0,"type":"string","description":"A further description of the category","nullable":true},"rank":{"type":"integer","description":"The display rank order of the category","format":"int32","nullable":true},"imageLink":{"maxLength":2000,"minLength":0,"pattern":"^https://.*","type":"string","description":"Url to an image to be shown in the marketplace.","nullable":true},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryAttributeDefinitionChange"},"description":"Attribute definitions to be added to the category","nullable":true,"readOnly":true}},"additionalProperties":false},"ServiceCategoryAttributeDefinitionChange":{"type":"object","properties":{"definitionId":{"type":"integer","description":"The attribute to be defined for products of this category","format":"int32"},"rank":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryDetails object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryDetails":{"required":["self"],"type":"object","properties":{"parentCategory":{"$ref":"#/components/schemas/ServiceCategoryParentReference"},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryAttributeDefinition"},"description":"Attributes defined by this category for products of the category.","nullable":true},"created":{"type":"string","description":"The date and time when the service was created. (ISO 8601 format)","format":"date-time"},"description":{"type":"string","description":"A further description of the category","nullable":true},"rank":{"type":"integer","description":"The display rank order of the category","format":"int32","nullable":true},"imageLink":{"type":"string","description":"Url to an image to be shown in the marketplace.","nullable":true},"id":{"type":"integer","description":"The identifier of the category.","format":"int32"},"name":{"type":"string","description":"The technical name of the category to identify category regardless localization.","nullable":true},"displayValue":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceCategoryParentReference":{"required":["self"],"type":"object","properties":{"parentCategory":{"$ref":"#/components/schemas/ServiceCategoryParentReference"},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryAttributeDefinition"},"description":"Attributes defined by this category for products of the category.","nullable":true},"id":{"type":"integer","description":"The identifier of the category.","format":"int32"},"name":{"type":"string","description":"The technical name of the category to identify category regardless localization.","nullable":true},"displayValue":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceCategoryAttributeDefinition":{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/AttributeDefinitionReference"},"rank":{"type":"integer","description":"The display rank order of the attribute","format":"int32","nullable":true}},"additionalProperties":false},"AttributeDefinitionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryTreeItem"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceCategoryTreeItem":{"required":["self"],"type":"object","properties":{"childCategories":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryTreeItem"},"description":"Child categories of the category for a tree representation","nullable":true},"imageLink":{"type":"string","description":"Url to an image to be shown in the marketplace.","nullable":true},"id":{"type":"integer","description":"The identifier of the category.","format":"int32"},"name":{"type":"string","description":"The technical name of the category to identify category regardless localization.","nullable":true},"displayValue":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ServiceCategoryParentReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryParentReference":{"required":["self"],"type":"object","properties":{"parentCategory":{"$ref":"#/components/schemas/ServiceCategoryParentReference"},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryAttributeDefinition"},"description":"Attributes defined by this category for products of the category.","nullable":true},"id":{"type":"integer","description":"The identifier of the category.","format":"int32"},"name":{"type":"string","description":"The technical name of the category to identify category regardless localization.","nullable":true},"displayValue":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceCategoryAttributeDefinition":{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/AttributeDefinitionReference"},"rank":{"type":"integer","description":"The display rank order of the attribute","format":"int32","nullable":true}},"additionalProperties":false},"AttributeDefinitionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceCategoryTreeItem object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceCategoryTreeItem":{"required":["self"],"type":"object","properties":{"childCategories":{"type":"array","items":{"$ref":"#/components/schemas/ServiceCategoryTreeItem"},"description":"Child categories of the category for a tree representation","nullable":true},"imageLink":{"type":"string","description":"Url to an image to be shown in the marketplace.","nullable":true},"id":{"type":"integer","description":"The identifier of the category.","format":"int32"},"name":{"type":"string","description":"The technical name of the category to identify category regardless localization.","nullable":true},"displayValue":{"type":"string","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceConfigurationType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceConfigurationType":{"enum":["simple","dynamic"],"type":"string","description":"Defines the configuration complexity of a service. Can not be changed after service creation."}}}}
```

## The ServiceInstance object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstance":{"required":["id","self"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"location":{"$ref":"#/components/schemas/LocationReference"},"group":{"$ref":"#/components/schemas/GroupReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"},"activationDate":{"type":"string","description":"The date the service instance was activated.","format":"date-time","nullable":true},"lastModifiedDate":{"type":"string","description":"The date the service instance was last modified.","format":"date-time","nullable":true},"expirationDate":{"type":"string","description":"The date when the service instance should expire.","format":"date-time","nullable":true},"processStatus":{"type":"string","description":"The processing status of the service instance.","nullable":true},"active":{"type":"boolean","description":"True if the service instance is active, otherwise false."},"oneTimeCosts":{"type":"number","description":"One-time purchase costs of the instance in its life cycle to date.","format":"double"},"recurringCosts":{"type":"number","description":"The current recurring costs for the service instance. Only calculated for active instances.","format":"double"},"currencyCode":{"type":"string","description":"Currency in ISO 4217","nullable":true},"subscriptionPeriod":{"type":"integer","description":"The minimum subscription period (in months) for the services instance.","format":"int32","nullable":true},"subscriptionPeriodRenewal":{"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32","nullable":true},"note":{"type":"string","description":"A note on the service instance. Supports html formatted text including inline css styles.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"GroupReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The ServiceInstanceCancellationCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceCancellationCreate":{"type":"object","properties":{"scheduledProcessingDate":{"type":"string","description":"The date on which the cancellation order item should be automatically processed.\nWhen omitted the order item will not be processed automatically and must be processed manually.","format":"date","nullable":true}},"additionalProperties":false,"description":"Request body for creating a service instance cancellation."}}}}
```

## The ServiceInstanceCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceCreate":{"required":["offerId"],"type":"object","properties":{"offerId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"The id of the corresponding sales service offer. The offer is used as the base for the instances price and period.\n\nTo overwrite prices and periods of the offer for the service instance to be created, set values OneTimeCosts, RecurringCosts, SubscriptionPeriod and SubscriptionPeriodRenewal\n\nOffer and related service must be available for the customer, i.e. either no customer limitation exists or it contains the customer for whom the instance is to be created.","format":"int32"},"customerId":{"type":"integer","description":"The id of the customer to assign the service instance to. If no id is provided, the instance will be created in the provided tenant context (see Tenant header).","format":"int32","nullable":true},"groupId":{"type":"integer","description":"The id of the group to assign the service instance to.","format":"int32","nullable":true},"note":{"maxLength":10000,"minLength":0,"type":"string","description":"A note on the service instance. Supports html formatted text including inline css styles.","nullable":true},"oneTimeCosts":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"One-time purchase costs of the instance in its life cycle to date.\nWhen set, overwrites the value of the provided offer for this service instance.","format":"double","nullable":true},"recurringCosts":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The current recurring costs for the service instance.\nWhen set, overwrites the value of the provided offer for this service instance.","format":"double","nullable":true},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for the services instance.\nWhen set, overwrites the value of the provided offer for this service instance.","format":"int32","nullable":true},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.\nWhen set, overwrites the value of the provided offer for this service instance.","format":"int32","nullable":true},"activationDate":{"type":"string","description":"The date the service instance was activated. If no date is provided UtcNow will be used. Currently only active instances can be created which always need an activation date. The activation date can only be set to the past.","format":"date-time","nullable":true},"expirationDate":{"type":"string","description":"The date when the service instance should expire. If not provided this gets calculated based on the ActivationDate added by the SubscriptionPeriod and will extend based on the SubscriptionPeriodRenewal.\n\nThe expiration date must not be before the activation date.","format":"date-time","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"locationId":{"type":"integer","description":"The id of the location to assign the service instance to. Needs to be a valid location of the customer.\nNull will remove the location assignment.","format":"int32","nullable":true},"employeeId":{"type":"integer","description":"The id of the employee to assign the service instance to. Needs to be a valid employee of the customer.\nNull will remove the employee assignment.","format":"int32","nullable":true},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The ServiceInstanceList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ServiceInstance"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceInstance":{"required":["id","self"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"location":{"$ref":"#/components/schemas/LocationReference"},"group":{"$ref":"#/components/schemas/GroupReference"},"employee":{"$ref":"#/components/schemas/EmployeeReference"},"activationDate":{"type":"string","description":"The date the service instance was activated.","format":"date-time","nullable":true},"lastModifiedDate":{"type":"string","description":"The date the service instance was last modified.","format":"date-time","nullable":true},"expirationDate":{"type":"string","description":"The date when the service instance should expire.","format":"date-time","nullable":true},"processStatus":{"type":"string","description":"The processing status of the service instance.","nullable":true},"active":{"type":"boolean","description":"True if the service instance is active, otherwise false."},"oneTimeCosts":{"type":"number","description":"One-time purchase costs of the instance in its life cycle to date.","format":"double"},"recurringCosts":{"type":"number","description":"The current recurring costs for the service instance. Only calculated for active instances.","format":"double"},"currencyCode":{"type":"string","description":"Currency in ISO 4217","nullable":true},"subscriptionPeriod":{"type":"integer","description":"The minimum subscription period (in months) for the services instance.","format":"int32","nullable":true},"subscriptionPeriodRenewal":{"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32","nullable":true},"note":{"type":"string","description":"A note on the service instance. Supports html formatted text including inline css styles.","nullable":true},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"LocationReference":{"required":["id","name","self","type"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the company location.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the company location."},"type":{"$ref":"#/components/schemas/LocationType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"A location can either be a company location or a work from home location."},"LocationType":{"enum":["location","warehouse","remoteWork"],"type":"string","description":"The type of location."},"GroupReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the group in the system.","format":"int32"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"The name of the group."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"EmployeeReference":{"required":["id","self","username"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"The last/family name of the employee.","nullable":true},"fullName":{"maxLength":150,"minLength":0,"type":"string","description":"Combination of last and firstname","nullable":true,"readOnly":true},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*\\.[a-zA-Z]{2,}$","type":"string","description":"The username to log in to the app. The value has to be an e-mail address."},"costCenter":{"maxLength":100,"minLength":0,"type":"string","description":"The cost center of the employee.","nullable":true},"costCenterId":{"type":"integer","description":"The identifier of the cost center.","format":"int32","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The ServiceInstanceMetadataScope object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The ServiceInstanceReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true},"costCenter":{"type":"string","description":"The name of the cost center to which the service instance belongs.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceInstanceSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceSortParameter":{"enum":["product","supplier","customer","oneTimeCosts","recurringCosts","activationDate","lastModified","expirationDate","inventoryNumber"],"type":"string"}}}}
```

## The ServiceInstanceUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceInstanceUpdate":{"type":"object","properties":{"locationId":{"type":"integer","description":"The id of the location to assign the service instance to. Needs to be a valid location of the customer.\nNull will remove the location assignment.","format":"int32","nullable":true},"employeeId":{"type":"integer","description":"The id of the employee to assign the service instance to. Needs to be a valid employee of the customer.\nNull will remove the employee assignment.","format":"int32","nullable":true},"inventoryNumber":{"maxLength":50,"minLength":0,"type":"string","description":"The inventory number of the service instance.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceOffer object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOffer":{"required":["created","currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","subscriptionPeriodRenewal","type"],"type":"object","properties":{"created":{"type":"string","description":"UTC date of offer creation","format":"date-time"},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32"},"differentInvoiceIssuer":{"maxLength":100,"minLength":0,"type":"string","description":"Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. \nApplicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.","nullable":true},"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceOfferCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOfferCreate":{"required":["currency","purchasePrice","recurringPrice","subscriptionPeriod","subscriptionPeriodRenewal","type"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the offer","nullable":true},"type":{"$ref":"#/components/schemas/OfferType"},"customerIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Customer IDs for which the service offer is available. If null, the service offer is available to all customers for which the service is available.","nullable":true},"syncPriceFromBom":{"type":"boolean","description":"Determines if the Prices are synced to the sales offers of the mapped products"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in month) for rental offers.","format":"int32"},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32"},"differentInvoiceIssuer":{"maxLength":100,"minLength":0,"type":"string","description":"Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. \nApplicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Specifies if this offer is a default offer for the service.\nEvery service must have one default offer per offer type.","nullable":true}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"}}}}
```

## The ServiceOfferList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOfferList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ServiceOffer"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceOffer":{"required":["created","currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","subscriptionPeriodRenewal","type"],"type":"object","properties":{"created":{"type":"string","description":"UTC date of offer creation","format":"date-time"},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32"},"differentInvoiceIssuer":{"maxLength":100,"minLength":0,"type":"string","description":"Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. \nApplicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.","nullable":true},"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"}}}}
```

## The ServiceOfferReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOfferReference":{"required":["currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","type"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceOfferSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOfferSortParameter":{"enum":["created"],"type":"string"}}}}
```

## The ServiceOfferUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceOfferUpdate":{"required":["purchasePrice","recurringPrice","subscriptionPeriod","subscriptionPeriodRenewal"],"type":"object","properties":{"syncPriceFromBom":{"type":"boolean","description":"Determines if the Prices are synced to the sales offers of the mapped products"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in month) for rental offers.","format":"int32"},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32"},"differentInvoiceIssuer":{"maxLength":100,"minLength":0,"type":"string","description":"Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. \nApplicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Specifies if this offer is a default offer for the service.\nEvery service must have one default offer per offer type.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceProduct object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProduct":{"required":["id","name","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"shortDescription":{"type":"string","description":"A short description of the service without any formatting.","nullable":true},"detailDescription":{"type":"string","nullable":true},"scopeOfService":{"type":"string","nullable":true},"marketplaceCategory":{"type":"string","description":"Technical name of the marketplace category in which the service is\ndisplayed. Marketplace category can be managed by each supplier.","nullable":true},"marketplaceRank":{"type":"integer","description":"Defines in which order the service is displayed in its\nmarketplace category. The lower the value, the further forward the service\nis displayed.","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/ServiceProductStatus"},"availability":{"$ref":"#/components/schemas/ServiceProductAvailability"},"availabilityMessage":{"type":"string","description":"A message in the service details that is displayed to further define the availability of the product.","nullable":true},"contexts":{"type":"array","items":{"$ref":"#/components/schemas/SalesContext"},"description":"Context in which the service can be assigned.","nullable":true},"offers":{"type":"array","items":{"$ref":"#/components/schemas/ServiceOfferReference"},"description":"A list of all offers of the sales service.","nullable":true},"created":{"type":"string","description":"The date and time when the service was created. (ISO 8601 format)","format":"date-time"},"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceProductStatus":{"enum":["active","inactive","archived","removed"],"type":"string"},"ServiceProductAvailability":{"enum":["available","available_soon","not_available"],"type":"string","description":"Current availability status. Possible values: NULL, available, available_soon, not_available"},"SalesContext":{"required":["name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContextName"},"optional":{"type":"boolean","description":"If multiple contexts are defined, they can be set as optional. Otherwise, an assignment\nto the corresponding context entity is mandatory.","default":false},"changeAllowed":{"type":"boolean","description":"Defines whether the site or employee assignment of a service instance can be changed within the\nsubscription period. (Only if the \"location\" or \"employee\" context is configured for this service)","default":false}},"additionalProperties":false,"description":"A context defines which entity (e.g. employee or location) can be assigned to an instance of a product (e.g. during ordering)."},"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."},"ServiceOfferReference":{"required":["currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","type"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."}}}}
```

## The ServiceProductAttribute object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductAttribute":{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/AttributeDefinitionReference"},"value":{"$ref":"#/components/schemas/AttributeValueReference"},"rank":{"type":"integer","description":"The display rank order of the attribute","format":"int32","nullable":true}},"additionalProperties":false},"AttributeDefinitionReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute definition.","format":"int32"},"name":{"type":"string","description":"The name of the attribute.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"AttributeValueReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the attribute value.","format":"int32"},"displayValue":{"type":"string","description":"The value for the attribute to be displayed.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false}}}}
```

## The ServiceProductAvailability object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductAvailability":{"enum":["available","available_soon","not_available"],"type":"string","description":"Current availability status. Possible values: NULL, available, available_soon, not_available"}}}}
```

## The ServiceProductCreate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductCreate":{"required":["marketplaceCategory","name","offer"],"type":"object","properties":{"configurationType":{"$ref":"#/components/schemas/ServiceConfigurationType"},"offer":{"$ref":"#/components/schemas/ServiceOfferCreate"},"bomItems":{"type":"array","items":{"$ref":"#/components/schemas/BomItemCreateModel"},"description":"The products which are items in the bill of materials (optional).","nullable":true},"customerIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Customer IDs for which the service is available. If null, the service is available to all customers.","nullable":true},"previewImageLink":{"type":"string","description":"The link of the preview image for the service. Recommended size is 200x200px.","nullable":true},"images":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProductImage"},"description":"A list of images of the products included in the service.","nullable":true},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the service. (Max. 100 characters)"},"shortDescription":{"maxLength":1500,"minLength":0,"type":"string","description":"A short description of the service without any formatting.","nullable":true},"detailDescription":{"type":"string","nullable":true},"scopeOfService":{"type":"string","nullable":true},"marketplaceCategory":{"maxLength":50,"minLength":0,"type":"string","description":"Technical name of the marketplace category in which the service is\ndisplayed. Marketplace category can be managed by each supplier."},"marketplaceRank":{"type":"integer","description":"Defines in which order the service is displayed in its\nmarketplace category. The lower the value, the further forward the service\nis displayed.","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/ServiceProductStatus"},"ean":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"contexts":{"type":"array","items":{"$ref":"#/components/schemas/SalesContext"},"description":"Context in which the service can be assigned.","nullable":true}},"additionalProperties":false},"ServiceConfigurationType":{"enum":["simple","dynamic"],"type":"string","description":"Defines the configuration complexity of a service. Can not be changed after service creation."},"ServiceOfferCreate":{"required":["currency","purchasePrice","recurringPrice","subscriptionPeriod","subscriptionPeriodRenewal","type"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the offer","nullable":true},"type":{"$ref":"#/components/schemas/OfferType"},"customerIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Customer IDs for which the service offer is available. If null, the service offer is available to all customers for which the service is available.","nullable":true},"syncPriceFromBom":{"type":"boolean","description":"Determines if the Prices are synced to the sales offers of the mapped products"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in month) for rental offers.","format":"int32"},"subscriptionPeriodRenewal":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Number of months a subscription is renewed after its expiration time if it has not been terminated.","format":"int32"},"differentInvoiceIssuer":{"maxLength":100,"minLength":0,"type":"string","description":"Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. \nApplicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Specifies if this offer is a default offer for the service.\nEvery service must have one default offer per offer type.","nullable":true}},"additionalProperties":false},"Currency":{"enum":["EUR"],"type":"string","description":"Supported currencies in ISO 4217 format"},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"BomItemCreateModel":{"required":["productId","quantity"],"type":"object","properties":{"productId":{"type":"integer","description":"The id of the product for which an item in the bill of materials should be created.","format":"int64"},"quantity":{"maximum":20,"minimum":1,"type":"integer","description":"Quantity of the product in the bill of materials","format":"int32","default":1},"subscriptionPeriodCondition":{"maximum":2147483647,"minimum":0,"type":"integer","description":"If set to any value but null, this bom item will only be applied on orders of an offer with the matching subscription period.","format":"int32","nullable":true}},"additionalProperties":false},"ServiceProductImage":{"required":["large","medium","small"],"type":"object","properties":{"large":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in large size. Recommended size is min 1200px on the longest edge."},"medium":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in medium size. Recommended size is about 600px on the longest edge."},"small":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in small size. Recommended size is 200px on the longest edge."},"rank":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The rank of the image. The rank is used to sort the images in the order they should be displayed.","format":"int32"}},"additionalProperties":false,"description":"Image object for a service product represented in several sizes for improved display."},"ServiceProductStatus":{"enum":["active","inactive","archived","removed"],"type":"string"},"SalesContext":{"required":["name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContextName"},"optional":{"type":"boolean","description":"If multiple contexts are defined, they can be set as optional. Otherwise, an assignment\nto the corresponding context entity is mandatory.","default":false},"changeAllowed":{"type":"boolean","description":"Defines whether the site or employee assignment of a service instance can be changed within the\nsubscription period. (Only if the \"location\" or \"employee\" context is configured for this service)","default":false}},"additionalProperties":false,"description":"A context defines which entity (e.g. employee or location) can be assigned to an instance of a product (e.g. during ordering)."},"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."}}}}
```

## The ServiceProductImage object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductImage":{"required":["large","medium","small"],"type":"object","properties":{"large":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in large size. Recommended size is min 1200px on the longest edge."},"medium":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in medium size. Recommended size is about 600px on the longest edge."},"small":{"maxLength":2000,"minLength":0,"type":"string","description":"Link for the image in small size. Recommended size is 200px on the longest edge."},"rank":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The rank of the image. The rank is used to sort the images in the order they should be displayed.","format":"int32"}},"additionalProperties":false,"description":"Image object for a service product represented in several sizes for improved display."}}}}
```

## The ServiceProductList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProduct"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"ServiceProduct":{"required":["id","name","self","supplier"],"type":"object","properties":{"supplier":{"$ref":"#/components/schemas/SupplierReference"},"shortDescription":{"type":"string","description":"A short description of the service without any formatting.","nullable":true},"detailDescription":{"type":"string","nullable":true},"scopeOfService":{"type":"string","nullable":true},"marketplaceCategory":{"type":"string","description":"Technical name of the marketplace category in which the service is\ndisplayed. Marketplace category can be managed by each supplier.","nullable":true},"marketplaceRank":{"type":"integer","description":"Defines in which order the service is displayed in its\nmarketplace category. The lower the value, the further forward the service\nis displayed.","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/ServiceProductStatus"},"availability":{"$ref":"#/components/schemas/ServiceProductAvailability"},"availabilityMessage":{"type":"string","description":"A message in the service details that is displayed to further define the availability of the product.","nullable":true},"contexts":{"type":"array","items":{"$ref":"#/components/schemas/SalesContext"},"description":"Context in which the service can be assigned.","nullable":true},"offers":{"type":"array","items":{"$ref":"#/components/schemas/ServiceOfferReference"},"description":"A list of all offers of the sales service.","nullable":true},"created":{"type":"string","description":"The date and time when the service was created. (ISO 8601 format)","format":"date-time"},"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductStatus":{"enum":["active","inactive","archived","removed"],"type":"string"},"ServiceProductAvailability":{"enum":["available","available_soon","not_available"],"type":"string","description":"Current availability status. Possible values: NULL, available, available_soon, not_available"},"SalesContext":{"required":["name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContextName"},"optional":{"type":"boolean","description":"If multiple contexts are defined, they can be set as optional. Otherwise, an assignment\nto the corresponding context entity is mandatory.","default":false},"changeAllowed":{"type":"boolean","description":"Defines whether the site or employee assignment of a service instance can be changed within the\nsubscription period. (Only if the \"location\" or \"employee\" context is configured for this service)","default":false}},"additionalProperties":false,"description":"A context defines which entity (e.g. employee or location) can be assigned to an instance of a product (e.g. during ordering)."},"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."},"ServiceOfferReference":{"required":["currency","id","purchasePrice","recurringPrice","self","subscriptionPeriod","type"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the offer in the system.","format":"int32"},"type":{"$ref":"#/components/schemas/OfferType"},"purchasePrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged only once after providing the item.","format":"double"},"recurringPrice":{"maximum":1.7976931348623157e+308,"minimum":0,"type":"number","description":"The price charged monthly after providing the item for the subscription period","format":"double"},"currency":{"minLength":1,"type":"string","description":"Currency in ISO 4217"},"subscriptionPeriod":{"maximum":2147483647,"minimum":0,"type":"integer","description":"The minimum subscription period (in months) for rental offers.","format":"int32"},"name":{"type":"string","description":"Name of the offer","nullable":true},"externalId":{"type":"string","description":"Value to identify the offer in other systems. E.g. when another system is the source of this offer.","nullable":true},"isDefault":{"type":"boolean","description":"Indicates if this offer is a default offer for the service."},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"OfferType":{"enum":["rental","lease","purchase","subscription","leasing"],"type":"string"},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."}}}}
```

## The ServiceProductReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The ServiceProductSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductSortParameter":{"enum":["name","supplier","created"],"type":"string"}}}}
```

## The ServiceProductStatus object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductStatus":{"enum":["active","inactive","archived","removed"],"type":"string"}}}}
```

## The ServiceProductType object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."}}}}
```

## The ServiceProductUpdate object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"ServiceProductUpdate":{"required":["marketplaceCategory","name"],"type":"object","properties":{"availability":{"$ref":"#/components/schemas/ServiceProductAvailability"},"availabilityMessage":{"maxLength":100,"minLength":0,"type":"string","description":"A message in the service details that is displayed to further define the availability of the service.","nullable":true},"name":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the service. (Max. 100 characters)"},"shortDescription":{"maxLength":1500,"minLength":0,"type":"string","description":"A short description of the service without any formatting.","nullable":true},"detailDescription":{"type":"string","nullable":true},"scopeOfService":{"type":"string","nullable":true},"marketplaceCategory":{"maxLength":50,"minLength":0,"type":"string","description":"Technical name of the marketplace category in which the service is\ndisplayed. Marketplace category can be managed by each supplier."},"marketplaceRank":{"type":"integer","description":"Defines in which order the service is displayed in its\nmarketplace category. The lower the value, the further forward the service\nis displayed.","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/ServiceProductStatus"},"ean":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"contexts":{"type":"array","items":{"$ref":"#/components/schemas/SalesContext"},"description":"Context in which the service can be assigned.","nullable":true}},"additionalProperties":false},"ServiceProductAvailability":{"enum":["available","available_soon","not_available"],"type":"string","description":"Current availability status. Possible values: NULL, available, available_soon, not_available"},"ServiceProductStatus":{"enum":["active","inactive","archived","removed"],"type":"string"},"SalesContext":{"required":["name"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContextName"},"optional":{"type":"boolean","description":"If multiple contexts are defined, they can be set as optional. Otherwise, an assignment\nto the corresponding context entity is mandatory.","default":false},"changeAllowed":{"type":"boolean","description":"Defines whether the site or employee assignment of a service instance can be changed within the\nsubscription period. (Only if the \"location\" or \"employee\" context is configured for this service)","default":false}},"additionalProperties":false,"description":"A context defines which entity (e.g. employee or location) can be assigned to an instance of a product (e.g. during ordering)."},"ContextName":{"enum":["employee","location","client","software","cloud","customer","instance"],"type":"string","description":"Name of the assignment context."}}}}
```

## The SortOrder object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SortOrder":{"enum":["asc","desc"],"type":"string","description":"Order in which the result of a list request is sorted."}}}}
```

## The Supplier object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"Supplier":{"required":["id","self"],"type":"object","properties":{"companyAddress":{"$ref":"#/components/schemas/Address"},"contactName":{"type":"string","description":"The name of the contact person at the supplier.","nullable":true},"contactEmail":{"type":"string","description":"The email address of the contact person at the supplier.","nullable":true},"contactPhone":{"type":"string","description":"The phone number of the contact person at the supplier.","nullable":true},"customerNumber":{"type":"string","description":"Own customer number at the supplier.","nullable":true},"note":{"type":"string","description":"A note for the supplier.","nullable":true},"website":{"type":"string","description":"The website of the supplier.","nullable":true},"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The SupplierList object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SupplierList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Supplier":{"required":["id","self"],"type":"object","properties":{"companyAddress":{"$ref":"#/components/schemas/Address"},"contactName":{"type":"string","description":"The name of the contact person at the supplier.","nullable":true},"contactEmail":{"type":"string","description":"The email address of the contact person at the supplier.","nullable":true},"contactPhone":{"type":"string","description":"The phone number of the contact person at the supplier.","nullable":true},"customerNumber":{"type":"string","description":"Own customer number at the supplier.","nullable":true},"note":{"type":"string","description":"A note for the supplier.","nullable":true},"website":{"type":"string","description":"The website of the supplier.","nullable":true},"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."}}}}
```

## The SupplierReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SupplierReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the supplier.","format":"int64"},"name":{"type":"string","description":"The name of the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The SupplierSortParameter object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"SupplierSortParameter":{"enum":["name"],"type":"string"}}}}
```

## The TargetServiceInstanceReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"TargetServiceInstanceReference":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The id to identify the service instance in the system.","format":"int32"},"service":{"$ref":"#/components/schemas/ServiceProductReference"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MetadataEntry"},"description":"Service instance metadata. Metadata can be used to store dynamic key value paired information on an instance.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the service.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the service."},"category":{"type":"string","description":"The category of the service. Comes from the marketplace ProductDisplayGroup","nullable":true},"ean":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)","nullable":true},"externalId":{"type":"string","description":"Value to identify the service in other systems. E.g. when an other system is the source of this service.","nullable":true},"supplierName":{"type":"string","description":"The supplier for this service product","nullable":true},"previewImageLink":{"type":"string","description":"Link to a small preview image for the product","nullable":true},"type":{"$ref":"#/components/schemas/ServiceProductType"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ServiceProductType":{"enum":["service","addon","foundation_service"],"type":"string","description":"Services can take on different types that define their meaning and process flows within the system."},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"MetadataEntry":{"required":["key","value"],"type":"object","properties":{"key":{"maxLength":150,"minLength":0,"type":"string","description":"Key of the metadata entry."},"value":{"maxLength":500,"minLength":0,"type":"string","description":"The value of the metadata entry."},"scope":{"$ref":"#/components/schemas/ServiceInstanceMetadataScope"}},"additionalProperties":false},"ServiceInstanceMetadataScope":{"enum":["public","internal"],"type":"string","description":"Defines for whom a metadata entry is visible. public: visible to all who have access to the service instance | internal: visible only to the author tenant"}}}}
```

## The UserReference object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false}}}}
```

## The UserRole object

```json
{"openapi":"3.0.4","info":{"title":"Equipme Supplier API","version":"v1"},"components":{"schemas":{"UserRole":{"enum":["administrator","planner","user"],"type":"string","description":"Roles available to be assigned to an employee as a user in Equipme. Options will be extended in the future."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hub.equipme.io/development/api-reference-pro/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.