getServiceItems

post https://rz3.aeb.de/demo1billing/rest/BillingBFBean/getServiceItems

Returns all service items for the given client.

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

getSettlementItems

boolean

Also retrieve the settlement items of the service item. If this value is empty, it will be interpreted as false.

items

array of objects

An array of items that should be retrieved.

items

Response

Response body

object

hasErrors

boolean

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

hasOnlyRetryableErrors

boolean

True, if there are any error messages.

Error details are provided in the messages[] array.

hasWarnings

boolean

True, if there are any error messages.

Error details are provided in the messages[] array.

messages

array of objects

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

messages

object

messageType

string

Message type

If not stated otherwise, the possible types are:

ERROR
WARNING
INFO

Maximum length: 50

messageIdentCode

string

Optional identification code for further classification of the message type.

Maximum length: 50

messageTexts

array of objects

Detailed message texts in the requested languages.

messageTexts

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

indentationLevel

int32

The indentation level of the message.

'0' indicates a top level message.

itemResults

array of objects

For every item in the request there will be one BServiceItemResultDTO in this array,in the same order as in the request.

itemResults

object

hasErrors

boolean

True, if there are any error messages. If an error has occured the messages contain more details about the errors.

hasWarnings

boolean

True, if there are any warning messages.

messages

array of objects

Messages for the whole request, e.g. for errors or warnings.

messages

object

messageType

string

Message type

If not stated otherwise, the possible types are:

ERROR
WARNING
INFO

Maximum length: 50

messageIdentCode

string

Optional identification code for further classification of the message type.

Maximum length: 50

messageTexts

array of objects

Detailed message texts in the requested languages.

messageTexts

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

indentationLevel

int32

The indentation level of the message.

'0' indicates a top level message.

itemId

string

ID of the item.

length=50

statusIdentCode

string

Status of the item after save and optional operations

length=10

clientPrice

object

An amount of money with a value and an currency ISO code.

vatRatePercent

number

The VAT rate in percent of the client price of the service item

settlementItems

array of objects

--IBillingBF#createServiceItems--
This variable is only filled, if pricing is done.
For every settlement item created (or simulated) for a service item there will be one element in this array.

--IBillingBF#getServiceItems--
This variable is filled if the service item was found and the settlement items should be retrieved. Otherwise, the variable is filled. The array is empty if the service item has no settlement items.

settlementItems

object

settlementItemId

string

The unique id of the settlement item. This id can be used in an application facade to open the settlement item.

length=50

settlementNumber

string

The number of the settlement, this settlement item was disposed to.
(Only filled, if settlements were created, see BCreateServiceItemParmsDTO#createSettlementsImmediately).

length=50

settlementId

string

The unique id of the settlement, this settlement item was disposed to. This id can be used in an application facade to open the settlement.
(Only filled, if settlements were created, see BCreateServiceItemParmsDTO#createSettlementsImmediately).

descriptions

array of objects

The descriptions of the settlement item in requested languages.

descriptions

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

priceType

object

Information about a price type in a response.

price

object

An amount of money with a value and an currency ISO code.

settlementPrice

object

An amount of money with a value and an currency ISO code.

clientPrice

object

An amount of money with a value and an currency ISO code.

numberInServiceItem

int32

Settlement item number
Sequential settlement item number within a service item usually starting with 1 for the first settlement item of a service item.

chargeableQuantity

object

Quantities for Billing.

calcGenericIdentCode

string

Ident code of the calculation type used for price calculation of the item.

referenceDate

date-time

Reference date used as the main search criterion in the service item search. The interface generally assigns an "appropriate" reference date. Which date from the business environment is used as the reference date in Logistics Cost Management (order date, service date, document date, etc.) depends on the business processes and the primary application.

referenceNumber

string

Reference number used as the main search criterion in the service item search. The interface generally assigns an 'appropriate' reference number. Which number from the business environment is used as the reference number in Logistics Cost Management (order number, customer order number, document number, etc.) depends on the business processes and the primary application.

orderNumber

string

Order number of service item.

serviceIdentCode

string

Ident code of the service type of the service item.

description

string

Description of service item.

orderer

object

A complete address of a company for Logistics Cost Management.

serviceProvider

object

A complete address of a company for Logistics Cost Management.

payer

object

A complete address of a company for Logistics Cost Management.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://rz3.aeb.de/demo1billing/rest/BillingBFBean/getServiceItems \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultdefault response