Monsum API Documentation

customer.get

Abfragen der Details eines oder mehrerer Kunden. Wenn kein Filter gesetzt wird, werden 10 Kunden zurückgeliefert. Bei setzen von LIMIT sind bis zu 100 Kunden möglich.

FILTER

Tags	Beschreibung
CUSTOMER_ID	Eine von Automatic vergebene bestimmte Kundennummer
CUSTOMER_NUMBER	Eigene Kundennummer
COUNTRY_CODE	Länder-Code (ISO 3166 ALPHA-2)
CITY	Stadt
TERM	Sucht nach Suchterm in einem der Felder: ORGANIZATION, FIRST_NAME, LAST_NAME, ADDRESS, ADDRESS_2, ZIPCODE, EMAIL
HASH	Filtern nach Hash

RESPONSE

Tags	Beschreibung
CUSTOMER_ID	Eine von Automatic vergebene bestimmte Kundennummer
CUSTOMER_NUMBER	Eigene Kundennummer
CUSTOMER_EXT_UID	Kunde nach der externen ID
CUSTOMER_TYPE	Kundentyp: business = Geschäftskunde \| consumer = Privatperson
ORGANIZATION	Firmenname [REQUIRED] wenn customer_type = business
TITLE_ACADEMIC	Akademischer Titel
SALUTATION	Anrede: mr = Herr \| mrs = Frau \| family = Familie \| "empty" = ohne Titel
FIRST_NAME	Vorname
LAST_NAME	Nachname [REQUIRED] wenn customer_type = consumer
ADDRESS	Adresszeile 1
ADDRESS_2	Adresszeile 2
ZIPCODE	Postleitzahl
CITY	Stadt
COUNTRY_CODE	Länder-Code (ISO 3166 ALPHA-2)
SECONDARY_ADDRESS	Lieferadresse
STATE	Bundesland
PHONE	Telefon
FAX	Faxnummer
EMAIL	E-Mailadresse
EMAIL_CC	CC für den E-Mail-Versand an den Kunden
BIRTHDAY	Geburtstag
PAYMENT_MAIL_ADDRESS	Zahlungs-E-Mailadresse
VAT_ID	Die Umsatzsteuer ID eines Kunden
TAX_ID	Steuernummer
CURRENCY_CODE	Standardwährung
COMMENT	Kommentar
DAYS_FOR_PAYMENT	Tage bis zum Zahlungsziel
CREATED	Datum der Erstellung
PAYMENT_TYPE	Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \| 3 = bar \| 4 = paypal \| 5 = vorkasse \| 6 = kreditkarte
ALLOWED_PAYMENT_TYPES	Festlegen, welche Zahlungsarten für den Kunden verfuegbar sind - Aktivierung der Funktion via Support. Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \|4 = paypal \|6 = kreditkarte
PAYMENT_PROVIDER	Name des von Ihnen angebundenen Zahlungsdienstleisters
PAYMENT_TOKEN	Vom Zahlungsdiensleister erhaltener Token zur Zuweisung des Kunden
BANK_NAME	Bankname
BANK_ACCOUNT_OWNER	Kontoinhaber
BANK_IBAN	IBAN
BANK_BIC	BIC
BANK_ACCOUNT_MANDATE_REFERENCE	Mandatsrefernznummer
BANK_ACCOUNT_MANDATE_REFERENCE_DATE	Erstellungsdatum des SEPA-Lastschriftmandats
SHOW_PAYMENT_NOTICE	Zahlungshinweis anzeigen
NEWSLETTER_OPTIN	Newsletteroption: 0 = nein \| 1 = ja
AFFILIATE	Vertriebspartner
HASH	Filtern nach Hash
LASTUPDATE	Datum der letzten Bearbeitung
TAGS	Tags
LANGUAGE_CODE	Sprachcode z.B. de, fr etc.
CHANGEDATA_URL	Link um die Stamm- und Rechnungsdaten zu ändern
DASHBOARD_URL	Link zum Dashboard
CREDIT_BALANCE	Guthaben
WIRECARD_GATEWAYREFERENCENUMBER	ID für Wirecard Zahlungen
ADYEN_ENCRYPTED_DATA	Client side payment token
PAYPAL_BILLINGAGREEMENTID	Reference Transaction ID
PAYPAL_PAYERID
INVOICE_DELIVERY_METHOD	Art des Rechnungs-Versands

customer.create

Erstellen eines neuen Kunden.

DATA

Tags	Beschreibung
CUSTOMER_NUMBER	Eigene Kundennummer
CUSTOMER_EXT_UID	Kunde nach der externen ID
CUSTOMER_TYPE Required	Kundentyp: business = Geschäftskunde \| consumer = Privatperson
ORGANIZATION	Firmenname [REQUIRED] wenn customer_type = business
POSITION	Position in der Firma
SALUTATION	Anrede: mr = Herr \| mrs = Frau \| family = Familie \| "empty" = ohne Titel
TITLE_ACADEMIC	Akademischer Titel
FIRST_NAME	Vorname
LAST_NAME	Nachname [REQUIRED] wenn customer_type = consumer
ADDRESS	Adresszeile 1
ADDRESS_2	Adresszeile 2
ZIPCODE	Postleitzahl
CITY	Stadt
STATE	Bundesland
COUNTRY_CODE	Länder-Code (ISO 3166 ALPHA-2)
LANGUAGE_CODE	Sprachcode z.B. de, fr etc.
BIRTHDAY	Geburtstag
PHONE	Telefon
PHONE_2	Telefon 2
FAX	Faxnummer
MOBILE	Mobiltelefonnummer
EMAIL	E-Mailadresse
ACCOUNT_RECEIVABLE	Datev Debitoren-Kontonummer
CURRENCY_CODE	Standardwährung
VAT_ID	Die Umsatzsteuer ID eines Kunden
TAX_ID	Steuernummer
DAYS_FOR_PAYMENT	Tage bis zum Zahlungsziel
PAYMENT_TYPE	Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \| 3 = bar \| 4 = paypal \| 5 = vorkasse \| 6 = kreditkarte
ALLOWED_PAYMENT_TYPES	Festlegen, welche Zahlungsarten für den Kunden verfuegbar sind - Aktivierung der Funktion via Support. Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \|4 = paypal \|6 = kreditkarte
PAYMENT_PROVIDER	Name des von Ihnen angebundenen Zahlungsdienstleisters
PAYMENT_TOKEN	Vom Zahlungsdiensleister erhaltener Token zur Zuweisung des Kunden
SHOW_PAYMENT_NOTICE	Zahlungshinweis anzeigen
BANK_NAME	Bankname
BANK_CODE	Bankleitzahl
BANK_ACCOUNT_NUMBER	Kontonummer
BANK_ACCOUNT_OWNER	Kontoinhaber
BANK_ACCOUNT_OWNER_ADDRESS	Adresse des Kontoinhabers
BANK_ACCOUNT_OWNER_CITY	Stadt des Kontoinhabers
BANK_ACCOUNT_OWNER_ZIPCODE	Postleitzahl des Kontoinhabers
BANK_ACCOUNT_OWNER_EMAIL	Emailadresse des Kontoinhabers
BANK_BIC	BIC
BANK_IBAN	IBAN
PAYMILL_TOKEN	Token für Kreditkartenzahlung über Paymill
COMMENT	Kommentar
NEWSLETTER_OPTIN	Newsletteroption: 0 = nein \| 1 = ja
X_ATTRIBUTES	Verwendung eigener Felder (Webhooks werden das übernehmen)
PAYMILL_AMOUNT	Höhe der nächsten Zahlung (zum Abgleich)
WIRECARD_GATEWAYREFERENCENUMBER	ID für Wirecard Zahlungen
ADYEN_ENCRYPTED_DATA	Client side payment token
PAYPAL_BILLINGAGREEMENTID	Reference Transaction ID
PAYPAL_PAYERID
AFFILIATE	Vertriebspartner
INVOICE_DELIVERY_METHOD	Art des Rechnungs-Versands

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion oder Status einer Rechnung
CUSTOMER_ID	Eine von Automatic vergebene bestimmte Kundennummer
HASH	Filtern nach Hash
CHANGEDATA_URL	Link um die Stamm- und Rechnungsdaten zu ändern
DASHBOARD_URL	Link zum Dashboard

customer.checkvatid

Validierung der Umsatzsteuer ID eines Kunden.

DATA

Tags	Beschreibung
VAT_ID Required	Die Umsatzsteuer ID eines Kunden

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion oder Status einer Rechnung
EXTERNAL_CHECK	Externe Syntax-Prüfung der ID

customer.update

Verändern der Daten eines Kunden.

DATA

Tags	Beschreibung
CUSTOMER_ID Required	Eine von Automatic vergebene bestimmte Kundennummer
SUPPRESS_MAIL	Bestätigungsmail an Kunden unterdrücken (0 = nein \| 1 = ja)
CUSTOMER_NUMBER	Eigene Kundennummer
CUSTOMER_EXT_UID	Kunde nach der externen ID
CUSTOMER_TYPE	Kundentyp: business = Geschäftskunde \| consumer = Privatperson
ORGANIZATION	Firmenname [REQUIRED] wenn customer_type = business
POSITION	Position in der Firma
SALUTATION	Anrede: mr = Herr \| mrs = Frau \| family = Familie \| "empty" = ohne Titel
TITLE_ACADEMIC	Akademischer Titel
FIRST_NAME	Vorname
LAST_NAME	Nachname [REQUIRED] wenn customer_type = consumer
ADDRESS	Adresszeile 1
ADDRESS_2	Adresszeile 2
ZIPCODE	Postleitzahl
CITY	Stadt
STATE	Bundesland
COUNTRY_CODE	Länder-Code (ISO 3166 ALPHA-2)
LANGUAGE_CODE	Sprachcode z.B. de, fr etc.
BIRTHDAY	Geburtstag
PHONE	Telefon
PHONE_2	Telefon 2
FAX	Faxnummer
MOBILE	Mobiltelefonnummer
EMAIL	E-Mailadresse
ACCOUNT_RECEIVABLE	Datev Debitoren-Kontonummer
CURRENCY_CODE	Standardwährung
VAT_ID	Die Umsatzsteuer ID eines Kunden
TAX_ID	Steuernummer
DAYS_FOR_PAYMENT	Tage bis zum Zahlungsziel
PAYMENT_TYPE	Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \| 3 = bar \| 4 = paypal \| 5 = vorkasse \| 6 = kreditkarte
ALLOWED_PAYMENT_TYPES	Festlegen, welche Zahlungsarten für den Kunden verfuegbar sind - Aktivierung der Funktion via Support. Zahlungsart: 1 = ueberweisung \| 2 = lastschrift \|4 = paypal \|6 = kreditkarte
PAYMENT_PROVIDER	Name des von Ihnen angebundenen Zahlungsdienstleisters
PAYMENT_TOKEN	Vom Zahlungsdiensleister erhaltener Token zur Zuweisung des Kunden
SHOW_PAYMENT_NOTICE	Zahlungshinweis anzeigen
BANK_NAME	Bankname
BANK_CODE	Bankleitzahl
BANK_ACCOUNT_NUMBER	Kontonummer
BANK_ACCOUNT_OWNER	Kontoinhaber
BANK_ACCOUNT_OWNER_ADDRESS	Adresse des Kontoinhabers
BANK_ACCOUNT_OWNER_CITY	Stadt des Kontoinhabers
BANK_ACCOUNT_OWNER_ZIPCODE	Postleitzahl des Kontoinhabers
BANK_ACCOUNT_OWNER_EMAIL	Emailadresse des Kontoinhabers
BANK_BIC	BIC
BANK_IBAN	IBAN
PAYMILL_TOKEN	Token für Kreditkartenzahlung über Paymill
COMMENT	Kommentar
NEWSLETTER_OPTIN	Newsletteroption: 0 = nein \| 1 = ja
X_ATTRIBUTES	Verwendung eigener Felder (Webhooks werden das übernehmen)
PAYMILL_AMOUNT	Höhe der nächsten Zahlung (zum Abgleich)
WIRECARD_GATEWAYREFERENCENUMBER	ID für Wirecard Zahlungen
ADYEN_ENCRYPTED_DATA	Client side payment token
PAYPAL_BILLINGAGREEMENTID	Reference Transaction ID
PAYPAL_PAYERID
AFFILIATE	Vertriebspartner
INVOICE_DELIVERY_METHOD	Art des Rechnungs-Versands

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion oder Status einer Rechnung
CUSTOMER_ID	Eine von Automatic vergebene bestimmte Kundennummer

customer.delete

Löschen eines Kunden.

DATA

Tags	Beschreibung
CUSTOMER_ID Required	Eine von Automatic vergebene bestimmte Kundennummer

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion oder Status einer Rechnung

customer.addcredits

Creditguthaben, das beim Kunden hinterlegt ist

DATA

Tags	Beschreibung
CUSTOMER_ID Required	Eine von Automatic vergebene bestimmte Kundennummer
AMOUNT Required	Anzahl

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion oder Status einer Rechnung

customer.createsecurelink

Erstellen eines Links zu Der Account-Übersicht und dem Dash-Board des Kunden

DATA

Tags	Beschreibung
CUSTOMER_ID Required	Eine von Automatic vergebene bestimmte Kundennummer

RESPONSE

Tags	Beschreibung
ACCOUNTDATA_URL	Link zur Accountübersicht
DASHBOARD_URL	Link zum Dashboard