Configurations

Create fetch configuration

Create a new fetch configuration for the current user.

SecurityapiKey
Request
Request Body schema: application/json
required
object (FetchConfigurationModel)

Configuration for fetching Business Partners.

name
required
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
Responses
200

Configuration created successfully

400

Bad Request.

post/configurations/businesspartnerfetch
Request samples
application/json
{
  • "name": "Client configuration.",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

Delete fetch configuration

Delete a fetch configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Responses
200

OK.

400

Bad Request.

delete/configurations/businesspartnerfetch/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

Delete Lookup Configuration

Delete a lookup configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Responses
200

OK.

400

Bad Request.

delete/configurations/businesspartnerlookup/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

List fetch configurations

List all fetch configurations of the current user.

SecurityapiKey
Request
query Parameters
limit
integer (Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100
startAfter
string (StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652
Responses
200

Successful operation

get/configurations/businesspartnerfetch
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}

List lookup configurations

List all lookup configurations of the current user.

SecurityapiKey
Request
query Parameters
limit
integer (Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100
startAfter
string (StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652
Responses
200

Successful operation

get/configurations/businesspartnerlookup
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}

Read fetch configuration

Read a fetch configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Responses
200

Successful operation

get/configurations/businesspartnerfetch/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

Read Lookup Configuration

Read a lookup configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Responses
200

Successful operation

get/configurations/businesspartnerlookup/{configurationId}
Request samples
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

Update fetch configuration

Update a fetch configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Request Body schema: application/json
object (FetchConfigurationModel)

Configuration for fetching Business Partners.

name
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
Responses
200

Configuration updated successful

400

Bad Request.

put/configurations/businesspartnerfetch/{configurationId}
Request samples
application/json
{
  • "name": "Client configuration.",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}

Update Lookup Configuration

Update a lookup configuration of the current user.

SecurityapiKey
Request
path Parameters
configurationId
required
string

ID of the configuration to read.

Example: 5f7b1b3e3b1865f7b1b3e3b1
Request Body schema: application/json
object (LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

name
string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
Responses
200

Configuration updated successful

400

Bad Request.

put/configurations/businesspartnerlookup/{configurationId}
Request samples
application/json
{
  • "name": "Client configuration.",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "name": "Client configuration.",
  • "configuration": {
    },
  • "createdAt": "2024-07-11T07:22:27Z",
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444"
}