Services

AccountListingScriptingService

Description

Service zur Verarbeitung von Account-Listings in Skripten

Methods

create

Persistiert ein DTO

Return type: AccountListing

Datatype	Name	Description	Required
AccountListing	toCreate	Das zu persistierende DTO	Yes

deleteById

Löscht eine Entity

Datatype	Name	Description	Required
number	id	ID der zu löschenden Entity	Yes

getNewDto

Erstellt eine neue DTO-Instanz

Return type: AccountListing

readAllById

Liest eine Liste von DTOs

Return type: Array<AccountListing>

Datatype	Name	Description	Required
Array	ids	Die Liste der gelesenen DTOs	Yes

readById

Liest ein DTO

Return type: AccountListing

Datatype	Name	Description	Required
number	id	ID vom zu lesenden DTO	Yes

store

Persistiert eine DTO

Return type: AccountListing

Datatype	Name	Description	Required
AccountListing	toStore	Das zu persistierende DTO	Yes

update

Aktualisiert ein persistiertes DTO

Return type: AccountListing

Datatype	Name	Description	Required
AccountListing	toUpdate	Die zu aktualisierende Entity	Yes

AccountScriptingService

Description

Service zur Verarbeitung von Accounts

Methods

activate

Aktiviert ein DTO

Return type: Account

Datatype	Name	Description	Required
number	idToActivate	ID vom zu aktivierenden DTO	Yes

create

Persistiert ein DTO

Return type: Account

Datatype	Name	Description	Required
Account	toCreate	Das zu persistierende DTO	Yes

createAddress

Erstellt eine Adresse

Return type: AccountAddress

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountAddress	address	Die zu erstellende Adresse	Yes

createBankdetail

Erstellt ein Bankdetail

Return type: AccountBankdetail

Datatype	Name	Description	Required
number	accountId	ID des Accounts	Yes
AccountBankdetail	bankdetail	anzulegendes Bankdetails	Yes

createPerson

Erstellt einen Ansprechpartner

Return type: AccountPerson

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountPerson	person	Der zu erstellende Ansprechpartner	Yes

createRelation

Erstellt eine Adressbeziehung

Return type: AccountRelation

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountRelation	relation	Die zu erstellende Adressbeziehung	Yes

deactivate

Deaktiviert ein DTO

Return type: Account

Datatype	Name	Description	Required
number	idToDeactivate	ID vom zu deaktivierenden DTO	Yes

deleteAddress

Löscht eine Adresse

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	addressId	ID einer Adresse	Yes

deleteBankdetail

Löscht ein Bankdetail

Datatype	Name	Description	Required
number	accountId	ID des Accounts	Yes
number	bankdetailId	ID des Bankdetails	Yes

deleteById

Löscht eine Entity

Datatype	Name	Description	Required
number	id	ID der zu löschenden Entity	Yes

deletePerson

Löscht einen Ansprechpartner

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	personId	ID eines Ansprechpartners	Yes

deleteRelation

Löscht eine Adressbeziehung

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	relationId	ID einer Adressbeziehung	Yes

getAddress

Liest eine Adresse

Return type: AccountAddress

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	addressId	ID einer Adresse	Yes

getAddresses

Liefert die Adressen eines Accounts (sortiert)

Return type: Array<AccountAddress>

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes

getBankdetail

Liest ein Bankdetail

Return type: AccountBankdetail

Datatype	Name	Description	Required
number	accountId	ID des Accounts	Yes
number	bankdetailId	ID eines Bankdetails	Yes

getBankdetails

Liefert die Bankdetails eines Accounts

Return type: Array<AccountBankdetail>

Datatype	Name	Description	Required
number	accountId	ID des Accounts	Yes

getNewDto

Erstellt eine neue DTO-Instanz

Return type: Account

getPerson

Liest einen Ansprechpartner

Return type: AccountPerson

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	personId	ID eines Ansprechpartners	Yes

getPersons

Liefert die Ansprechpartner eines Accounts (sortiert)

Return type: Array<AccountPerson>

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes

getRelation

Liest eine Adressbeziehung

Return type: AccountRelation

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
number	relationId	ID einer Adressbeziehung	Yes

getRelations

Liefert die Adressbeziehungen eines Accounts

Return type: Array<AccountRelation>

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes

readAllById

Liest eine Liste von DTOs

Return type: Array<Account>

Datatype	Name	Description	Required
Array	ids	Die Liste der gelesenen DTOs	Yes

readById

Liest ein DTO

Return type: Account

Datatype	Name	Description	Required
number	id	ID vom zu lesenden DTO	Yes

sendNotification

Schreibt eine Benachrichtigung auf Basis des Accounts

Datatype	Name	Description	Required
number	accountId		No
ScriptOutputRequest	outputRequest		No

store

Persistiert eine DTO

Return type: Account

Datatype	Name	Description	Required
Account	toStore	Das zu persistierende DTO	Yes

update

Aktualisiert ein persistiertes DTO

Return type: Account

Datatype	Name	Description	Required
Account	toUpdate	Die zu aktualisierende Entity	Yes

updateAddress

Aktualisiert eine Adresse

Return type: AccountAddress

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountAddress	address	Die zu aktualisierende Adresse	Yes

updateBankdetail

Aktualisiert ein Bankdetail

Return type: AccountBankdetail

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountBankdetail	bankdetail	zu aktualisierendes Bankdetail	Yes

updatePerson

Aktualisiert einen Ansprechpartner

Return type: AccountPerson

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountPerson	person	Der zu aktualisierende Ansprechpartner	Yes

updateRelation

Aktualisiert eine Adressbeziehung

Return type: AccountRelation

Datatype	Name	Description	Required
number	accountId	ID eines Accounts	Yes
AccountRelation	relation	Die zu aktualisierende Adressbeziehung	Yes

ArticleCustomerScriptingService

Description

Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten

Methods

activate

Aktiviert ein DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
number	idToActivate	ID vom zu aktivierenden DTO	Yes

create

Persistiert ein DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
ArticleCustomer	toCreate	Das zu persistierende DTO	Yes

deactivate

Deaktiviert ein DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
number	idToDeactivate	ID vom zu deaktivierenden DTO	Yes

deleteById

Löscht eine Entity

Datatype	Name	Description	Required
number	id	ID der zu löschenden Entity	Yes

getNewDto

Erstellt eine neue DTO-Instanz

Return type: ArticleCustomer

readAllById

Liest eine Liste von DTOs

Return type: Array<ArticleCustomer>

Datatype	Name	Description	Required
Array	ids	Die Liste der gelesenen DTOs	Yes

readById

Liest ein DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
number	id	ID vom zu lesenden DTO	Yes

store

Persistiert eine DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
ArticleCustomer	toStore	Das zu persistierende DTO	Yes

update

Aktualisiert ein persistiertes DTO

Return type: ArticleCustomer

Datatype	Name	Description	Required
ArticleCustomer	toUpdate	Die zu aktualisierende Entity	Yes

ArticleListingScriptingService

Description

Service zur Verarbeitung von Artikel-Listings im Skripten

Methods

create

Erstellt ein Listing

Return type: ArticleListing

Datatype	Name	Description	Required
number	articleId	ID des Artikels	Yes
ArticleListing	articleListing	Zu erstellendes Listing	Yes
string	languageCode	Zu verwendende Sprache	Yes

deleteById

Löscht eine Entity

Datatype	Name	Description	Required
number	id	ID der zu löschenden Entity	Yes

getNewDto

Erstellt eine neue ArticleListing-Instanz

Return type: ArticleListing

readAllByArticleId

Liest alle Listings zu einem Artikel

Return type: Array<ArticleListing>

Datatype	Name	Description	Required
number	articleId	ID des Artikels	Yes

readAllByArticleId

Liest alle Listings zu einem Artikel mit Texten zur Sprache languageCode

Return type: Array<ArticleListing>

Datatype	Name	Description	Required
number	articleId	ID des Artikels	Yes
string	languageCode	Zu verwendende Sprache	Yes

readAllById

Liest eine Liste von DTOs

Return type: Array<ArticleListing>

Datatype	Name	Description	Required
Array	ids	Die Liste der gelesenen DTOs	Yes

readById

Liest ein DTO

Return type: ArticleListing

Datatype	Name	Description	Required
number	id	ID vom zu lesenden DTO	Yes

readById

Liest ein Artikel-Listing mit Texten zur Sprache languageCode

Return type: ArticleListing

Datatype	Name	Description	Required
number	listingId	ID des zu lesenden Listings	Yes
string	languageCode	Zu verwendende Sprache	Yes

update

Akutalisiert ein Listing

Return type: ArticleListing

Datatype	Name	Description	Required
number	listingId	ID des Listings	Yes
ArticleListing	articleListing	Zu aktualisierendes Listing	Yes
string	languageCode	Zu verwendende Sprache	Yes

ArticleScriptingService

Description

Service zur Verarbeitung von Artikeln im Skripten

Methods

activate

Aktiviert ein DTO

Return type: Article

Datatype	Name	Description	Required
number	idToActivate	ID vom zu aktivierenden DTO	Yes

addLabelToPrintBatch

Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu

Datatype	Name	Description	Required
string	batchIdentifier	ID des Etikettendrucklaufs	Yes
number	articleId	ID des zu druckenden Artikels	Yes
number	labelCount	Anzahl der zu druckenden Etiketten	Yes

addLabelToPrintBatch

Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu

Datatype	Name	Description	Required
string	batchIdentifier	ID des Etikettendrucklaufs	Yes
number	articleId	ID des zu druckenden Artikels	Yes
number	articleSerialNumberId	ID der zu druckenden Seriennummer	No
number	labelCount	Anzahl der zu druckenden Etiketten	Yes

addLabelToPrintBatch

Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu

Datatype	Name	Description	Required
string	batchIdentifier	ID des Etikettendrucklaufs	Yes
number	articleId	ID des zu druckenden Artikels	Yes

create

Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert

Return type: Article

Datatype	Name	Description	Required
Article	toCreate	Der zu persistierende Artikel	Yes
string	languageCode		Yes

create

Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert

Return type: Article

Datatype	Name	Description	Required
Article	toCreate	Der zu persistierende Artikel	Yes

create

Persistiert einen Haupt-Artikel und die dazugehörigen Gebinde-Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert.

Return type: Article

Datatype	Name	Description	Required
Article	toCreate	Der zu persistierende Artikel	Yes
number	bundleSchemaId	ID des Gebindeschemas, das als Vorlage verwendet werden soll	Yes
boolean	useSameNumberForAllArticles	Gleiche Artikelnummer für alle Gebindeartikel verwenden?	No

deactivate

Deaktiviert ein DTO

Return type: Article

Datatype	Name	Description	Required
number	idToDeactivate	ID vom zu deaktivierenden DTO	Yes

deleteById

Löscht einen Artikel

Datatype	Name	Description	Required
number	articleId	ID des zu löschenden Artikels	Yes

deleteListingById

Löscht ein Listing zu einem Artikel

Datatype	Name	Description	Required
number	articleId	ID des Artikels, zu dem ein Listing gelöscht werden soll	Yes
number	listingId	ID des Listings, welches gelöscht werden soll	Yes

executeLabelPrintBatch

Führt einen Etikettendrucklauf aus

Datatype	Name	Description	Required
string	batchIdentifier	ID des Etikettendrucklaufs	Yes

executeLabelPrintBatch

Führt einen Etikettendrucklauf aus

Datatype	Name	Description	Required
string	batchIdentifier	ID des Etikettendrucklaufs	Yes
string	reportGroupIdentifier	Name einer Etiketten-Report-Gruppe	No

getArticlePurchaseDiscounts

Liefert die Einkaufsrabatte zu einem Artikel

Return type: Array<ProductPrice>

Datatype	Name	Description	Required
number	articleId	ID eines Artikels	Yes

getArticlePurchasePrices

Liefert die Einkaufspreise zu einem Artikel

Return type: Array<ProductPrice>

Datatype	Name	Description	Required
number	articleId	ID eines Artikels	Yes

getArticleSalesDiscounts

Liefert die Verkaufsrabatte zu einem Artikel

Return type: Array<ProductPrice>

Datatype	Name	Description	Required
number	articleId	ID eines Artikels	Yes

getArticleSalesPrices

Liefert die Verkaufspreise zu einem Artikel

Return type: Array<ProductPrice>

Datatype	Name	Description	Required
number	articleId	ID eines Artikels	Yes

getNewDto

Erstellt eine neue Article-Instanz

Return type: Article

newLabelPrintBatchIdentifier

Generiert die ID für einen neuen Etikettendrucklauf

Return type: string

readById

Liest einen Artikel mit Texten zur Sprache der eigenen Adresse

Return type: Article

Datatype	Name	Description	Required
number	id	ID vom zu lesenden Artikel	Yes

readById

Liest einen Artikel mit Texten zur Sprache languageCode

Return type: Article

Datatype	Name	Description	Required
number	id	ID vom zu lesenden Artikel	Yes
string	languageCode	Zu verwendende Sprache	Yes

readByNumber

Liest einen Artikel über die Artikelnummer mit Texten zur Sprache der eigenen Adresse

Return type: Article

Datatype	Name	Description	Required
string	articleNumber	Eine Artikelnummer	Yes

readByNumber

Liest einen Artikel über die Artikelnummer mit Texten zur Sprache {@code languageCode}

Return type: Article

Datatype	Name	Description	Required
string	articleNumber	Eine Artikelnummer	Yes
string	languageCode	Zu verwendende Sprache