API docs by Redocly

Aptic API Gateway - Objects (v1.0)

Download OpenAPI specification:

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Object and asset related API for Aptic solutions

Objects

Get objects using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new object

Authorizations:
(oauth2apikey)
Request Body schema:
objectCode
string or null

Object code.

objectReference
string or null

Object reference number.

active
boolean or null

Object is active

regDate
string or null <date-time>

Registration date

itemCount
integer or null <int32>

Item count, if used for the object

description
string or null

Object description.

registrationNumber
string or null

Object registration number.

yearOfManufacture
integer or null <int32>

Year of manufactore

mileage
integer or null <int32>

Milage or custom consumption value

currencyCode
string or null

Currency code of all amounts for the object

originalValue
number or null <double>

Original value of the object

currentValue
number or null <double>

Current valuation of the object

residualValue
number or null <double>

Residual value of the object

buyoutAmount
number or null <double>

Possible buyout amount calculated for the object

bookValue
number or null <double>

Remaining asset value in general ledger.

invoiceAmount
number or null <double>

Expected amount on the purchase invoice for the object, if applicable. Amount excluding VAT.

purchaseOrder
string or null

Purchase order number for the asset, if applicable.

validUntil
string or null <date-time>

Date until the object is valid, if limited life time

owner
string or null

Actual owner of the object

vendor
string or null

Vendor of the object

supplier
string or null

Supplier of the asset

inventoryStatus
integer or null <int32>

Inventory status of the object, if applicable

1 = At customer

2 = At supplier

3 = At 3rd party

4 = Ongoing repossession

5 = Our inventory

6 = Sold to customer

7 = Sold to supplier

8 = Sold to 3rd party

9 = Ongoing forced sale

10 = Discarded

11 = Transferred

location
string or null

Coordinates to the location of the object

leaseBaseAmount
number or null <double>

Leasing base amount for the object

vatCode
string or null

VAT code for the object

vatTypeId
integer or null <int32>

VAT type identifier for the object

rentalAmount
number or null <double>

Rental amount for the object

vatRate
number or null <double>

VAT rate for the object

objectGuid
string or null

Optional pre-existing object guid

object (PutAddress)

Changeable address values

object (PutObjectDepreciation)

Object depreciation

data
any or null

Additional object specific data

Responses

Request samples

Content type
{
  • "objectCode": "string",
  • "objectReference": "string",
  • "active": true,
  • "regDate": "2019-08-24T14:15:22Z",
  • "itemCount": 0,
  • "description": "string",
  • "registrationNumber": "string",
  • "yearOfManufacture": 0,
  • "mileage": 0,
  • "currencyCode": "string",
  • "originalValue": 0.1,
  • "currentValue": 0.1,
  • "residualValue": 0.1,
  • "buyoutAmount": 0.1,
  • "bookValue": 0.1,
  • "invoiceAmount": 0.1,
  • "purchaseOrder": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "owner": "string",
  • "vendor": "string",
  • "supplier": "string",
  • "inventoryStatus": 0,
  • "location": "string",
  • "leaseBaseAmount": 0.1,
  • "vatCode": "string",
  • "vatTypeId": 0,
  • "rentalAmount": 0.1,
  • "vatRate": 0.1,
  • "objectGuid": "string",
  • "address": {
    },
  • "depreciation": {
    },
  • "data": null
}

Response samples

Content type
{
  • "objectGuid": "string",
  • "objectCode": "string",
  • "objectReference": "string",
  • "active": true,
  • "regDate": "2019-08-24T14:15:22Z",
  • "isAsset": true,
  • "itemCount": 0,
  • "description": "string",
  • "registrationNumber": "string",
  • "yearOfManufacture": 0,
  • "mileage": 0,
  • "currencyCode": "string",
  • "originalValue": 0.1,
  • "currentValue": 0.1,
  • "residualValue": 0.1,
  • "buyoutAmount": 0.1,
  • "bookValue": 0.1,
  • "invoiceAmount": 0.1,
  • "purchaseOrder": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "owner": "string",
  • "vendor": "string",
  • "supplier": "string",
  • "inventoryStatus": 0,
  • "location": "string",
  • "leaseBaseAmount": 0.1,
  • "vatCode": "string",
  • "vatTypeId": 0,
  • "vatRate": 0.1,
  • "depreciation": {
    },
  • "data": null,
  • "links": [
    ]
}

Get object details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the object.

Responses

Response samples

Content type
{
  • "objectGuid": "string",
  • "objectCode": "string",
  • "objectReference": "string",
  • "active": true,
  • "regDate": "2019-08-24T14:15:22Z",
  • "isAsset": true,
  • "itemCount": 0,
  • "description": "string",
  • "registrationNumber": "string",
  • "yearOfManufacture": 0,
  • "mileage": 0,
  • "currencyCode": "string",
  • "originalValue": 0.1,
  • "currentValue": 0.1,
  • "residualValue": 0.1,
  • "buyoutAmount": 0.1,
  • "bookValue": 0.1,
  • "invoiceAmount": 0.1,
  • "purchaseOrder": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "owner": "string",
  • "vendor": "string",
  • "supplier": "string",
  • "inventoryStatus": 0,
  • "location": "string",
  • "leaseBaseAmount": 0.1,
  • "vatCode": "string",
  • "vatTypeId": 0,
  • "vatRate": 0.1,
  • "depreciation": {
    },
  • "data": null,
  • "links": [
    ]
}

Updates an object

Authorizations:
(oauth2apikey)
path Parameters
objectGuid
required
string
Request Body schema:
objectReference
string or null

Object reference number.

active
boolean or null

Object is active

itemCount
integer or null <int32>

Item count, if used for the object

description
string or null

Object description.

registrationNumber
string or null

Object registration number.

yearOfManufacture
integer or null <int32>

Year of manufactore

mileage
integer or null <int32>

Milage or custom consumption value

currencyCode
string or null

Currency code of all amounts for the object

originalValue
number or null <double>

Original value of the object

currentValue
number or null <double>

Current valuation of the object

residualValue
number or null <double>

Residual value of the object

buyoutAmount
number or null <double>

Possible buyout amount calculated for the object

bookValue
number or null <double>

Remaining asset value in general ledger.

invoiceAmount
number or null <double>

Expected amount on the purchase invoice for the object, if applicable. Amount excluding VAT.

purchaseOrder
string or null

Purchase order number for the asset, if applicable.

validUntil
string or null <date-time>

Date until the object is valid, if limited life time

vendor
string or null

Vendor of the object

supplier
string or null

Supplier of the asset

inventoryStatus
integer or null <int32>

Inventory status of the object, if applicable

1 = At customer

2 = At supplier

3 = At 3rd party

4 = Ongoing repossession

5 = Our inventory

6 = Sold to customer

7 = Sold to supplier

8 = Sold to 3rd party

9 = Ongoing forced sale

10 = Discarded

11 = Transferred

location
string or null

Coordinates to the location of the object

leaseBaseAmount
number or null <double>

Leasing base amount for the object

rentalAmount
number or null <double>

Rental amount for the object

vatCode
string or null

VAT code for the object

vatTypeId
integer or null <int32>

VAT type identifier for the object

vatRate
number or null <double>

VAT rate for the object

object (PutAddress)

Changeable address values

object (PatchObjectDepreciation)

Object depreciation

data
any or null

Additional object specific data

Responses

Request samples

Content type
{
  • "objectReference": "string",
  • "active": true,
  • "itemCount": 0,
  • "description": "string",
  • "registrationNumber": "string",
  • "yearOfManufacture": 0,
  • "mileage": 0,
  • "currencyCode": "string",
  • "originalValue": 0.1,
  • "currentValue": 0.1,
  • "residualValue": 0.1,
  • "buyoutAmount": 0.1,
  • "bookValue": 0.1,
  • "invoiceAmount": 0.1,
  • "purchaseOrder": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "vendor": "string",
  • "supplier": "string",
  • "inventoryStatus": 0,
  • "location": "string",
  • "leaseBaseAmount": 0.1,
  • "rentalAmount": 0.1,
  • "vatCode": "string",
  • "vatTypeId": 0,
  • "vatRate": 0.1,
  • "address": {
    },
  • "depreciation": {
    },
  • "data": null
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes an object

Authorizations:
(oauth2apikey)
path Parameters
objectGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
objectGuid
required
string

Object unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }