Retrieve an available BP information

GET 
/api/info

This endpoint is tailored to retrieve the available BP (business partner) information.

Request

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

id integer
legalForm stringnullable
countryOfIncorporation stringnullable
address stringnullable
city stringnullable
zip stringnullable
stateOrProvince stringnullable
activePackage integer
availableBalance object
currency stringnullable
amount string

Example (from schema)

{
  "id": 1,
  "legalForm": "public limited company",
  "countryOfIncorporation": "CH",
  "address": "Baslerstrasse 60",
  "city": "Zürich",
  "zip": "8048",
  "stateOrProvince": "Canton of Zürich",
  "activePackage": 1,
  "availableBalance": {
    "currency": "string",
    "amount": "string"
  }
}

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

403

Forbidden -- Access to the requested resource or action is forbidden.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

404

Not Found -- The requested resource could not be found.

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 400,
  "instance": "string",
  "type": "string"
}

Loading...