updatePayments

Navigation:  WebService Calls > Options for Growth >

updatePayments

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Aktualisierung von Zahlungsdaten.

Beispiel Request

Code

<request method="updatePayments" version="1.0.0">

   <payment significant_key="payment_id">

   <!-- <payment_id>[ID]</payment_id> --> <!-- Keine ID => Neu anlegen -->

      <mandator_id>1</mandator_id>

      <external_payment_id>654321</external_payment_id>

      <order_id>123456</order_id> <!-- Order-Alternative 1 -->

      <!--<order_number_prefix>EBY</order_number_prefix>--><!-- Order-Alternative 2 -->

      <!--<order_number>34</order_number>--><!-- Order-Alternative 2 -->

      <!--<external_order_number_1>201002160002</external_order_number_1>--><!-- Order-Alternative 3 -->

      <amount>351.75</amount>

      <currency_code_iso>EUR</currency_code_iso>

      <pay_date>2009-06-12T00:00:00</pay_date>

      <note></note>

      <depositor>Max Mustermann</depositor>

      <bank_account_number>123456</bank_account_number>

      <bank_code>654321</bank_code>

      <bank_name>Testbank</bank_name>

   </payment>

</request>

Feldliste Request

Name

Beschreibung        

Anz.

Typ

sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„updatePayments“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

payment

Wrapper-Element, das die Daten des Zahlungseingangs zusammenfasst.

0..N

Element

 

 

 

significant_key

Gibt an welches Feld zur Identifikation des Zahlungseingangs beim Update genutzt wird.

1

string

Feste Werte:

„payment_id“ |

„external_id“

payment_id

ID des Zahlungseingangs

0..1

integer

mandator_id

ID des Mandanten dem der Zahlungseingang zugeordnet ist.

1

integer

external_payment_id

Externe ID des Zahlungseingangs

0..1

string

Länge:

0-50 Zeichen

order_id

ID des Auftrags der dem Zahlungseingang zugeordnet ist.

0..1

integer

order_number_prefix

Prefix des Auftrags. Wird dann benötigt, wenn die Prefix-Option aktiviert ist.

0..1

string

order_number

Auftragsnummer des Auftrags der dem Zahlungseingang zugeordnet ist.

0..1

integer

external_order_number_1

Externe Auftragsnummer 1 des Auftrags der dem Zahlungseingang zugeordnet ist.

0..1

string

Länge:

0-100 Zeichen

external_order_number_2

Externe Auftragsnummer 2 des Auftrags der dem Zahlungseingang zugeordnet ist.

0..1

string

Länge:

0-100 Zeichen

amount

Eingegangener Betrag

1

decimal

currency_code_iso

Währung

0..1

string

ISO CODE z.B. "EUR"

pay_date

Datum des Zahlungseingangs

1

dateTime

note

Bemerkung

0..1

string

depositor

Kontoinhaber

0..1

string

Länge:

0-150 Zeichen

bank_account_number

Kontonummer

0..1

string

Länge:

0-20 Zeichen

bank_code

Bankleitzahl

0..1

string

Länge:

0-20 Zeichen

bank_name

Bank

0..1

string

Länge:

0-150 Zeichen

created_by

Benutzer der Zahlungseingang angelegt hat.

0..1

string

import_identifier

Zahlungsimport

0..1

string

Beispiel Response

Code

<response method="updatePayments" version="1.0.0">

    <report action="insert" return_code="0">

        <payment>

            <payment_id>1680091</payment_id>

            <mandator_id>1</mandator_id>

            <external_id>654321</external_id>

        </payment>

    </report>

</response>

Feldliste Response

Name

Beschreibung        

Anz.

Typ

sonstiges

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„updatePayments“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation. Für jedes Payment-Element aus dem Request wird ein Report zurückgegeben.

0..N

Element

action

Attribut von report. Gibt an welche Operation mit dem Datensatz durchgeführt wurde.

1

string

Feste Werte:

insert |

update

return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in er­ror_description eine Fehlerbeschreibung zurück geliefert

0..1

string

payment

Wrapper-Element, das die Daten des Zahlungseingangs zusammenfasst

1

Element

payment_id

ID des Zahlungseingangs

1

integer

mandator_id

ID des Mandanten dem dieser Zahlungseingang zugeordnet ist.

1

integer

external_id

Externe ID

1

string

Länge:

0 – 50 Zeichen

Hinweise

•Es muss sichergestellt sein, dass ein Wert oder eine Kombination von Werten verwendet wird, anhand derer Aufträge eindeutig identifiziert werden können. Die order_id wird eindeutig von der Software vergeben. Soll die Auftragsnummer verwendet werden, ist auch ein Prefix zu verwenden.

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung

3.5.7

Erweiterung des Requests um currency_code_iso.