API docs by Redocly

Aptic API Gateway - Contracts (v1.0)

Download OpenAPI specification:

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

Contracts related API for Aptic solutions

Contracts

Get contracts 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 contract

Authorizations:
(oauth2apikey)
Request Body schema:

register contract information

contractGuid
string or null

Unique identifier for the contract

contractNumber
string or null

Contract number

mainCustomerGuid
string or null

Customer Guid

partyGuid
string or null

Party Guid

categoryCode
string or null

Contract category code

contractStatus
integer <int32>
Enum: 0 1 2 3 4 5

Contract status

Possible values:
0 = Waiting for signature.
1 = Contract is abandoned.
2 = Contract is rejected.
3 = Contract is active.
4 = Contract has been extended.
5 = Contract is terminated.

startDate
string or null <date-time>

Start date

endDate
string or null <date-time>

End date

terminationDate
string or null <date-time>

Termination date

description
string or null

Description

clientReference
string or null

Client reference.

vendorGuid
string or null

Vendor Guid.

vendorReference
string or null

Vendor reference.

Responses

Request samples

Content type
{
  • "contractGuid": "string",
  • "contractNumber": "string",
  • "mainCustomerGuid": "string",
  • "partyGuid": "string",
  • "categoryCode": "string",
  • "contractStatus": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "clientReference": "string",
  • "vendorGuid": "string",
  • "vendorReference": "string"
}

Response samples

Content type
{
  • "contractGuid": "string",
  • "contractNumber": "string",
  • "mainCustomerGuid": "string",
  • "partyGuid": "string",
  • "categoryCode": "string",
  • "contractStatus": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "links": [
    ]
}

Get contract details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
contractGuid
required
string

The unique GUID of the contract

Responses

Response samples

Content type
{
  • "contractGuid": "string",
  • "contractNumber": "string",
  • "mainCustomerGuid": "string",
  • "partyGuid": "string",
  • "categoryCode": "string",
  • "contractStatus": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "links": [
    ]
}

Update contract

Authorizations:
(oauth2apikey)
path Parameters
contractGuid
required
string

The unique GUID of the contract

Request Body schema:

Contract detail information

contractNumber
string or null

Contract number

categoryCode
string or null

Contract category code

contractStatus
integer <int32>
Enum: 0 1 2 3 4 5

Contract status

Possible values:
0 = Waiting for signature.
1 = Contract is abandoned.
2 = Contract is rejected.
3 = Contract is active.
4 = Contract has been extended.
5 = Contract is terminated.

startDate
string or null <date-time>

Start date

endDate
string or null <date-time>

End date

terminationDate
string or null <date-time>

Termination date

description
string or null

Description

vendorGuid
string or null

Vendor Guid.

vendorReference
string or null

Vendor reference.

Responses

Request samples

Content type
{
  • "contractNumber": "string",
  • "categoryCode": "string",
  • "contractStatus": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "vendorGuid": "string",
  • "vendorReference": "string"
}

Response samples

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

Deletes a contract if it is not used yet

Authorizations:
(oauth2apikey)
path Parameters
contractGuid
required
string

Responses

Response samples

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

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
{ }