API docs by Redocly

Aptic API Gateway - Parties (v1.0)

Download OpenAPI specification:Download

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

3rd parties API for Aptic solutions

Parties

Get parties 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 party

Authorizations:
(oauth2apikey)
Request Body schema:

Information about the new 3rd party

partyTypeCode
string or null

Party type code, e.g. BANK

subCode
string or null

Sub type of 3rd party, e.g. NL-BAILIFF

referenceCode
string or null

Party's reference code.

parentPartyUniqueId
string or null

Parent party's unique identifier.

fullName
string or null

Legal name of the party

contactPerson
string or null

Primary contact person

idNumber
string or null

Organisation number

street
string or null

Main address - Street

houseNo
string or null

Main address - House number

houseNoExtension
string or null

Main address - House number extension

city
string or null

Main address - City

zipCode
string or null

Main address - ZipCode

stateCode
string or null

Main address - State code

countryCode
string or null

Main address - Country code

companyPhone
string or null

Client company PBX phone number

cellularPhone
string or null

Client contact person cellular phone

email
string or null

Party organisation email

webPage
string or null

Party organisation web page

vatNumber
string or null

VAT number

vatRate
number or null <double>

VAT rate

municipalCode
string or null

Municipal code

naceCode
string or null

NACE code

leiNumber
string or null

LEI number

glnNumber
string or null

GLN number

languageCode
string or null

Perferred language code

currencyCode
string or null

Party currency code

active
boolean or null

Party is active

companyType
integer or null <int32>

Company type

1 = SE, Stat, landsting eller kommun

2 = SE, Aktiebolag

3 = SE, Ekonomisk förening

4 = SE, Stiftelse eller ideell förening

5 = SE, Handelsbolag, kommanditbolag

6 = GB, Limited company

7 = GB, Public limited company

8 = FI, Yksityinen elinkeinonharjoittaja

9 = FI, Kommandiittiyhtiö (KY)

10 = FI, Avoin yhtiö

11 = FI, Osakeyhtiö (OY, Oyj)

12 = FI, Osuuskunta (Osk.)

13 = FI, Rekisteröity yhdistys (Ry)

14 = NL, Eenmanszaak

15 = NL, Besloten Vennootschap

16 = NL, Naamloze Vennootschap

17 = NL, Maatschap

18 = NL, Vennootschap onder Firma

19 = NL, Commanditaire Vennootschap

20 = NL, Vereniging met volledige rechtsbevoegdheid

21 = NL, Vereniging mt beperkte volledige rechtsbevoegdheid

22 = NL, Cooperatieve/ Onderlinge waarborgmaatschappij

23 = NL, Stichting

24 = NL, Kerkgenootschap

25 = NL, Vereniging van eigenaars

26 = NL, Overheid

27 = NL, Buitenlandse vennootschap

28 = FI, Säätiö

29 = FI, Asunto-Osakeyhtiö

30 = FI, Kiinteistöosakeyhtiö

defaultCultureCode
string or null

Party's preferred culture code

countryCodeOfOperation
string or null

Country where the party is operational

Responses

Request samples

Content type
{
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "referenceCode": "string",
  • "parentPartyUniqueId": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "idNumber": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string"
}

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "referenceCode": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Get party details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

The unique GUID of the 3rd party

Responses

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyTypeCode": "string",
  • "subCode": "string",
  • "referenceCode": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "zipCode": "string",
  • "stateCode": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "languageCode": "string",
  • "currencyCode": "string",
  • "active": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string",
  • "addresses": [
    ],
  • "links": [
    ]
}

Updates a party

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

The unique GUID of the 3rd party

Request Body schema:

Updated information of the 3rd party

referenceCode
string or null

Party's reference code.

fullName
string or null

Legal name of the party

contactPerson
string or null

Primary contact person

idNumber
string or null

Organisation number

companyPhone
string or null

Party organisation PBX phone number

cellularPhone
string or null

Party contact person cellular phone

email
string or null

Party organisation email

webPage
string or null

Party organisation web page

vatNumber
string or null

VAT number

vatRate
number or null <double>

VAT rate

municipalCode
string or null

Municipal code

naceCode
string or null

NACE code

leiNumber
string or null

LEI number

glnNumber
string or null

GLN number

languageCode
string or null

Perferred language code

active
boolean or null

Party is active

companyType
integer or null <int32>

Company type

1 = SE, Stat, landsting eller kommun

2 = SE, Aktiebolag

3 = SE, Ekonomisk förening

4 = SE, Stiftelse eller ideell förening

5 = SE, Handelsbolag, kommanditbolag

6 = GB, Limited company

7 = GB, Public limited company

8 = FI, Yksityinen elinkeinonharjoittaja

9 = FI, Kommandiittiyhtiö (KY)

10 = FI, Avoin yhtiö

11 = FI, Osakeyhtiö (OY, Oyj)

12 = FI, Osuuskunta (Osk.)

13 = FI, Rekisteröity yhdistys (Ry)

14 = NL, Eenmanszaak

15 = NL, Besloten Vennootschap

16 = NL, Naamloze Vennootschap

17 = NL, Maatschap

18 = NL, Vennootschap onder Firma

19 = NL, Commanditaire Vennootschap

20 = NL, Vereniging met volledige rechtsbevoegdheid

21 = NL, Vereniging mt beperkte volledige rechtsbevoegdheid

22 = NL, Cooperatieve/ Onderlinge waarborgmaatschappij

23 = NL, Stichting

24 = NL, Kerkgenootschap

25 = NL, Vereniging van eigenaars

26 = NL, Overheid

27 = NL, Buitenlandse vennootschap

28 = FI, Säätiö

29 = FI, Asunto-Osakeyhtiö

30 = FI, Kiinteistöosakeyhtiö

defaultCultureCode
string or null

Party's preferred culture code

countryCodeOfOperation
string or null

Country where the party is operational

Responses

Request samples

Content type
{
  • "referenceCode": "string",
  • "fullName": "string",
  • "contactPerson": "string",
  • "idNumber": "string",
  • "companyPhone": "string",
  • "cellularPhone": "string",
  • "email": "string",
  • "webPage": "string",
  • "vatNumber": "string",
  • "vatRate": 0,
  • "municipalCode": "string",
  • "naceCode": "string",
  • "leiNumber": "string",
  • "glnNumber": "string",
  • "languageCode": "string",
  • "active": true,
  • "companyType": 0,
  • "defaultCultureCode": "string",
  • "countryCodeOfOperation": "string"
}

Response samples

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

Deletes a party

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

The unique GUID of the 3rd party

Responses

Response samples

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

Get party bank accounts using filters

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Client guid

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 party bank account

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Party guid

Request Body schema:

Bank account

bankaccountNo
string or null

Bank account number.

description
string or null

Short description to identifiy the bank account.

bankaccountClass
integer or null <int32>

Bank account class. Can be used in export files to determine layout.

0 = Unknown.

1 = Plusgiro (Sweden).

2 = Bankgiro (Sweden).

3 = Bank account (Netherlands).

4 = Foreign bank account

5 = Bankgiro (Denmark)

7 = Bankgiro (Norway)

8 = Bankaccount (Norway)

9 = Bankaccount(Sweden)

10 = Bank account (Finland)

ownerType
integer <int32>

To who does the bank account belong.

1 = Solicitor (internal)

2 = Creditor (external)

3 = Debtor (external)

4 = Shared (external with creditor account settlement)

internalCode
string or null

Internal code of the bank account.

priority
integer or null <int32>

Priority when multiple bank accounts are suitable.

agreementNo
string or null

Agreement number of the bank account.

bankCode
string or null

Code identifying the bank holding the bank account.

bankDescription
string or null

Name or description of the bank holding the bank account.

countryCode
string or null

Country code of the bank holding the bank account.

zipCode
string or null

Postal zip code to the bank holding the bank account.

city
string or null

City where the bank is holding the bank account.

allowPayments
integer or null <int32>

Is the bank account available for payments or nettings?

0 = No

1 = Payments

2 = Nettings

allowDisbursementsFrom
boolean or null

Is it allowed to disburse from the bank account?

allowDisbursementsTo
boolean or null

Is it allowed to disburse to the bank account?

businessAccount
boolean or null

Is this the business account?

thirdPartyRemittance
boolean or null

Is this account used for 3rd party remittences, like from the bailiff?

powerOfAttorney
boolean or null

Do we have a power of attorney agreement on this bank account?

currencyCode
string or null

Currency code the bank account.

iban
string or null

IBAN number of the bank account.

bic
string or null

BIC code of the bank holding the bank account.

blz
string or null

BLZ number of the bank account.

swift
string or null

Swift number of the bank account.

Responses

Request samples

Content type
{
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string"
}

Response samples

Content type
{
  • "bankaccountGuid": "string",
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "accountBalance": 0,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string",
  • "links": [
    ]
}

Get party bank account based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

The unique GUID of the party

bankaccountGuid
required
string

The unique GUID of the bank account

Responses

Response samples

Content type
{
  • "bankaccountGuid": "string",
  • "bankaccountNo": "string",
  • "description": "string",
  • "bankaccountClass": 0,
  • "ownerType": 0,
  • "internalCode": "string",
  • "priority": 0,
  • "agreementNo": "string",
  • "bankCode": "string",
  • "bankDescription": "string",
  • "countryCode": "string",
  • "zipCode": "string",
  • "city": "string",
  • "allowPayments": 0,
  • "allowDisbursementsFrom": true,
  • "allowDisbursementsTo": true,
  • "businessAccount": true,
  • "thirdPartyRemittance": true,
  • "powerOfAttorney": true,
  • "currencyCode": "string",
  • "accountBalance": 0,
  • "iban": "string",
  • "bic": "string",
  • "blz": "string",
  • "swift": "string",
  • "links": [
    ]
}

Get party extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Client guid

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 party extra field

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Party guid

Request Body schema:

Extra field value

name
string or null

Name of Extra field data

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Get party extra field details based on the unique GUID and extra field name

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

The unique GUID of the party

name
required
string

The name of the extra field

Responses

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Updates a party extra field

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Party guid

name
required
string

Extrafield name

Request Body schema:

Extrafield value

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Deletes a party extra field

Authorizations:
(oauth2apikey)
path Parameters
partyGuid
required
string

Party guid

name
required
string

Extrafield name

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
partyGuid
required
string

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