Auftrag ändern [ccb by dsb®

Set complementary issues

Erweitert den Abonnement Zyklus um zusätzliche Hefte

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/complementaryIssues-1.0.0
SAP REST: /DO_COMP_ISSUES

URL

POST: /rest/{client}/subscriptions/{orderNumber}

Parameter	Beschreibung
client	Mandantennummer
sp	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
orderNumber	Auftragsnummer
compIssues	Anzahl der zusätzlichen Hefte (mandatory)
extendedChecks	sollen erweiterte Prüfungen im Backend ausgeführt werden? (optional, default: false)
simulation	Fachlich: Prüfung, ob eine Zyklusverlängerung bei einer Reklamation erlaubt ist, ohne diese direkt durchzuführen (optional,true/false default: false)
createLetter	(optional,true/false default: false)

Request Body

Der Request Body enthält die gewählten Issuenummern.

Beispiel Request Body JSON:

{
"ISSUES": 
  [ 
    "0000001234",
    "0000012345"
  ]
}

Element Definitionen

Parameter	Typ/Länge	Beschreibung
Issues	List	Liste mit Issuenummern. (Optional, maximal compIssues Issuenummern dürfen angegeben sein.)

Response

Der Response ist ein Json Dokument mit dem result aus der ccb-suite.

Parameter	Beschreibung
ONSALEDATE	Erstverkaufstag des hinzugefügten Heftes
NEXTDUEDATE	Nächster Fälligkeitstag
ONSALEDATEDESCRIPTION	Heftbeschreibung
ACTCLAIMPENDING	Bevorstehender DD Zyklus

Warenempfänger zu einem Auftrag ändern

BETA Dieser Service ändert zur übergebenen Auftragsnummer den Warenempfänger
Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeBp-1.0.0
Fuba: /DSB/_ISM_E_CHANGE_KUNWE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/changeBp?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandantennummer
orderNumber	C/10	Auftragsnumner
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)

Request Body

Beispiel Request Body JSON:

{
	"bpNumber" : "1111111111",
	"validFrom" : "2020-08-12"
}

Element Definition

Parameter	Typ/Länge	Beschreibung
bpNumber	D/10	Bestehende Geschäftspartnernummer des neuen WE
validFrom	D/10	Datum ab wann der neue WE gültig ist yyyy-mm-dd

++++ Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zusätzliche Meldung
success	true/false

{
"message": "",
"success" : "true"
}

Bezugstyp ändern / Change Mixtype

Dieser Service ändert den Bezugstyp eines Abos.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeMixType-1.0.0
Fuba: /DSB/_ISM_E_BATCHSCHNITTSTELL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/mixtype?sp={sp}&so={so}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
"mixType" : "02",
"issueNumberFrom" : "0004/2020",
"issueNumberTo" : "0011/2020"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
mixType	AN/2	Neuer Bezugstyp(mandatory)
issueNumberFrom	AN/9	Heftnummer, ab der die Änderung gilt
issueNumberTo	AN/9	Heftnummer, bis zu der die Änderung gilt

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zusätzliche Meldung
success	true/false

{
"message": "",
"success" : "true"
}

Änderung externer Daten

Dieser Service ändert externe Daten eines Abos.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeCustOrderData-1.0.0
Fuba: /DSB/_ISM_E_BATCHSCHNITTSTELLE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/changeCustOrderData?sp={sp}&so={so}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
  "custOrderNumber": "398",
  "custOrderDate": "2024-08-04",
  "custOrderType": "123",
  "custOrderNumberAddition": "12"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
custOrderNumber	AN/20	Neue externe Auftragsnummer
custOrderDate	D	Neues externes Auftragsdatum
custOrderType	AN/4	Neuer externer Auftragstyp
custOrderNumberAddition	AN/4	Neuer externer Zusatz zur Auftragsnummer

Alle Felder sind optional. Ein Wert „delete“ löscht das Element.

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zusätzliche Meldung
success	true/false

{
"message": "",
"success" : "true"
}

Preiserhöhung

Dieser Service erhöht den Preis eines Renewal-Abos. !Nur zur internen Verwendung!

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/priceIncrease-1.0.0
SAP REST: /DO_PRICE_INCREASE

URL

POST: /rest/{client}/subscriptions/{orderNumber}/priceIncrease?sp={sp}&bookImmediately={bookImmediately}&showErrorDialog={showErrorDialog}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))
bookImmediately	bool	sofort verbuchen? (Default: true)
showErrorDialog	bool	Fehlerdialog anzeigen? (Default: true)

Request Body

Der Body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

1. Preiserhöhung

{
   "increaseToClaim": 1,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ]
}

2. Preiserhöhung Bundle mit zwei Slaves. Auslösen des Briefs 0251. Außerdem wird der Wert der DD_SAV & DD_BAS Attribute von außen bestimmt.

{
   "increaseToClaim": 5,
   "totalPrice":20.50,
   "term":"06",
   "letterNumber":"0251",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      4.50,
      6.50,
      0.00
   ],
   "attributes":[ 
     {
       "code": "DD_SAV",  
       "value": 20.0     
     },
     {
       "code": "DD_BAS",  
       "value": 25.0     
     }
   ]
}

3. Preiserhöhung rückgängig machen

{
   "increaseToClaim": 0,
   "totalPrice": 0,
   "term":"",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      4.50,
      6.50,
      0.00
   ]
}

4. Rabatte - Es ist möglich den Zahlbetrag der Kunden dauerhaft zu reduzieren. Die Periodizität des vorherigen Zyklus wird übernommen. Der Rabatt wird immer auf Basis des letzten Zahlbetrags berechnet. Es besteht die Auswahl zwischen einem prozentualen oder absoluten Rabatt. Im aktuellen Beispiel wird dem Kunden ein dauerhafter Rabatt von 30% gewährt.

{
   "increaseToClaim": 0,
   "discount":{
      "percent": 30,
      "amount": 0
   }
}

5. Preiserhöhung mit zwei konkreten Kontakten. Dabei muss der Parameter „createContact“ im Header true sein, ansonsten wird der Kontakt nicht angelegt.

{
   "increaseToClaim": 1,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ],
   "contacts": [
     {
         "activity": "SAVE3",
         "class": "SAVE",
         "type": "S"
     },
     {
         "activity": "SAVE4",
         "class": "SAVE",
         "type": "S"
     }
   ]
}
}

6. Preiserhöhung mit eine nächsten Einzugsdatum und Anzahl Tage bevor ein Brief versendet werden soll. In diesem Beispiel wird der Brief am 01. Januar 2022 versendet.

{
   "increaseToClaim": 0,
   "totalPrice":30.55,
   "term":"M3",
   "letterNumber":"",
   "suppressLetter":false,
   "reversePriceInc":false,
   "nextClaimDate": 2022-01-31,
   "sendLetterXDaysBfClaim": 30,
   "bundlePrices":[
      0.00,
      0.00,
      0.00
   ]
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
increaseToClaim	C/4	Einzug zu dem der Preis erhöht werden soll
totalPrice	AN/9	Neuer Gesamtpreis (inkl. Bundle Bestandteile)
term	C/2	Neue Periodizität (FKPER)
letterNumber	C/4	Briefnummer die ausgelöst werden soll (falls abweichend zu Default)
suppressLetter	bool	Änderungsbrief unterdrücken
reversePriceInc	bool	Preiserhöhung rückgängig machen
nextClaimDate	date	Format YYYY-MM-DD
sendLetterXDaysBfClaim	I/3	Number of days the letter should be send before the next claim
delUnpaidCycle	bool	Lösche noch nicht bezahlte, zukünftige Zyklen (aktueller Zyklus wird nie gelöscht!)
bundlePrices
price	C/11	price bundle slave (max. 3)
discount
percent	C/2	Prozentualer Rabatt. Angabe mit SAP Konditionswert!
amount	AN/9	Absoluter Rabatt
attributes		Optional - Übersteuert die automatisch ermittelten Attributwerte
code	AN/6	Attribut Code (DD_BAS - Standardpreis / DD_SAV - Ersparnis in Prozent)
value	AN/9	Wert des Attributs

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
status	Status - OK/NOTOK
code	Fehlercode
message	Fehlermeldung

{
    "status": "OK",
    "code": 0,
    "message": ""
}

Position anlegen

BETA Legt eine neue Position im Auftrag an. Dieser Service steht noch nicht zur Verfügung.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createPosition-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/positions?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der Body des Post Request beinhaltet ein JSON Dokument mit der Auftragsposition:

Beispiel Request Body JSON:

{
  "issueNumberFrom" : "12234",
  "duration"   : "12",
  "priceKey"   : "A1",
  "mixType"    : "a",
  "period"     : "2"
}

Element	Länge	Beschreibung
issueNumberFrom	10	Heft, ab dem die Position eingefügt wird, z.B. 0010/2021
duration	3	Anzahl der Hefte
priceKey	4	Preisschlüssel
mixType	2	Bezugstyp
period	5	Bezugsperiodizität

Response

Im Erfolgsfall wird Status 200 zurückgegeben. Bei einem Verarbeitungsproblem im AVS, kommt Status 400.

Im Response Body stehen die Meldungen aus AVS.

Beispiel:

[
  {
    "msgId": "/DSB/JKNA",
    "msgNo": "816",
    "msgType": "S",
    "msgText": "Befristete Position wurde eingefügt!"
  }
]

Auftragswandlung

(Nutzung nur bei entspr. Backendintegration in der ccb Suite)

Der Service wandelt den Auftrag, referenziert durch den Requestparameter orderNumber, anhand der Parameter in einen neuen Auftrag um.
Wenn der Prozess erfolgreich war, wird die neue Auftragsnummer im json Response zurückgeliefert.

Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/objectChange-1.0.0
Fuba: /DSB/ISM_K_AUFTRAG_WANDELN_BTC

URL

POST rest/{client}/subscriptions/{orderNumber}/objectChange

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Auftragsnummer alter Auftrag
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
so	C/4	Verkaufsorganisation. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann)

Request Body

Der Request body enthält die zusätzlichen Parameter.

Beispiel Request Body JSON:

{
  "cancelReason" : "", 
  "promotionSource" : "", 
  "promotionSourceVariant" : "",
  "publication" : "", 
  "newOfferCode" : "ABC",
  "mixType" : "12",
  "newNumberOfCopies" : 3,
  "rebookCredit" : false, 
  "rebookReceivable" : false, 
  "noCancellationProcessing" : false, 
  "transferPaymentMethod" : false, 
  "transferContractCommitment" : false, 
  "transferOrderAttributes" : false,
  "adjustFollowUpCalculation" : false,
  "transferOfferPhase" : true,
  "transferPriceList" : false,
  "renewExistingSubscription" : true
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
cancelReason	C/3	Kündigungsgrund alter Auftrag (mandatory)
promotionSource	C/10	Bestellquelle für neuen Auftrag (mandatory)
publication	C/8	Druckerzeugnis für neuen Auftrag (mandatory)
rebookCredit	B	Guthaben auf neuen Auftrag umbuchen true/false(default)
rebookReceivable	B	Forderung auf neuen Auftrag umbuchen true/false(default)
noCancellationProcessing	B	Keine Kündigungsnachbearbeitung true/false(default)
transferPaymentMethod	B	Zahlweg aus dem alten Auftrag für den neuen übernehmen true/false(default)
transferContractCommitment	B	Vertragsbindung aus dem alten Auftrag in den neuen übertragen true/false(default)
transferOrderAttributes	B	Auftragsmerkmale aus dem alten Auftrag für den neuen übernehmen true/false(default)
adjustFollowUpCalculation	B	Folgerechnung anpassen true/false(default)
newOfferCode	C
mixType	C	neuer Bezugstyp
newNumberOfCopies	N
transferOfferPhase	B	true/false(default)
transferPriceList	B	true/false(default)
renewExistingSubscription	B	true/false(default)

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zus. Meldung im Fehlerfall
success	true/false
orderNumber	Auftragsnummer des neuen Auftrags

{
"success" : true,
"orderNumber" : "12345"
}

oder

{
"message": "Fehlermeldung.....",
"success" : false
}

generische Änderung

Der Service ändert einzelne Parameter am Auftrag. Der Service ist auch für künftige Erweiterungen nutzbar.
Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/change-1.0.0
Endpoint splittet sich je nach Funktion auf Fuba: /DSB/_ISM_E_UNLIMITED_CHANGE
Preisschlüsseländerung: /DSB/CL_JWEB_CHANGE_RCODE

URL

POST rest/{client}/subscriptions/{orderNumber}/change

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Auftragsnummer
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
so	C/4	Verkaufsorganisation. (mandatory, wenn der Account nur bestimmte VkOrgs nutzen kann)
action	C	Was soll geändert werden? (mandatory)

Als action Parameter kann bisher genutzt werden:

DISCOUNT
student
priceKey

Request Body

Der Request body enthält die zusätzlichen Parameter.

Beispiel Request Body JSON:

{
  "condition" : "10",
  "validFrom" : "2023-10-01"
}

oder für pricKey

{
    "validFrom": "2025-03-15",
    "validTo": "2025-06-15",
    "priceKey": "CP02"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
condition	C/2	Detail zur action. Bei DISCOUNT der Rabatt oder – um den Rabatt zu löschen
validFrom	D	Ab wann soll die Änderung gelten? (optional) default: ab sofort

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zus. Meldung im Fehlerfall
success	true/false

{
"success" : true
}

oder

{
"message": "Fehlermeldung.....",
"success" : false
}

Bezugsperiodizität ändern / Change Purchasefrequency

Dieser Service ändert die Bezugsperiodizität eines Abos.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changePurchaseFrequency-1.0.0
Fuba: /DSB/_ISM_E_BATCHSCHNITTSTELL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/purchaseFrequency?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
"purchaseFrequency" : "MQ",
"issueNumberFrom" : "0004/2020",
"issueNumberTo" : "0011/2020"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
purchaseFrequency	AN/5	Neue Bezugsperiodizität(mandatory)
issueNumberFrom	AN/9	Heftnummer, ab der die Änderung gilt
issueNumberTo	AN/9	Heftnummer, bis zu der die Änderung gilt

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zusätzliche Meldung
success	true/false

{
"message": "",
"success" : "true"
}

Liefer Typ ändern / Change Delivery Type

Dieser Service ändert den Liefertyp eines Abos.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/changeDeliveryType-1.0.0
Fuba: /DSB/_ISM_E_BATCHSCHNITTSTELL

URL

POST: /rest/{client}/subscriptions/{orderNumber}/deliveryType?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
"deliveryType" : "KV",
"issueNumberFrom" : "0004/2020",
"issueNumberTo" : "0011/2020",
"shippingType" : "",
"shippingText" : "",
"deleteShippingType" : true/false(default),
"deleteShippingText" : true/false(default),
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
deliveryType	AN/2	Neuer Liefertyp(mandatory)
issueNumberFrom	AN/9	Heftnummer, ab der die Änderung gilt
issueNumberTo	AN/9	Heftnummer, bis zu der die Änderung gilt
shippingType	AN/2	Versandart
shippingText	AN/5	Versandtext
deleteShippingType	B	Versandart löschen? true/false(default) optional
deleteShippingText	B	Versandtext löschen?true/false(default) optional

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
message	Zusätzliche Meldung
success	true/false

{
"message": "",
"success" : "true"
}

Link für Zahlwegsänderung anlegen / Create Payment Change Link

BETA Legt eine neue Zahlwegsänderung im Auftrag an.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createPaymentChangeLink-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/bps/{bpNumber}/createPaymentChangeLink?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
bpNumber	C/10	GP Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Response

Im Erfolgsfall wird Status 200 zurückgegeben. Bei einem Verarbeitungsproblem im AVS, kommt Status 400.

Im Response Body stehen die Meldungen aus AVS.

Beispiel:

[
  {
    "msgId": "/DSB/JENA",
    "msgNo": "053",
    "msgType": "S",
    "msgText": "Nachricht zur Linkgenerierung angelegt"
  }
]

Event Code anlegen / Set event code

BETA Legt einen eventCode zum Auftrag an Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/setEventCode-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/eventCode?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
  "eventCode": "",
  "quantity": 1,
  "inputOffice": "",
  "inputDate": "DDMMYYYY",
  "inputTime": "HHMMSS"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
eventCode	AN/6	Event code(mandatory)
quantity	N/3	Anzahl (mandatory)
inputOffice	AN/12	Erfassbüro
inputDate	AN/8	Erfassdatum (mandatory)
inputTime	AN/6	Erfass Uhrzeit

Response Body

Im Erfolgsfall wird Status 200 zurückgegeben. Bei einem Verarbeitungsproblem im AVS, kommt Status 400.

Im Response Body stehen die Meldungen aus AVS.

Beispiel:

{
  "success": true/false,
  "message": ""
}

Mahnstopp anlegen / Set dunning lock

BETA Legt einen neuen Mahnstopp zum Auftrag an.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/setDunningLock-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/dunningLock?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
  "dunningLockReason": "",
  "dunningLockFromDate": "YYYY-MM-DD",
  "dunningLockDate": "YYYY-MM-DD"
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
dunningLockReason	AN/1	Event code(mandatory)
dunningLockFromDate	AN/10	Start Datum YYYY-MM-DD(mandatory)
dunningLockToDate	AN/10	Stopp Datum YYYY-MM-DD

Response

Im Erfolgsfall wird Status 200 zurückgegeben. Bei einem Verarbeitungsproblem im AVS, kommt Status 400. Wenn im Response Body trotz HTTP 200 die gefüllte Message Struktur zurückgeliefert wird, dann ist der Satz im SAP auf Fehler gelaufen. Im Response Body stehen die Meldungen aus AVS.

Beispiel:

[
  {
    "msgId": "",
    "msgNo": "",
    "msgType": "",
    "msgV1": "",
    "msgText": ""
  }
]

Ausgangszahlweg setzen für Erstattung Guthaben / create payment method for credit /refund

BETA Setzt einen neuen Ausgangszahlweg setzen für Erstattung Guthaben zum Auftrag.

Path mapping(internal): /net/dsb/avs3/SubscriptionOrder/createPaymentMethodForCreditRefund-1.0.0

URL

POST: /rest/{client}/subscriptions/{orderNumber}/paymentMethodForCreditRefund?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandanten Nummer
orderNumber	C/10	Abo Nummer
sp	C/3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.))

Request Body

Der body des Post Request beinhaltet ein JSON Dokument mit diesen Elementen:

Beispiel Request Body JSON:

{
  "debitAccountHolder": "",
  "debitCountry": "",
  "iban": ""
}

Element Definitions

Parameter	Typ/Länge	Beschreibung
debitAccountHolder	AN/1
debitCountry	AN/3	(mandatory)
iban	AN	Iban (mandatory)

Response

Im Erfolgsfall wird Status 200 zurückgegeben. Bei einem Verarbeitungsproblem im AVS, kommt Status 400. Wenn im Response Body trotz HTTP 200 die gefüllte Message Struktur zurückgeliefert wird, dann ist der Satz im SAP auf Fehler gelaufen. Im Response Body stehen die Meldungen aus AVS.

Beispiel:

[
  {
    "msgId": "",
    "msgNo": "",
    "msgType": "",
    "msgV1": "",
    "msgText": ""
  }
]