hexagon overlay

API Dokumentation


Dokumentation unserer REST-API v3

Sivver REST-API v3

Mit unserer REST-API können Sie über 240 ausgewiesene Aktionen direkt auf Ihrer Sivver Instanz ausführen. Die nachfolgende Dokumentation zeigt alle derzeit verfügbaren Endpunkte und dessen Parametrierungen, sowie Rückgaben auf. Downloadlinks zu den derzeit verfügbaren Libraries für Sivver finden Sie am Ende dieser Seite unterhalb der Funktionsliste.

Suchen Sie die Dokumentation für die REST-API v2?

HINWEIS: Hooks, die mit einem gekennzeichnet sind, existieren zwar im System, konnten jedoch nicht automatisch dokumentiert werden. Bitte sprechen Sie uns an, falls Sie diese Endpunkte nutzen wollen.

Beschreibung

Der Endpunkt authentifiziert einen Kunden (Debitor) im System an Hand der E-Mail Adresse und dem Passwort. Diese Funktion kann beispielsweise verwendet werden, um Debitoren, die in Sivver hinterlegt sind, an externen Systemen (z.B. Onlineshops) zu authentifizieren.

Parameter

Parameter Beschreibung Beispielwert
USERNAME E-Mail Adresse des Kunden [email protected]
PASSWORD Passwort des Kunden clientsSecurePassword123

HTTP Status Codes

Code Beschreibung
200 OK Kunde authentifiziert
401 Unauthorized Kunde nicht authentifiziert
401 Bad Request Anfrage im falschen Format

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("externalAuth");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"USERNAME" => "[email protected]",
    
"PASSWORD" => "clientsSecurePassword123"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

OK

Beschreibung

Der Endpunkt listet alle Kunden (Debitoren) im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Kundenliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("client/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "9997",
        "firstname": "Mustermann",
        "lastname": "Max",
        "company": "Mustermann GmbH",
        "email": "[email protected]",
        "password": "$2y$10$k2948kFv4laXHfDsRwxjaeynAxAMQnfNs",
        "street": "Musterstaße",
        "housenumber": "1",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "additional_addresses": "[]",
        "rating_secret": "XX5ZDESXFKNB9UFU",
        "externalid": "0",
        "status": "1",
        "activation_secret": "",
        "uses_authenticator": "1",
        "authenticator_secret": "AEYHSAOWUFVNA2XC",
        "authenticator_locked": "0",
        "reset_key": "TNUJ4USBFNHQE4R9",
        "regdate": "2019-08-16 14:14:00",
        "no_deletion": "0",
        "deleted": "0",
        "consultant": "10000"
    },
    {
        "id": "9998",
        "firstname": "Erika",
        "lastname": "Musterfrau",
        "company": "",
        "email": "[email protected]",
        "password": "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
        "street": "Musterstaße",
        "housenumber": "26",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "additional_addresses": "[]",
        "rating_secret": "AFXS3VKDDGF7PMPL",
        "externalid": "0",
        "status": "0",
        "activation_secret": "",
        "uses_authenticator": "0",
        "authenticator_secret": "",
        "authenticator_locked": "0",
        "reset_key": "",
        "regdate": "2019-08-16 14:14:00",
        "no_deletion": "0",
        "deleted": "0",
        "consultant": "0"
    }
]

Beschreibung

Der Endpunkt zeigt einen Kunden (Debitoren) im System an.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9998

HTTP Status Codes

Code Beschreibung
200 OK Kundenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("client/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9998"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "9998",
    "firstname": "Erika",
    "lastname": "Musterfrau",
    "company": "",
    "email": "[email protected]",
    "password": "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
    "street": "Musterstaße",
    "housenumber": "26",
    "postalcode": "10000",
    "city": "Musterstadt",
    "state": "Musterstaat",
    "country": "DE",
    "phone": "01234 567890",
    "additional_addresses": "[]",
    "rating_secret": "AFXS3VKDDGF7PMPL",
    "externalid": "0",
    "status": "0",
    "activation_secret": "",
    "uses_authenticator": "0",
    "authenticator_secret": "",
    "authenticator_locked": "0",
    "reset_key": "",
    "regdate": "2019-08-16 14:14:00",
    "no_deletion": "0",
    "deleted": "0",
    "consultant": "0"
}

Beschreibung

Der Endpunkt legt einen Kunden (Debitoren) im System an.

Parameter

Parameter Beschreibung Beispielwert
firstname Vorname des Kunden Erika
lastname Nachname des Kunden Musterfrau
company Firma des Kunden Mustermann GmbH
email E-Mail des Kunden [email protected]
password Passwort des Kunden (verschlüsselt) $2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7
street Straße des Kunden Musterstaße
housenumber Hausnummer des Kunden 26
postalcode Postleitzahl des Kunden 10000
city Stadt des Kunden Musterstadt
state Bundesstaat des Kunden Musterstaat
country Land des Kunden DE
phone Telefonnummer des Kunden 01234 567890
additional_addresses Zusätzliche Adressen des Kunden []
rating_secret 16-stelliges Geheimnis für Bewertungen AFXS3VKDDGF7PMPL
externalid ID in externen Ergebnissen 0
status Status des Kunden (Gesperrt, Freigeschaltet) 0
activation_secret 16-stelliges Geheimnis für Account-Aktivierung BFXS3VKDDGF7PMPX
uses_authenticator Kunde bindet den Google Authenticator an 0
authenticator_secret Google Authenticator Geheimnis des Kunden
authenticator_locked Kunde benutzt aktuell den Google Authenticator 0
reset_key 16-stelliges Geheimnis für das Zurücksetzen des Passworts ZFXS3VKBBGF7PMPI
regdate Registrierungsdatum des Kunden 2019-08-16 14:14:00
no_deletion Kunde von DSGVO Mechanismen ausschließen 1
deleted Kunde gelöscht 0
consultant Berater des Kunden 0

HTTP Status Codes

Code Beschreibung
200 OK Kundenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("client/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"firstname" => "Erika",
    
"lastname" => "Musterfrau",
    
"company" => "",
    
"email" => "[email protected]",
    
"password" => "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
    
"street" => "Musterstaße",
    
"housenumber" => "26",
    
"postalcode" => "10000",
    
"city" => "Musterstadt",
    
"state" => "Musterstaat",
    
"country" => "DE",
    
"phone" => "01234 567890",
    
"additional_addresses" => "[]",
    
"rating_secret" => "AFXS3VKDDGF7PMPL",
    
"externalid" => "0",
    
"status" => "0",
    
"activation_secret" => "",
    
"uses_authenticator" => "0",
    
"authenticator_secret" => "",
    
"authenticator_locked" => "0",
    
"reset_key" => "",
    
"regdate" => "2019-08-16 14:14:00",
    
"no_deletion" => "0",
    
"deleted" => "0",
    
"consultant" => "0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert einen Kunden (Debitoren) im System.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9998
data->firstname Vorname des Kunden Erika
data->lastname Nachname des Kunden Musterfrau
data->company Firma des Kunden Mustermann GmbH
data->email E-Mail des Kunden [email protected]
data->password Passwort des Kunden (verschlüsselt) $2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7
data->street Straße des Kunden Musterstaße
data->housenumber Hausnummer des Kunden 26
data->postalcode Postleitzahl des Kunden 10000
data->city Stadt des Kunden Musterstadt
data->state Bundesstaat des Kunden Musterstaat
data->country Land des Kunden DE
data->phone Telefonnummer des Kunden 01234 567890
data->additional_addresses Zusätzliche Adressen des Kunden []
data->rating_secret 16-stelliges Geheimnis für Bewertungen AFXS3VKDDGF7PMPL
data->externalid ID in externen Ergebnissen 0
data->status Status des Kunden (Gesperrt, Freigeschaltet) 0
data->activation_secret 16-stelliges Geheimnis für Account-Aktivierung BFXS3VKDDGF7PMPX
data->uses_authenticator Kunde bindet den Google Authenticator an 0
data->authenticator_secret Google Authenticator Geheimnis des Kunden
data->authenticator_locked Kunde benutzt aktuell den Google Authenticator 0
data->reset_key 16-stelliges Geheimnis für das Zurücksetzen des Passworts ZFXS3VKBBGF7PMPI
data->regdate Registrierungsdatum des Kunden 2019-08-16 14:14:00
data->no_deletion Kunde von DSGVO Mechanismen ausschließen 1
data->deleted Kunde gelöscht 0
data->consultant Berater des Kunden 0

HTTP Status Codes

Code Beschreibung
200 OK Kundenobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("client/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9998",
    
"data" => [
        
"firstname" => "Erika",
        
"lastname" => "Musterfrau",
        
"company" => "",
        
"email" => "[email protected]",
        
"password" => "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
        
"street" => "Musterstaße",
        
"housenumber" => "26",
        
"postalcode" => "10000",
        
"city" => "Musterstadt",
        
"state" => "Musterstaat",
        
"country" => "DE",
        
"phone" => "01234 567890",
        
"additional_addresses" => "[]",
        
"rating_secret" => "AFXS3VKDDGF7PMPL",
        
"externalid" => "0",
        
"status" => "0",
        
"activation_secret" => "",
        
"uses_authenticator" => "0",
        
"authenticator_secret" => "",
        
"authenticator_locked" => "0",
        
"reset_key" => "",
        
"regdate" => "2019-08-16 14:14:00",
        
"no_deletion" => "0",
        
"deleted" => "0",
        
"consultant" => "0"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Kunden (Debitoren) im System.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9998

HTTP Status Codes

Code Beschreibung
200 OK Kundenobjekt gelöscht

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("client/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9998"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Lieferanten (Kreditoren) im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("supplier/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "10000",
        "firstname": "Max",
        "lastname": "Mustermann",
        "company": "Mustermann GmbH",
        "email": "[email protected]",
        "street": "Musterstaße",
        "housenumber": "1",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "fax": "01234 567899",
        "additional_addresses": "[]",
        "files": "[]",
        "externalid": "0"
    },
    {
        "id": "10001",
        "firstname": "Erika",
        "lastname": "Musterfrau",
        "company": "",
        "email": "[email protected]",
        "street": "Musterstaße",
        "housenumber": "26",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "fax": "01234 567899",
        "additional_addresses": "[]",
        "files": "[]",
        "externalid": "0"
    }
]

Beschreibung

Der Endpunkt zeigt einen Lieferanten (Kreditoren) im System an.

Parameter

Parameter Beschreibung Beispielwert
sid Lieferantennummer des Lieferanten 9998

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("supplier/get");

$parameters = [
    
"sid" => "10001"
];
$api->parameters($parameters);

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "10001",
    "firstname": "Erika",
    "lastname": "Musterfrau",
    "company": "",
    "email": "[email protected]",
    "street": "Musterstaße",
    "housenumber": "26",
    "postalcode": "10000",
    "city": "Musterstadt",
    "state": "Musterstaat",
    "country": "DE",
    "phone": "01234 567890",
    "fax": "01234 567899",
    "additional_addresses": "[]",
    "files": "[]",
    "externalid": "0"
}

Beschreibung

Der Endpunkt legt einen Lieferanten (Kreditoren) im System an.

Parameter

Parameter Beschreibung Beispielwert
firstname Vorname des Lieferanten Erika
lastname Nachname des Lieferanten Musterfrau
company Firma des Lieferanten Mustermann GmbH
email E-Mail des Lieferanten [email protected]
street Straße des Lieferanten Musterstaße
housenumber Hausnummer des Lieferanten 26
postalcode Postleitzahl des Lieferanten 10000
city Stadt des Lieferanten Musterstadt
state Bundesstaat des Lieferanten Musterstaat
country Land des Lieferanten DE
phone Telefonnummer des Lieferanten 01234 567890
additional_addresses Zusätzliche Adressen des Lieferanten []
files Dateien des Lieferanten []

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("supplier/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"firstname" => "Erika",
    
"lastname" => "Musterfrau",
    
"company" => "",
    
"email" => "[email protected]",
    
"street" => "Musterstaße",
    
"housenumber" => "26",
    
"postalcode" => "10000",
    
"city" => "Musterstadt",
    
"state" => "Musterstaat",
    
"country" => "DE",
    
"phone" => "01234 567890",
    
"fax" => "01234 567890",
    
"additional_addresses" => "[]",
    
"files" => "[]",
    
"externalid" => "0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert einen Lieferanten (Kreditoren) im System.

Parameter

Parameter Beschreibung Beispielwert
sid Lieferantennummer des Lieferanten 9998
data->firstname Vorname des Lieferanten Erika
data->lastname Nachname des Lieferanten Musterfrau
data->company Firma des Lieferanten Mustermann GmbH
data->email E-Mail des Lieferanten [email protected]
data->street Straße des Lieferanten Musterstaße
data->housenumber Hausnummer des Lieferanten 26
data->postalcode Postleitzahl des Lieferanten 10000
data->city Stadt des Lieferanten Musterstadt
data->state Bundesstaat des Lieferanten Musterstaat
data->country Land des Lieferanten DE
data->phone Telefonnummer des Lieferanten 01234 567890
data->additional_addresses Zusätzliche Adressen des Lieferanten []
data->files Dateien des Lieferanten []

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("supplier/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "10001",
    
"data" => [
        
"firstname" => "Erika",
        
"lastname" => "Musterfrau",
        
"company" => "",
        
"email" => "[email protected]",
        
"street" => "Musterstaße",
        
"housenumber" => "26",
        
"postalcode" => "10000",
        
"city" => "Musterstadt",
        
"state" => "Musterstaat",
        
"country" => "DE",
        
"phone" => "01234 567890",
        
"fax" => "01234 567890",
        
"additional_addresses" => "[]",
        
"files" => "[]",
        
"externalid" => "0"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Lieferanten (Kreditoren) im System.

Parameter

Parameter Beschreibung Beispielwert
sid Lieferantennummer des Lieferanten 9998

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenobjekt gelöscht

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("supplier/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"sid" => "10001"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Administratoren (Mitarbeiter) im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Lieferantenliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("admin/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "10000",
        "firstname": "Max",
        "lastname": "Mustermann",
        "email": "[email protected]",
        "username": "mmusterm",
        "password": "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
        "street": "Musterstaße",
        "housenumber": "1",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "additional_addresses": "[]",
        "is_online": "0",
        "time_template": "5",
        "uses_authenticator": "0",
        "authenticator_secret": "",
        "authenticator_locked": "0",
        "group_id": "0"
    },
    {
        "id": "10001",
        "firstname": "Erika",
        "lastname": "Musterfrau",
        "email": "[email protected]",
        "username": "emusterf",
        "password": "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
        "street": "Musterstaße",
        "housenumber": "26",
        "postalcode": "10000",
        "city": "Musterstadt",
        "state": "Musterstaat",
        "country": "DE",
        "phone": "01234 567890",
        "additional_addresses": "[]",
        "is_online": "0",
        "time_template": "5",
        "uses_authenticator": "0",
        "authenticator_secret": "",
        "authenticator_locked": "0",
        "group_id": "0"
    }
]

Beschreibung

Der Endpunkt zeigt einen Administrator (Mitarbeiter) im System an.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 9998

HTTP Status Codes

Code Beschreibung
200 OK Mitarbeiterobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("admin/get");

$parameters = [
    
"aid" => "10001"
];
$api->parameters($parameters);

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "10001",
    "firstname": "Erika",
    "lastname": "Musterfrau",
    "email": "[email protected]",
    "username": "emusterf",
    "password": "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
    "street": "Musterstaße",
    "housenumber": "26",
    "postalcode": "10000",
    "city": "Musterstadt",
    "state": "Musterstaat",
    "country": "DE",
    "phone": "01234 567890",
    "additional_addresses": "[]",
    "is_online": "0",
    "time_template": "5",
    "uses_authenticator": "0",
    "authenticator_secret": "",
    "authenticator_locked": "0",
    "group_id": "0"
}

Beschreibung

Der Endpunkt legt einen Administrator (Mitarbeiter) im System an.

Parameter

Parameter Beschreibung Beispielwert
firstname Vorname des Mitarbeiters Erika
lastname Nachname des Mitarbeiters Musterfrau
email E-Mail des Mitarbeiters [email protected]
username Benutzername des Mitarbeiters Musterfrau
street Straße des Mitarbeiters Musterstaße
housenumber Hausnummer des Mitarbeiters 26
postalcode Postleitzahl des Mitarbeiters 10000
city Stadt des Mitarbeiters Musterstadt
state Bundesstaat des Mitarbeiters Musterstaat
country Land des Mitarbeiters DE
phone Telefonnummer des Mitarbeiters 01234 567890
additional_addresses Zusätzliche Adressen des Mitarbeiters []
is_online Mitarbeiter ist im Livechat online 0
time_template Zeitmanagement Vorlage des Mitarbeiters 5
uses_authenticator Mitarbeiter bindet den Google Authenticator an 0
authenticator_secret Google Authenticator Geheimnis des Mitarbeiters
authenticator_locked Mitarbeiter benutzt aktuell den Google Authenticator 0
group_id Rechtegruppe des Mitarbeiters 1

HTTP Status Codes

Code Beschreibung
200 OK Mitarbeiterobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("admin/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"firstname" => "Erika",
    
"lastname" => "Musterfrau",
    
"email" => "[email protected]",
    
"username" => "emusterf",
    
"password" => "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
    
"street" => "Musterstraße",
    
"housenumber" => "26",
    
"postalcode" => "10000",
    
"city" => "Musterstadt",
    
"state" => "Musterstaat",
    
"country" => "DE",
    
"phone" => "01234 567890",
    
"additional_addresses" => "[]",
    
"is_online" => "0",
    
"time_template" => "5",
    
"uses_authenticator" => "0",
    
"authenticator_secret" => "",
    
"authenticator_locked" => "0",
    
"group_id" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert einen Administrator (Mitarbeiter) im System.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 10001
data->firstname Vorname des Mitarbeiters Erika
data->lastname Nachname des Mitarbeiters Musterfrau
data->email E-Mail des Mitarbeiters [email protected]
data->username Benutzername des Mitarbeiters Musterfrau
data->street Straße des Mitarbeiters Musterstaße
data->housenumber Hausnummer des Mitarbeiters 26
data->postalcode Postleitzahl des Mitarbeiters 10000
data->city Stadt des Mitarbeiters Musterstadt
data->state Bundesstaat des Mitarbeiters Musterstaat
data->country Land des Mitarbeiters DE
data->phone Telefonnummer des Mitarbeiters 01234 567890
data->additional_addresses Zusätzliche Adressen des Mitarbeiters []
data->is_online Mitarbeiter ist im Livechat online 0
data->time_template Zeitmanagement Vorlage des Mitarbeiters 5
data->uses_authenticator Mitarbeiter bindet den Google Authenticator an 0
data->authenticator_secret Google Authenticator Geheimnis des Mitarbeiters
data->authenticator_locked Mitarbeiter benutzt aktuell den Google Authenticator 0
data->group_id Rechtegruppe des Mitarbeiters 1

HTTP Status Codes

Code Beschreibung
200 OK Mitarbeiterobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("admin/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"aid" => "10001",
    
"data" => [
        
"firstname" => "Erika",
        
"lastname" => "Musterfrau",
        
"email" => "[email protected]",
        
"username" => "emusterf",
        
"password" => "$2y$10$cEObemgWCbEqyKM1/pV8Hey/yhZhA9rN7",
        
"street" => "Musterstraße",
        
"housenumber" => "26",
        
"postalcode" => "10000",
        
"city" => "Musterstadt",
        
"state" => "Musterstaat",
        
"country" => "DE",
        
"phone" => "01234 567890",
        
"additional_addresses" => "[]",
        
"is_online" => "0",
        
"time_template" => "5",
        
"uses_authenticator" => "0",
        
"authenticator_secret" => "",
        
"authenticator_locked" => "0",
        
"group_id" => "1"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Administrator (Mitarbeiter) im System.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 9998

HTTP Status Codes

Code Beschreibung
200 OK Mitarbeiterobjekt gelöscht

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("admin/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"aid" => "10001"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Berechtigungen im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Berechtigungsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("permission/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "permission": "*.*",
        "subpermission": "",
        "description": "All administrative permissions"
    },
    {
        "permission": "accounting.*",
        "subpermission": "*.*",
        "description": "All accounting permissions"
    },
    {
        "permission": "accounting.entries.*",
        "subpermission": "accounting.*",
        "description": "All permissions for accounting entries"
    },
    {
        "permission": "accounting.entries.list",
        "subpermission": "accounting.entries.*",
        "description": "List accounting entries"
    }
]

Beschreibung

Der Endpunkt alle Berechtigungen eines Mitarbeiters im System an.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 10001

HTTP Status Codes

Code Beschreibung
200 OK Berechtigungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("permission/get");

$parameters = [
    
"aid" => "10001"
];
$api->parameters($parameters);

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "permission": "accounting.entries.list",
    "subpermission": "accounting.entries.*",
    "description": "List accounting entries"
}

Beschreibung

Der Endpunkt prüft, ob ein Mitarbeiter ein Recht hat.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 10001
permission Recht im System accounting.entries.list

HTTP Status Codes

Code Beschreibung
200 OK Berechtigungsobjekt überprüft

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("permission/has");

$parameters = [
    
"aid" => "10001",
    
"permission" => "accounting.entries.list"
];
$api->parameters($parameters);

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt weißt einem Administrator (Mitarbeiter) im System ein Recht zu.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 10001
permission Recht im System accounting.entries.list

HTTP Status Codes

Code Beschreibung
200 OK Berechtigungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("permission/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"aid" => "10001",
    
"permission" => "accounting.entries.list"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt entzieht einem Administrator (Mitarbeiter) im System ein Recht.

Parameter

Parameter Beschreibung Beispielwert
aid Mitarbeiternummer des Mitarbeiters 10001
permission Recht im System accounting.entries.list

HTTP Status Codes

Code Beschreibung
200 OK Berechtigungsobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("permission/remove");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"aid" => "10001",
    
"permission" => "accounting.entries.list"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Einstellungen auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Einstellungsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("setting/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "setting": "MAINTAINANCE_MODE",
        "value": "false"
    },
    {
        "id": "2",
        "setting": "INSTALLATION_URI",
        "value": "https://development.sivver.com/"
    },
    {
        "id": "3",
        "setting": "TEMPLATE",
        "value": "default"
    },
    {
        "id": "4",
        "setting": "LANGUAGE_CODE",
        "value": "en"
    },
    {
        "id": "5",
        "setting": "SITETITLE",
        "value": "Sivver Development"
    }
]

Beschreibung

Der Endpunkt zeigt eine Einstellung im System an.

Parameter

Parameter Beschreibung Beispielwert
setting Name des Einstellungsobjektes SITETITLE

HTTP Status Codes

Code Beschreibung
200 OK Einstellungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("setting/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"setting" => "SITETITLE"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "5",
    "setting": "SITETITLE",
    "value": "Sivver Development"
}

Beschreibung

Der Endpunkt fügt eine neue Einstellung in das System ein.

Parameter

Parameter Beschreibung Beispielwert
setting Name des Einstellungsobjektes EXAMPLE
value Wert des Einstellungsobjektes 1234567890

HTTP Status Codes

Code Beschreibung
200 OK Einstellungswert gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("setting/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"setting" => "EXAMPLE",
    
"value" => "1234567890"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt setzt den Wert einer Einstellung im System.

Parameter

Parameter Beschreibung Beispielwert
setting Name des Einstellungsobjektes EXAMPLE
value Wert des Einstellungsobjektes 1234567890

HTTP Status Codes

Code Beschreibung
200 OK Einstellungswert gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("setting/set");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"setting" => "EXAMPLE",
    
"value" => "1234567890"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt zeigt einen Mandanten im System an. (Identifikation an Domain)

Parameter

Parameter Beschreibung Beispielwert
td Domain des Mandanten test.sivver24.com

HTTP Status Codes

Code Beschreibung
200 OK Mandant aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"td" => "test.sivver24.com"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "7",
    "userid": "10001",
    "tenant_domain": "test.sivver24.com",
    "tenant_theme": "default",
    "tenant_database": {
        "host": "localhost",
        "name": "prefix_em10001_60013",
        "user": "prefix_em10001_60013",
        "pass": "1234567890"
    },
    "tenant_login": {
        "username": "em10001",
        "password": "0123456789"
    },
    "contractid": "25",
    "is_demo": "0",
    "database_version": "132"
}

Beschreibung

Der Endpunkt zeigt einen Mandanten im System an. (Identifikation an Installations-ID)

Parameter

Parameter Beschreibung Beispielwert
tid Mandantennummer des Mandanten 7

HTTP Status Codes

Code Beschreibung
200 OK Mandant aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/getByID");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "7",
    "userid": "10001",
    "tenant_domain": "test.sivver24.com",
    "tenant_theme": "default",
    "tenant_database": {
        "host": "localhost",
        "name": "prefix_em10001_60013",
        "user": "prefix_em10001_60013",
        "pass": "1234567890"
    },
    "tenant_login": {
        "username": "em10001",
        "password": "0123456789"
    },
    "contractid": "25",
    "is_demo": "0",
    "database_version": "132"
}

Beschreibung

Der Endpunkt zeigt die Datenbank eines Mandanten im System an. (Identifikation an Domain)

Parameter

Parameter Beschreibung Beispielwert
td Domain des Mandanten test.sivver24.com

HTTP Status Codes

Code Beschreibung
200 OK Mandant-Datenbank aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"td" => "test.sivver24.com"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "host": "localhost",
    "name": "prefix_em10001_60013",
    "user": "prefix_em10001_60013",
    "pass": "1234567890"
}

Beschreibung

Der Endpunkt fügt einen neuen Mandanten in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 10001
tenant_domain Domain des Mandanten test.sivver24.com
tenant_theme Theme des Mandanten default
tenant_database Verschlüsseltes Datenbankobjekt des Mandanten
tenant_login Verschlüsseltes Zugangsdatenobjekt des Mandanten
contractid Vertragsnummer des verknüpften Vertrags 1087
is_demo Der Mandant ist ein Demo-Mandant 0

HTTP Status Codes

Code Beschreibung
200 OK Mandant aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "10001",
    
"tenant_domain" => "test.sivver24.com",
    
"tenant_theme" => "default",
    
"tenant_database" => [
        
"host" => "localhost",
        
"name" => "prefix_em10001_60013",
        
"user" => "prefix_em10001_60013",
        
"pass" => "mySecurePass123"
    
],
    
"tenant_login" => [
        
"username" => "em10001",
        
"password" => "mySecurePass321"
    
],
    
"contractid" => "1087",
    
"is_demo" => "0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert einen Mandanten im System.

Parameter

Parameter Beschreibung Beispielwert
tid Mandantennummer des Mandanten 7
data->userid Kundennummer des Kunden 10001
data->tenant_domain Domain des Mandanten test.sivver24.com
data->tenant_theme Theme des Mandanten default
data->tenant_database Verschlüsseltes Datenbankobjekt des Mandanten
data->tenant_login Verschlüsseltes Zugangsdatenobjekt des Mandanten
data->contractid Vertragsnummer des verknüpften Vertrags 1087
data->is_demo Der Mandant ist ein Demo-Mandant 0

HTTP Status Codes

Code Beschreibung
200 OK Mandant aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7",
    
"data" => [
        
"userid" => "10001",
        
"tenant_domain" => "test.sivver24.com",
        
"tenant_theme" => "default",
        
"tenant_database" => [
            
"host" => "localhost",
            
"name" => "prefix_em10001_60013",
            
"user" => "prefix_em10001_60013",
            
"pass" => "mySecurePass123"
        
],
        
"tenant_login" => [
            
"username" => "em10001",
            
"password" => "mySecurePass321"
        
],
        
"contractid" => "1087",
        
"is_demo" => "0"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Mandanten im System.

Parameter

Parameter Beschreibung Beispielwert
tid Mandantennummer des Mandanten 7

HTTP Status Codes

Code Beschreibung
200 OK Mandant zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt setzt einen Mandanten im System auf die Standardeinstellungen zurück.

Parameter

Parameter Beschreibung Beispielwert
tid Mandantennummer des Mandanten 7

HTTP Status Codes

Code Beschreibung
200 OK Mandant zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/reset");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt gibt das Logo eines Mandanten als relativen Pfad auf dem Webserver zurück.

Parameter

Parameter Beschreibung Beispielwert
td Domain des Mandanten test.sivver24.com

HTTP Status Codes

Code Beschreibung
200 OK Logo gefunden

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/logo");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

uploads/tenants/7.png

Beschreibung

Der Endpunkt setzt das administrative Passwort eines Mandanten für den Hauptaccount.

Parameter

Parameter Beschreibung Beispielwert
tid Mandantennummer des Mandanten 7
password Administratives Passwort des Mandanten mySecurePass123

HTTP Status Codes

Code Beschreibung
200 OK Passwort gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/password");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7",
    
"password" => "mySecurePass123"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt gibt das Theme eines Mandanten als relativen Pfad auf dem Webserver zurück.

Parameter

Parameter Beschreibung Beispielwert
td Domain des Mandanten test.sivver24.com

HTTP Status Codes

Code Beschreibung
200 OK Theme gefunden

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/theme");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"td" => "test.sivver24.com"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

/style.php?theme=panel&color=04BBD3

Beschreibung

Der Endpunkt gibt das Login-Theme eines Mandanten als relativen Pfad auf dem Webserver zurück.

Parameter

Parameter Beschreibung Beispielwert
td Domain des Mandanten test.sivver24.com

HTTP Status Codes

Code Beschreibung
200 OK Theme gefunden

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("tenant/loginTheme");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"td" => "test.sivver24.com"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

/style.php?theme=login&color=04BBD3

Beschreibung

Der Endpunkt listet alle Vorgangsnummern auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Prozessliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("process/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "history_timestamp": "2018-11-15 11:45:36"
    },
    {
        "id": "2",
        "history_timestamp": "2018-11-15 11:45:36"
    },
    {
        "id": "3",
        "history_timestamp": "2018-12-08 15:00:01"
    }
]

Beschreibung

Der Endpunkt zeigt einen Vorgang im System an.

Parameter

Parameter Beschreibung Beispielwert
pid Prozessnummer des Prozesses 2

HTTP Status Codes

Code Beschreibung
200 OK Prozessliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("process/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"pid" => "2"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "2",
    "history_timestamp": "2018-11-15 11:45:36"
}

Beschreibung

Der Endpunkt legt einen Vorgang im System an.

Parameter

Parameter Beschreibung Beispielwert
history_timestamp Letztes Prozessupdate 2018-11-15 11:45:36

HTTP Status Codes

Code Beschreibung
200 OK Prozess aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("process/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"history_timestamp" => "2018-11-15 11:45:36"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

2

Beschreibung

Der Endpunkt modifiziert einen Vorgang im System.

Parameter

Parameter Beschreibung Beispielwert
pid Prozessnummer des Prozesses 2
timestamp Letztes Prozessupdate 2019-01-06 12:19:05

HTTP Status Codes

Code Beschreibung
200 OK Prozess angepasst

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("process/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"pid" => "2",
    
"timestamp" => "2019-01-06 12:19:05"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Vorgang im System.

Parameter

Parameter Beschreibung Beispielwert
pid Prozessnummer des Prozesses 2

HTTP Status Codes

Code Beschreibung
200 OK Prozess zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("process/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"pid" => "2"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Dateien im System (DMS) auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Dateiliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("file/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "33",
        "name": "meinedatei1.pdf",
        "mime": "application/pdf",
        "size": "79838",
        "data": BLOB
        "upload_date": "2019-04-03 18:38:46",
        "file_type": "7",
        "process_id": "103"
    },
    {
        "id": "34",
        "name": "meinedatei2.pdf",
        "mime": "application/pdf",
        "size": "15337",
        "data": BLOB
        "upload_date": "2019-04-03 17:35:46",
        "file_type": "7",
        "process_id": "76"
    }
]

Beschreibung

Der Endpunkt zeigt eine Dateien im System (DMS) an.

Parameter

Parameter Beschreibung Beispielwert
fid Dateinummer der Datei 34

HTTP Status Codes

Code Beschreibung
200 OK Dateiobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("file/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"fid" => "34"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "34",
    "name": "meinedatei2.pdf",
    "mime": "application/pdf",
    "size": "15337",
    "data": BLOB
    "upload_date": "2019-04-03 17:35:46",
    "file_type": "7",
    "process_id": "76"
}

Beschreibung

Der Endpunkt fügt eine neue Datei in das System ein.

Parameter

Parameter Beschreibung Beispielwert
name Name der Datei meinedatei2.pdf
mime Mime-Type der Datei application/pdf
size Größe der Datei in Byte 15337
data Inhalt der Datei BLOB
upload_date Uploaddatum der Datei 2019-04-03 17:35:46
file_type Systeminterner Dateityp 7
process_id Prozessnummer der Datei 76

HTTP Status Codes

Code Beschreibung
200 OK Dateiobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("file/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"name" => "meinedatei2.pdf",
    
"mime" => "application/pdf",
    
"size" => "15337",
    
"data" => $blob,
    
"upload_date" => "2019-04-03 17:35:46",
    
"file_type" => "7",
    
"process_id" => "76"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine Datei im System (DMS).

Parameter

Parameter Beschreibung Beispielwert
fid Dateinummer der Datei 34

HTTP Status Codes

Code Beschreibung
200 OK Dateiobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("file/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"fid" => "34"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt gibt einen Dateityp im System (DMS) an.

Parameter

Parameter Beschreibung Beispielwert
tid Gruppennummer der Dateigruppe 34

HTTP Status Codes

Code Beschreibung
200 OK Dateigruppe aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("file/type");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "7"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

Eingangsrechnung

Beschreibung

Der Endpunkt listet alle Rechnungen / Forderungen im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "75",
        "userid": "9997",
        "positions": "[{"name":"Test","description":"Test","price":"1.00","quantity":"1","take_inventory":"1"}]",
        "status": "2",
        "datetime": "2020-01-21 19:15:14",
        "contract_id": "0",
        "payment_type": "1",
        "archived": "1",
        "process_id": "240",
        "vat_percentage": "0",
        "booked": "1",
        "file_id": "109",
        "booked_to": "[{"account_no_having":"108","account_no_should":54,"amount":"1","receipt_file_id":"109","date_time":"2020-01-21 19:15:14"}]",
        "deptcollection": "0"
    },
    {
        "id": "74",
        "userid": "9997",
        "positions": "[{"name":"Test","description":"Testprodukt","price":"1.00","quantity":"1","take_inventory":null}]",
        "status": "2",
        "datetime": "2019-10-26 17:03:05",
        "contract_id": "0",
        "payment_type": "1",
        "archived": "1",
        "process_id": "233",
        "vat_percentage": "0",
        "booked": "1",
        "file_id": "104",
        "booked_to": "[{"account_no_having":"108","account_no_should":54,"amount":"1","receipt_file_id":"104","date_time":"2019-10-26 17:03:05"}]",
        "deptcollection": "0"
    }
]

Beschreibung

Der Endpunkt zeigt eine Rechnung im System an.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "75",
    "userid": "9997",
    "positions": "[{"name":"Test","description":"Test","price":"1.00","quantity":"1","take_inventory":"1"}]",
    "status": "2",
    "datetime": "2020-01-21 19:15:14",
    "contract_id": "0",
    "payment_type": "1",
    "archived": "1",
    "process_id": "240",
    "vat_percentage": "0",
    "booked": "1",
    "file_id": "109",
    "booked_to": "[{"account_no_having":"108","account_no_should":54,"amount":"1","receipt_file_id":"109","date_time":"2020-01-21 19:15:14"}]",
    "deptcollection": "0"
}

Beschreibung

Der Endpunkt fügt eine Rechnung in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 9997
positions Rechnungspositionen
status Status der Rechnung 2
datetime Datum der Rechnung 2020-01-21 19:15:14
contract_id Vertragsnummer des Vertrages 0
payment_type Konditionsvorlage der Rechnung 1
archived Archivvermerk der Rechnung 1
process_id Prozessnummer des Prozesses 240
vat_percentage Mehrwertsteuersatz der Rechnung 10
booked Rechnung wurde kontiert 1
file_id Dateinummer der archivierten Rechnung 109
booked_to Rechnung wurde auf folgende Konten verbucht
deptcollection Rechnung wurde bereits an den Inkassodienstleister übermittelt 0

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "",
    
"positions" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ]),
    
"status" => "2",
    
"datetime" => "2020-01-21 19:15:14",
    
"contract_id" => "0",
    
"payment_type" => "1",
    
"archived" => "1",
    
"process_id" => "240",
    
"vat_percentage" => "0",
    
"booked" => "1",
    
"file_id" => "109",
    
"booked_to" => json_encode([
        (object)[
            
"account_no_having" => "108",
            
"account_no_should" => "54",
            
"amount" => "1",
            
"receipt_file_id" => "109",
            
"date_time" => "2020-01-21 19:15:14"
        
]
    ]),
    
"deptcollection" => "0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75
data->userid Kundennummer des Kunden 9997
data->positions Rechnungspositionen
data->status Status der Rechnung 2
data->datetime Datum der Rechnung 2020-01-21 19:15:14
data->contract_id Vertragsnummer des Vertrages 0
data->payment_type Konditionsvorlage der Rechnung 1
data->archived Archivvermerk der Rechnung 1
data->process_id Prozessnummer des Prozesses 240
data->vat_percentage Mehrwertsteuersatz der Rechnung 10
data->booked Rechnung wurde kontiert 1
data->file_id Dateinummer der archivierten Rechnung 109
data->booked_to Rechnung wurde auf folgende Konten verbucht
data->deptcollection Rechnung wurde bereits an den Inkassodienstleister übermittelt 0

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75",
    
"data" => [
        
"userid" => "",
        
"positions" => json_encode([
            [
                
"name" => "Test",
                
"description" => "Test",
                
"price" => "1.00",
                
"quantity" => "1",
                
"take_inventory" => "1"
            
]
        ]),
        
"status" => "2",
        
"datetime" => "2020-01-21 19:15:14",
        
"contract_id" => "0",
        
"payment_type" => "1",
        
"archived" => "1",
        
"process_id" => "240",
        
"vat_percentage" => "0",
        
"booked" => "1",
        
"file_id" => "109",
        
"booked_to" => json_encode([
            (object)[
                
"account_no_having" => "108",
                
"account_no_should" => "54",
                
"amount" => "1",
                
"receipt_file_id" => "109",
                
"date_time" => "2020-01-21 19:15:14"
            
]
        ]),
        
"deptcollection" => "0"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt berechnet den Wert für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnungswert ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/value");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

1.00

Beschreibung

Der Endpunkt ermittelt den aktuellen Status für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsstatus ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/status");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

Bezahlt

Beschreibung

Der Endpunkt setzt den aktuellen Status für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75
status Status der Rechnung 2

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsstatus gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/setStatus");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75",
    
"status" => "2"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt ermittelt die Positionen für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnungspositionen ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/positions");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "name": "Test",
        "description": "Test",
        "price": "1.00",
        "quantity": "1",
        "take_inventory": "1"
    }
]

Beschreibung

Der Endpunkt setzt die Positionen für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75
data Positionen der Rechnung

HTTP Status Codes

Code Beschreibung
200 OK Rechnungspositionen gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/setStatus");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75",
    
"data" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ])
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt generiert eine PDF Datei für eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK PDF-Datei generiert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/pdf");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

BLOB

Beschreibung

Der Endpunkt generiert eine PDF Datei für eine Rechnung im System und versendet diese per E-Mail an den Kunden.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK PDF-Datei versendet

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/send");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt archiviert eine Rechnung im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 75

HTTP Status Codes

Code Beschreibung
200 OK Rechnung archiviert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("invoice/archive");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Verträge im System auf.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9997

HTTP Status Codes

Code Beschreibung
200 OK Vertragsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/list");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9997"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "24",
        "userid": "9997",
        "positions": "[{"name":"Test","description":"Testprodukt","price":"1.00","quantity":"1"}]",
        "contract_created": "2019-10-09 19:54:15",
        "last_invoice": "1000-01-01 00:00:00",
        "active": "0",
        "contract_type": "1",
        "process_id": "199",
        "vat_percentage": "0",
        "cancelled_on": "2019-10-09 20:44:27"
    },
    {
        "id": "25",
        "userid": "9997",
        "positions": "[{"name":"Test","description":"Testprodukt","price":"1.00","quantity":"1"}]",
        "contract_created": "2019-12-19 08:56:11",
        "last_invoice": "1000-01-01 00:00:00",
        "active": "0",
        "contract_type": "1",
        "process_id": "210",
        "vat_percentage": "0",
        "cancelled_on": "2019-10-09 20:44:27"
    }
]

Beschreibung

Der Endpunkt zeigt einen Vertrag im System an.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer der Vertrags 75

HTTP Status Codes

Code Beschreibung
200 OK Vertragsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"cid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "24",
    "userid": "9997",
    "positions": "[{"name":"Test","description":"Testprodukt","price":"1.00","quantity":"1"}]",
    "contract_created": "2019-10-09 19:54:15",
    "last_invoice": "1000-01-01 00:00:00",
    "active": "0",
    "contract_type": "1",
    "process_id": "199",
    "vat_percentage": "0",
    "cancelled_on": "2019-10-09 20:44:27"
}

Beschreibung

Der Endpunkt fügt einen Vertrag in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 9997
positions Rechnungspositionen
contract_created Vertrag wurde an diesem Datum erstellt 2019-10-09 19:54:15
last_invoice Vertrag wurde an diesem Datum abgeschlossen 1000-01-01 00:00:00
active Vertrag ist aktiv 0
contract_type Vertragstypnummer des Vertragstyps 1
process_id Prozessnummer des Prozesses 240
vat_percentage Mehrwertsteuersatz der Rechnung 10
cancelled_on Vertrag wurde an diesem Datum gekündigt 2019-10-09 20:44:27

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "9997",
    
"positions" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ]),
    
"contract_created" => "2019-10-09 19:54:15",
    
"last_invoice" => "1000-01-01 00:00:00",
    
"active" => "0",
    
"contract_type" => "1",
    
"process_id" => "199",
    
"vat_percentage" => "0",
    
"cancelled_on" => "2019-10-09 20:44:27"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt verändert einen Vertrag im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 24
data->userid Kundennummer des Kunden 9997
data->positions Rechnungspositionen
data->contract_created Vertrag wurde an diesem Datum erstellt 2019-10-09 19:54:15
data->last_invoice Vertrag wurde an diesem Datum abgeschlossen 1000-01-01 00:00:00
data->active Vertrag ist aktiv 0
data->contract_type Vertragstypnummer des Vertragstyps 0
data->process_id Prozessnummer des Prozesses 240
data->vat_percentage Mehrwertsteuersatz der Rechnung 10
data->cancelled_on Vertrag wurde an diesem Datum gekündigt 2019-10-09 20:44:27

HTTP Status Codes

Code Beschreibung
200 OK Rechnungsobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"cid" => "24",
    
"data" => [
        
"userid" => "9997",
        
"positions" => json_encode([
            [
                
"name" => "Test",
                
"description" => "Test",
                
"price" => "1.00",
                
"quantity" => "1",
                
"take_inventory" => "1"
            
]
        ]),
        
"contract_created" => "2019-10-09 19:54:15",
        
"last_invoice" => "1000-01-01 00:00:00",
        
"active" => "0",
        
"contract_type" => "1",
        
"process_id" => "199",
        
"vat_percentage" => "0",
        
"cancelled_on" => "2019-10-09 20:44:27"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht einen Vertrag im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 75

HTTP Status Codes

Code Beschreibung
200 OK Vertragsobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"cid" => "24"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt berechnet den Wert für eines Vertrags im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer eines Vertrags 24

HTTP Status Codes

Code Beschreibung
200 OK Vertragswert ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/value");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"cid" => "24"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

1.00

Beschreibung

Der Endpunkt ermittelt den aktuellen Status für eines Vertrags im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 24

HTTP Status Codes

Code Beschreibung
200 OK Vertragsstatus ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/status");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"cid" => "24"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

Aktiv

Beschreibung

Der Endpunkt ermittelt die Positionen für einen Vertrag im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 24

HTTP Status Codes

Code Beschreibung
200 OK Vertragspositionen ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/positions");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "24"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "name": "Test",
        "description": "Test",
        "price": "1.00",
        "quantity": "1",
        "take_inventory": "1"
    }
]

Beschreibung

Der Endpunkt setzt die Positionen für einen Vertrag im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 24
data Positionen des Vertrags

HTTP Status Codes

Code Beschreibung
200 OK Vertragspositionen gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/setStatus");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "24",
    
"data" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ])
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt ermittelt das letzte Rechnungsobjekt für einen Vertrag im System.

Parameter

Parameter Beschreibung Beispielwert
cid Vertragsnummer des Vertrags 75

HTTP Status Codes

Code Beschreibung
200 OK Letzte Rechnung ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("contract/lastInvoice");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "24"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "75",
    "userid": "9997",
    "positions": "[{"name":"Test","description":"Test","price":"1.00","quantity":"1","take_inventory":"1"}]",
    "status": "2",
    "datetime": "2020-01-21 19:15:14",
    "contract_id": "24",
    "payment_type": "1",
    "archived": "1",
    "process_id": "240",
    "vat_percentage": "0",
    "booked": "1",
    "file_id": "109",
    "booked_to": "[{"account_no_having":"108","account_no_should":54,"amount":"1","receipt_file_id":"109","date_time":"2020-01-21 19:15:14"}]",
    "deptcollection": "0"
}

Beschreibung

Der Endpunkt listet alle Angebote im System auf.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9997

HTTP Status Codes

Code Beschreibung
200 OK Angebotsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/list");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9997"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "14",
        "userid": "9997",
        "positions": "[]",
        "status": "2",
        "datetime": "2019-10-26 11:00:38",
        "payment_type": "1",
        "process_id": "232",
        "vat_percentage": "0",
        "invoice_created": "0",
        "archived": "0",
        "is_contract": "0",
        "offer_expires": "2019-10-26"
    },
    {
        "id": "13",
        "userid": "9997",
        "positions": "[]",
        "status": "0",
        "datetime": "2019-10-26 10:59:50",
        "payment_type": "1",
        "process_id": "231",
        "vat_percentage": "0",
        "invoice_created": "0",
        "archived": "0",
        "is_contract": "0",
        "offer_expires": "0000-00-00"
    }
]

Beschreibung

Der Endpunkt zeigt ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 13

HTTP Status Codes

Code Beschreibung
200 OK Angebotsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "13"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "13",
    "userid": "9997",
    "positions": "[]",
    "status": "0",
    "datetime": "2019-10-26 10:59:50",
    "payment_type": "1",
    "process_id": "231",
    "vat_percentage": "0",
    "invoice_created": "0",
    "archived": "0",
    "is_contract": "0",
    "offer_expires": "0000-00-00"
}

Beschreibung

Der Endpunkt fügt ein Angebot in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 9997
positions Angebotspositionen
status Status des Angebots 2
datetime Datum des Angebots 2019-10-26 11:00:38
payment_type Konditionsvorlage für das Angebot 1
process_id Prozessnummer des Prozesses 232
vat_percentage Mehrwertsteuersatz des Angebots 19
invoice_created Eine Rechnung wurde erstellt 0
archived Angebot archiviert 0
is_contract Angebot ist Vorlage für einen Vertrag 0
offer_expires Angebot läuft an diesem Datum aus 2019-10-26

HTTP Status Codes

Code Beschreibung
200 OK Angebotsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "9997",
    
"positions" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ]),
    
"status" => "2",
    
"datetime" => "2019-10-26 11:00:38",
    
"payment_type" => "1",
    
"process_id" => "232",
    
"vat_percentage" => "19",
    
"invoice_created" => "0",
    
"archived" => "0",
    
"is_contract" => "0",
    
"offer_expires" => "2019-10-26"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 14
data->userid Kundennummer des Kunden 9997
data->positions Angebotspositionen
data->status Status des Angebots 2
data->datetime Datum des Angebots 2019-10-26 11:00:38
data->payment_type Konditionsvorlage für das Angebot 1
data->process_id Prozessnummer des Prozesses 232
data->vat_percentage Mehrwertsteuersatz des Angebots 19
data->invoice_created Eine Rechnung wurde erstellt 0
data->archived Angebot archiviert 0
data->is_contract Angebot ist Vorlage für einen Vertrag 0
data->offer_expires Angebot läuft an diesem Datum aus 2019-10-26

HTTP Status Codes

Code Beschreibung
200 OK Angebotsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "14",
    
"data" => [
        
"userid" => "9997",
        
"positions" => json_encode([
            [
                
"name" => "Test",
                
"description" => "Test",
                
"price" => "1.00",
                
"quantity" => "1",
                
"take_inventory" => "1"
            
]
        ]),
        
"status" => "2",
        
"datetime" => "2019-10-26 11:00:38",
        
"payment_type" => "1",
        
"process_id" => "232",
        
"vat_percentage" => "19",
        
"invoice_created" => "0",
        
"archived" => "0",
        
"is_contract" => "0",
        
"offer_expires" => "2019-10-26"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 14

HTTP Status Codes

Code Beschreibung
200 OK Angebotsobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "14"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt berechnet den Wert für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK Angebotswert ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/value");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

1.00

Beschreibung

Der Endpunkt ermittelt den aktuellen Status für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK Angebotsstatus ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/status");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

Aktiv

Beschreibung

Der Endpunkt setzt den aktuellen Status für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75
status Status des Angebots 2

HTTP Status Codes

Code Beschreibung
200 OK Angebotsstatus gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/setStatus");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75",
    
"status" => "2"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt ermittelt die Positionen für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK Angebotspositionen ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/positions");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "name": "Test",
        "description": "Test",
        "price": "1.00",
        "quantity": "1",
        "take_inventory": "1"
    }
]

Beschreibung

Der Endpunkt setzt die Positionen für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75
data Positionen des Angebots

HTTP Status Codes

Code Beschreibung
200 OK Angebotspositionen gesetzt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/setStatus");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75",
    
"data" => json_encode([
        [
            
"name" => "Test",
            
"description" => "Test",
            
"price" => "1.00",
            
"quantity" => "1",
            
"take_inventory" => "1"
        
]
    ])
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt generiert eine PDF Datei für ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK PDF-Datei generiert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/pdf");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

BLOB

Beschreibung

Der Endpunkt generiert eine PDF Datei für ein Angebot im System und versendet diese per E-Mail an den Kunden.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK PDF-Datei versendet

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/send");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt archiviert ein Angebot im System.

Parameter

Parameter Beschreibung Beispielwert
oid Angebotsnummer des Angebots 75

HTTP Status Codes

Code Beschreibung
200 OK Angebot archiviert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("offer/archive");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"oid" => "75"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle E-Mail Templates im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "2",
        "template_name": "ticket_closed_client",
        "subject": "Ihr Ticket wurde geschlossen - ID: tid",
        "text": "<html>
    <body style="margin: 0; font-family: Arial;">
        <div style="width: 1000px; max-width: 100%; margin: 20px auto 0 auto;">
            <header style="background-color: #002154; font-size: 30px; padding: 20px; text-align: center; color: #fff;">
                Sivver
            </header>
            <section style="padding: 20px; background-color: #fafafa;">
                <h1 style="margin-top: 0; margin-bottom: 0.83em;">Ticket (tid)</h1>
                <p style="margin: 0; margin-top: 1em;">
                    Sehr geehrte/r Herr/Frau aln,
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Ihr Ticket (ID: tid) wurde geschlossen.
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Mit freundlichen Grüßen,<br \>
                    Ihr Sivver Team
                </p>
            </section>
            <footer style="color: #c0c0c0; text-align: center; font-size: 10pt; background-color: #eee; padding: 10px 0;">
                <a href="https://sivver.com/impressum" style="color: #c0c0c0; text-decoration: none;">Impressum</a> | <a href="https://sivver.com/agb" style="color: #c0c0c0; text-decoration: none;">Allgemeine Geschäftsbedingungen</a> | <a href="https://sivver.com/datenschutz" style="color: #c0c0c0; text-decoration: none;">Datenschutzerklärung</a>
            </footer>
        </div>
    </body>
</html>"
    },
    {
        "id": "3",
        "template_name": "ticket_closed_admin",
        "subject": "Ein Ticket wurde geschlossen - ID: tid",
        "text": "<html>
    <body style="margin: 0; font-family: Arial;">
        <div style="width: 1000px; max-width: 100%; margin: 20px auto 0 auto;">
            <header style="background-color: #002154; font-size: 30px; padding: 20px; text-align: center; color: #fff;">
                Sivver
            </header>
            <section style="padding: 20px; background-color: #fafafa;">
                <h1 style="margin-top: 0; margin-bottom: 0.83em;">Ticket (tid)</h1>
                <p style="margin: 0; margin-top: 1em;">
                    Sehr geehrte/r Herr/Frau aln,
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Ein Ticket (ID: tid) wurde geschlossen.
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Mit freundlichen Grüßen,<br \>
                    Ihr Sivver Team
                </p>
            </section>
            <footer style="color: #c0c0c0; text-align: center; font-size: 10pt; background-color: #eee; padding: 10px 0;">
                <a href="https://sivver.com/impressum" style="color: #c0c0c0; text-decoration: none;">Impressum</a> | <a href="https://sivver.com/agb" style="color: #c0c0c0; text-decoration: none;">Allgemeine Geschäftsbedingungen</a> | <a href="https://sivver.com/datenschutz" style="color: #c0c0c0; text-decoration: none;">Datenschutzerklärung</a>
            </footer>
        </div>
    </body>
</html>"
    }
]

Beschreibung

Der Endpunkt listet alle E-Mail Templates im System auf.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 3

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/get");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "3",
    "template_name": "ticket_closed_admin",
    "subject": "Ein Ticket wurde geschlossen - ID: tid",
    "text": "<html>
    <body style="margin: 0; font-family: Arial;">
        <div style="width: 1000px; max-width: 100%; margin: 20px auto 0 auto;">
            <header style="background-color: #002154; font-size: 30px; padding: 20px; text-align: center; color: #fff;">
                Sivver
            </header>
            <section style="padding: 20px; background-color: #fafafa;">
                <h1 style="margin-top: 0; margin-bottom: 0.83em;">Ticket (tid)</h1>
                <p style="margin: 0; margin-top: 1em;">
                    Sehr geehrte/r Herr/Frau aln,
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Ein Ticket (ID: tid) wurde geschlossen.
                </p>
                <p style="margin: 0; margin-top: 1em;">
                    Mit freundlichen Grüßen,<br \>
                    Ihr Sivver Team
                </p>
            </section>
            <footer style="color: #c0c0c0; text-align: center; font-size: 10pt; background-color: #eee; padding: 10px 0;">
                <a href="https://sivver.com/impressum" style="color: #c0c0c0; text-decoration: none;">Impressum</a> | <a href="https://sivver.com/agb" style="color: #c0c0c0; text-decoration: none;">Allgemeine Geschäftsbedingungen</a> | <a href="https://sivver.com/datenschutz" style="color: #c0c0c0; text-decoration: none;">Datenschutzerklärung</a>
            </footer>
        </div>
    </body>
</html>"
}

Beschreibung

Der Endpunkt fügt eine E-Mail Vorlage in das System ein.

Parameter

Parameter Beschreibung Beispielwert
template_name Name der Vorlage example_template
subject Betreffzeile der Vorlage Ihr Betreff hier
text Inhalt der Vorlage Ihr Inhalt hier

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"template_name" => "ticket_closed_client",
    
"subject" => "Ihr Ticket wurde geschlossen - ID: tid",
    
"text" => "<html>
    <body style="
margin0font-familyArial;">
        <div style="
width1000pxmax-width100%; margin20px auto 0 auto;">
            <header style="
background-color#002154; font-size: 30px; padding: 20px; text-align: center; color: #fff;">
                
Sivver
            
</header>
            <
section style="padding: 20px; background-color: #fafafa;">
                <
h1 style="margin-top: 0; margin-bottom: 0.83em;">Ticket (tid)</h1>
                <
p style="margin: 0; margin-top: 1em;">
                    
Sehr geehrte/r Herr/Frau cln,
                </
p>
                <
p style="margin: 0; margin-top: 1em;">
                    
Ihr Ticket (IDtidwurde geschlossen.
                </
p>
                <
p style="margin: 0; margin-top: 1em;">
                    
Mit freundlichen Grüßen,<br \>
                    
Ihr Sivver Team
                
</p>
            </
section>
            <
footer style="color: #c0c0c0; text-align: center; font-size: 10pt; background-color: #eee; padding: 10px 0;">
                <
a href="https://sivver.com/impressum" style="color: #c0c0c0; text-decoration: none;">Impressum</a> | <a href="https://sivver.com/agb" style="color: #c0c0c0; text-decoration: none;">Allgemeine Geschäftsbedingungen</a> | <a href="https://sivver.com/datenschutz" style="color: #c0c0c0; text-decoration: none;">Datenschutzerklärung</a>
            </
footer>
        </
div>
    </
body>
</
html>"
];
$api->parameters($parameters);

$result = $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert eine E-Mail Vorlage in dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2
data->template_name Name der Vorlage example_template
data->subject Betreffzeile der Vorlage Ihr Betreff hier
data->text Inhalt der Vorlage Ihr Inhalt hier

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3",
    
"data" => [
        
"template_name" => "ticket_closed_client",
        
"subject" => "Ihr Ticket wurde geschlossen - ID: tid",
        
"text" => "<html>
    <body style="
margin0font-familyArial;">
        <div style="
width1000pxmax-width100%; margin20px auto 0 auto;">
            <header style="
background-color#002154; font-size: 30px; padding: 20px; text-align: center; color: #fff;">
                
Sivver
            
</header>
            <
section style="padding: 20px; background-color: #fafafa;">
                <
h1 style="margin-top: 0; margin-bottom: 0.83em;">Ticket (tid)</h1>
                <
p style="margin: 0; margin-top: 1em;">
                    
Sehr geehrte/r Herr/Frau cln,
                </
p>
                <
p style="margin: 0; margin-top: 1em;">
                    
Ihr Ticket (IDtidwurde geschlossen.
                </
p>
                <
p style="margin: 0; margin-top: 1em;">
                    
Mit freundlichen Grüßen,<br \>
                    
Ihr Sivver Team
                
</p>
            </
section>
            <
footer style="color: #c0c0c0; text-align: center; font-size: 10pt; background-color: #eee; padding: 10px 0;">
                <
a href="https://sivver.com/impressum" style="color: #c0c0c0; text-decoration: none;">Impressum</a> | <a href="https://sivver.com/agb" style="color: #c0c0c0; text-decoration: none;">Allgemeine Geschäftsbedingungen</a> | <a href="https://sivver.com/datenschutz" style="color: #c0c0c0; text-decoration: none;">Datenschutzerklärung</a>
            </
footer>
        </
div>
    </
body>
</
html>"
    ]
];
$api->parameters($parameters);

$result = $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine E-Mail Vorlage in dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt generiert eine E-Mail Vorlage mit einem Datenexport aus dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2
data Daten für die Variablen der Vorlage 2

HTTP Status Codes

Code Beschreibung
200 OK Vorlage interpretiert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/generate");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3",
    
"data" => $data
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

STRING

Beschreibung

Der Endpunkt sendet eine E-Mail Vorlage mit einem Datenexport aus dem System an die angegebene E-Mail Adresse.

Parameter

Parameter Beschreibung Beispielwert
email E-Mail Adresse des Empfängers [email protected]
data Daten für die Variablen der Vorlage ARRAY

HTTP Status Codes

Code Beschreibung
200 OK E-Mail versendet

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("mailTemplate/send");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"email" => "[email protected]",
    
"data" => $data
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle PDF Templates im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "template_name": "general",
        "content": "<html>
    <head>
        <style>
            * {
                font-family: 'Arial', 'Helvetica';
            }
            html, html body {
                margin: 0;
                padding: 0;
            }
            body {
                background-color: #c6c6c6;
            }
            .head {
                position: absolute;
                height: 104mm;
                width: 100%;
                left: 0;
                top: 0;
                background-color: #fff;
            }
            .logo {
                position: absolute;
                top: 19mm;
                left: 23mm;
                width: 45mm;
            }
            .address {
                position: absolute;
                top: 45mm;
                left: 20mm;
                height: 45mm;
                width: 85mm;
                z-index: 2;
                padding: 5mm 3mm;
                font-size: 11pt;
            }
            .address span {
                font-size: 11px;
                display: block;
                margin-bottom: 20px;
            }
            .sidebar {
                position: absolute;
                right: 0;
                top: 0;
                width: 56mm;
                height: 94mm;
                background-color: #04BBD3;
                padding: 5mm;
                color: #fff;
                font-size: 11px;
            }
            .content {
                position: absolute;
                left: 0;
                top: 108mm;
                width: 100%;
                height: 189mm;
                background-color: #fff;
                padding-left: 20mm;
                padding-right: 20mm;
                padding-top: 15mm;
                padding-bottom: 15mm;
                font-size: 11pt;
            }
            table {
                width: 100%;
            }
            table thead {
                font-weight: bold;
            }
            h2 {
                padding-top: 0;
                margin-top: 0;
            }
        </style>
    </head>
    <body>
        <div class="a4">
            <div class="head">
                <img src="{{LOGO}}" class="logo" \>
                <div class="address">
                    <span>{{company[name]}} · {{company[street]}} {{company[housenumber]}} · {{company[postalcode]}} {{company[city]}}</span>
                    {{client[company]}}<br \>
                    {{client[firstname]}} {{client[lastname]}}<br \>
                    {{client[street]}} {{client[housenumber]}}<br \>
                    {{client[postalcode]}} {{client[city]}}<br \>
                    {{client[state]}}, {{client[country]}}
                </div>
                <div class="sidebar">
                    {{SIDEBAR}}
                </div>
            </div>
            <div class="content">
                {{CONTENT}}
            </div>
        </div>
</body></html>"
    }
]

Beschreibung

Der Endpunkt listet alle PDF Templates im System auf.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 3

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/get");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "1",
    "template_name": "general",
    "content": "<html>
    <head>
        <style>
            * {
                font-family: 'Arial', 'Helvetica';
            }
            html, html body {
                margin: 0;
                padding: 0;
            }
            body {
                background-color: #c6c6c6;
            }
            .head {
                position: absolute;
                height: 104mm;
                width: 100%;
                left: 0;
                top: 0;
                background-color: #fff;
            }
            .logo {
                position: absolute;
                top: 19mm;
                left: 23mm;
                width: 45mm;
            }
            .address {
                position: absolute;
                top: 45mm;
                left: 20mm;
                height: 45mm;
                width: 85mm;
                z-index: 2;
                padding: 5mm 3mm;
                font-size: 11pt;
            }
            .address span {
                font-size: 11px;
                display: block;
                margin-bottom: 20px;
            }
            .sidebar {
                position: absolute;
                right: 0;
                top: 0;
                width: 56mm;
                height: 94mm;
                background-color: #04BBD3;
                padding: 5mm;
                color: #fff;
                font-size: 11px;
            }
            .content {
                position: absolute;
                left: 0;
                top: 108mm;
                width: 100%;
                height: 189mm;
                background-color: #fff;
                padding-left: 20mm;
                padding-right: 20mm;
                padding-top: 15mm;
                padding-bottom: 15mm;
                font-size: 11pt;
            }
            table {
                width: 100%;
            }
            table thead {
                font-weight: bold;
            }
            h2 {
                padding-top: 0;
                margin-top: 0;
            }
        </style>
    </head>
    <body>
        <div class="a4">
            <div class="head">
                <img src="{{LOGO}}" class="logo" \>
                <div class="address">
                    <span>{{company[name]}} · {{company[street]}} {{company[housenumber]}} · {{company[postalcode]}} {{company[city]}}</span>
                    {{client[company]}}<br \>
                    {{client[firstname]}} {{client[lastname]}}<br \>
                    {{client[street]}} {{client[housenumber]}}<br \>
                    {{client[postalcode]}} {{client[city]}}<br \>
                    {{client[state]}}, {{client[country]}}
                </div>
                <div class="sidebar">
                    {{SIDEBAR}}
                </div>
            </div>
            <div class="content">
                {{CONTENT}}
            </div>
        </div>
</body></html>"
}

Beschreibung

Der Endpunkt fügt eine PDF Vorlage in das System ein.

Parameter

Parameter Beschreibung Beispielwert
template_name Name der Vorlage example_template
content Inhalt der Vorlage Ihr Inhalt hier

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"template_name" => "general",
    
"content" => "<html>
    <head>
        <style>
            * {
                font-family: 'Arial', 'Helvetica';
            }
            html, html body {
                margin: 0;
                padding: 0;
            }
            body {
                background-color: #c6c6c6;
            }
            .head {
                position: absolute;
                height: 104mm;
                width: 100%;
                left: 0;
                top: 0;
                background-color: #fff;
            }
            .logo {
                position: absolute;
                top: 19mm;
                left: 23mm;
                width: 45mm;
            }
            .address {
                position: absolute;
                top: 45mm;
                left: 20mm;
                height: 45mm;
                width: 85mm;
                z-index: 2;
                padding: 5mm 3mm;
                font-size: 11pt;
            }
            .address span {
                font-size: 11px;
                display: block;
                margin-bottom: 20px;
            }
            .sidebar {
                position: absolute;
                right: 0;
                top: 0;
                width: 56mm;
                height: 94mm;
                background-color: #04BBD3;
                padding: 5mm;
                color: #fff;
                font-size: 11px;
            }
            .content {
                position: absolute;
                left: 0;
                top: 108mm;
                width: 100%;
                height: 189mm;
                background-color: #fff;
                padding-left: 20mm;
                padding-right: 20mm;
                padding-top: 15mm;
                padding-bottom: 15mm;
                font-size: 11pt;
            }
            table {
                width: 100%;
            }
            table thead {
                font-weight: bold;
            }
            h2 {
                padding-top: 0;
                margin-top: 0;
            }
        </style>
    </head>
    <body>
        <div class="
a4">
            <div class="
head">
                <img src="
{{LOGO}}" class="logo" \>
                <div class="
address">
                    <span>{{company[name]}} · {{company[street]}} {{company[housenumber]}} · {{company[postalcode]}} {{company[city]}}</span>
                    {{client[company]}}<br \>
                    {{client[firstname]}} {{client[lastname]}}<br \>
                    {{client[street]}} {{client[housenumber]}}<br \>
                    {{client[postalcode]}} {{client[city]}}<br \>
                    {{client[state]}}, {{client[country]}}
                </div>
                <div class="
sidebar">
                    {{SIDEBAR}}
                </div>
            </div>
            <div class="
content">
                {{CONTENT}}
            </div>
        </div>
</body></html>"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert eine PDF Vorlage in dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2
data->template_name Name der Vorlage example_template
data->content Inhalt der Vorlage Ihr Inhalt hier

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3",
    
"data" => [
        
"template_name" => "general",
        
"content" => "<html>
    <head>
        <style>
            * {
                font-family: 'Arial', 'Helvetica';
            }
            html, html body {
                margin: 0;
                padding: 0;
            }
            body {
                background-color: #c6c6c6;
            }
            .head {
                position: absolute;
                height: 104mm;
                width: 100%;
                left: 0;
                top: 0;
                background-color: #fff;
            }
            .logo {
                position: absolute;
                top: 19mm;
                left: 23mm;
                width: 45mm;
            }
            .address {
                position: absolute;
                top: 45mm;
                left: 20mm;
                height: 45mm;
                width: 85mm;
                z-index: 2;
                padding: 5mm 3mm;
                font-size: 11pt;
            }
            .address span {
                font-size: 11px;
                display: block;
                margin-bottom: 20px;
            }
            .sidebar {
                position: absolute;
                right: 0;
                top: 0;
                width: 56mm;
                height: 94mm;
                background-color: #04BBD3;
                padding: 5mm;
                color: #fff;
                font-size: 11px;
            }
            .content {
                position: absolute;
                left: 0;
                top: 108mm;
                width: 100%;
                height: 189mm;
                background-color: #fff;
                padding-left: 20mm;
                padding-right: 20mm;
                padding-top: 15mm;
                padding-bottom: 15mm;
                font-size: 11pt;
            }
            table {
                width: 100%;
            }
            table thead {
                font-weight: bold;
            }
            h2 {
                padding-top: 0;
                margin-top: 0;
            }
        </style>
    </head>
    <body>
        <div class="
a4">
            <div class="
head">
                <img src="
{{LOGO}}" class="logo" \>
                <div class="
address">
                    <span>{{company[name]}} · {{company[street]}} {{company[housenumber]}} · {{company[postalcode]}} {{company[city]}}</span>
                    {{client[company]}}<br \>
                    {{client[firstname]}} {{client[lastname]}}<br \>
                    {{client[street]}} {{client[housenumber]}}<br \>
                    {{client[postalcode]}} {{client[city]}}<br \>
                    {{client[state]}}, {{client[country]}}
                </div>
                <div class="
sidebar">
                    {{SIDEBAR}}
                </div>
            </div>
            <div class="
content">
                {{CONTENT}}
            </div>
        </div>
</body></html>"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine PDF Vorlage in dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2

HTTP Status Codes

Code Beschreibung
200 OK Vorlagenobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt generiert eine PDF Vorlage mit einem Datenexport aus dem System.

Parameter

Parameter Beschreibung Beispielwert
tid Vorlagennummer der Vorlage 2
data Daten für die Variablen der Vorlage 2

HTTP Status Codes

Code Beschreibung
200 OK Vorlage interpretiert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("pdfTemplate/generate");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "3",
    
"data" => $data
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

STRING

Beschreibung

Der Endpunkt verschlüsselt Daten mit Hilfe eines AES-Schlüssels (2-Wege-Verschlüsselung).

Parameter

Parameter Beschreibung Beispielwert
string Zu verschlüsselnder Text meinText

HTTP Status Codes

Code Beschreibung
200 OK Text verschlüsselt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/encrypt");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"string" => "meinText"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

5Eh5idzqk6C9Aw4HQggPImZ0OIYWiIC4zPuI2W1OQutYYFpFhGRCMRXUdCe0

Beschreibung

Der Endpunkt entschlüsselt Daten mit Hilfe eines AES-Schlüssels (2-Wege-Verschlüsselung).

Parameter

Parameter Beschreibung Beispielwert
string Zu entschlüsselnder Text 5Eh5idzqk6C9Aw4HQggPImZ0OIYWiIC4zPuI2W1OQutYYFpFhGRCMRXUdCe0

HTTP Status Codes

Code Beschreibung
200 OK Text entschlüsselt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/decrypt");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"string" => "5Eh5idzqk6C9Aw4HQggPImZ0OIYWiIC4zPuI2W1OQutYYFpFhGRCMRXUdCe0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

meinText

Beschreibung

Der Endpunkt generiert eine potentiell sichere, zufällige Zeichenfolge (z.B. für Passwörter).

Parameter

Parameter Beschreibung Beispielwert
length Länge der Zeichenfolge 16

HTTP Status Codes

Code Beschreibung
200 OK Text generiert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/generateSecureString");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"length" => "8"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

ImZ0OIYW

Beschreibung

Der Endpunkt bestätigt einen Hashwert.

Parameter

Parameter Beschreibung Beispielwert
string Hash Wert $2y$10$cDObemgWCbEqyKM1/pV8Hey/yhZhC9r

HTTP Status Codes

Code Beschreibung
200 OK Hash valide

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/verifyHash");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"string" => "$2y$10$cDObemgWCbEqyKM1/pV8Hey/yhZhC9r"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt überprüft ob ein Hashwert abgelaufen ist und neu generiert werden muss.

Parameter

Parameter Beschreibung Beispielwert
string Hash Wert $2y$10$cDObemgWCbEqyKM1/pV8Hey/yhZhC9r

HTTP Status Codes

Code Beschreibung
200 OK Hash valide

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/needsRehash");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"string" => "$2y$10$cDObemgWCbEqyKM1/pV8Hey/yhZhC9r"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt generiert aus Klartext einen Hashwert.

Parameter

Parameter Beschreibung Beispielwert
string Zu verschlüsselnder Text meinText

HTTP Status Codes

Code Beschreibung
200 OK Text verschlüsselt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("encryption/makeHash");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"string" => "meinText"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

$2y$10$cDObemgWCbEqyKM1/pV8Hey/yhZhC9r

Beschreibung

Der Endpunkt ermittelt den aktuellen Zustand eines Tickets im System.

Parameter

Parameter Beschreibung Beispielwert
tid Ticketnummer des Tickets 10

HTTP Status Codes

Code Beschreibung
200 OK Ticketstatus ermittelt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/status");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "10"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

Geschlossen

Beschreibung

Der Endpunkt listet alle Tickets im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Ticketliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "11",
        "userid": "0",
        "question": "
                            <h1>Neue Kontaktaufnahme</h1>
                            Name: Marcel Menk<br>
                            E-Mail: [email protected]<br>
                            Telefonnummer: 01742801286<br>
                            Kategorie: Allgemeine Anfrage<br>
                            <br>
                            <h2>Nachricht</h2><br>Testanfrage<br>
                        ",
        "cat": "Sonstige Anfragen",
        "priority": "1",
        "datetime": "2019-08-02 16:18:47",
        "status": "closed",
        "process_id": "123",
        "diff_name": "Max Mustermann",
        "diff_email": "[email protected]",
        "files_linked": "[]",
        "calls_linked": null
    },
    {
        "id": "10",
        "userid": "9997",
        "question": "Hallo",
        "cat": "Allgemeine Frage",
        "priority": "1",
        "datetime": "2019-07-22 12:41:15",
        "status": "closed",
        "process_id": "119",
        "diff_name": "",
        "diff_email": "",
        "files_linked": "["100","101","102"]",
        "calls_linked": null
    }
]

Beschreibung

Der Endpunkt listet alle Tickets im System auf.

Parameter

Parameter Beschreibung Beispielwert
tid Ticketnummer des Tickets 10

HTTP Status Codes

Code Beschreibung
200 OK Ticketobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "10"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "10",
    "userid": "9997",
    "question": "Hallo",
    "cat": "Allgemeine Frage",
    "priority": "1",
    "datetime": "2019-07-22 12:41:15",
    "status": "closed",
    "process_id": "119",
    "diff_name": "",
    "diff_email": "",
    "files_linked": "["100","101","102"]",
    "calls_linked": null
}

Beschreibung

Der Endpunkt fügt ein Ticket in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 9997
question Inhalt des Tickets meinText
cat Kategorie des Tickets Allgemeine Anfragen
priority Priorität des Tickets 1
datetime Erstelldatum des Tickets 2019-10-26 17:16:06
status Status des Tickets open
process_id Prozessnummer des Prozesses 235
diff_name Alternativer Name des Kunden Max Mustermann
diff_email Alternative E-Mail Adresse des Kunden [email protected]
files_linked Verlinkte Dateiobjekte []
calls_linked Verlinkte Anrufobjekte []

HTTP Status Codes

Code Beschreibung
200 OK Ticketobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "9997",
    
"question" => "meinText",
    
"cat" => "Allgemeine Frage",
    
"priority" => "1",
    
"datetime" => "2019-10-26 17:16:06",
    
"status" => "open",
    
"process_id" => "235",
    
"diff_name" => "Max Mustermann",
    
"diff_email" => "[email protected]",
    
"files_linked" => json_encode([

    ]),
    
"calls_linked" => json_encode([

    ]),
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Tickets eines bestimmten Kunden im System auf.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9997

HTTP Status Codes

Code Beschreibung
200 OK Ticketliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/getByUser");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"uid" => "9997"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "10",
        "userid": "9997",
        "question": "Hallo",
        "cat": "Allgemeine Frage",
        "priority": "1",
        "datetime": "2019-07-22 12:41:15",
        "status": "closed",
        "process_id": "119",
        "diff_name": "",
        "diff_email": "",
        "files_linked": "["100","101","102"]",
        "calls_linked": null
    },
    {
        "id": "11",
        "userid": "9997",
        "question": "Hallo 2",
        "cat": "Sonstige Frage",
        "priority": "1",
        "datetime": "2019-07-22 12:41:15",
        "status": "open",
        "process_id": "120",
        "diff_name": "",
        "diff_email": "",
        "files_linked": "["130"]",
        "calls_linked": null
    }
]

Beschreibung

Der Endpunkt listet alle Antworten eines bestimmten Tickets im System auf.

Parameter

Parameter Beschreibung Beispielwert
tid Ticketnummer des Tickets 10

HTTP Status Codes

Code Beschreibung
200 OK Antwortliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/getAnswers");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "10"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "4",
        "userid": "0",
        "answer": "Test",
        "datetime": "2019-07-22 12:42:17",
        "ticketid": "10",
        "is_operator": "1"
    }
]

Beschreibung

Der Endpunkt schließt ein Ticket im System.

Parameter

Parameter Beschreibung Beispielwert
tid Ticketnummer des Tickets 10

HTTP Status Codes

Code Beschreibung
200 OK Ticket geschlossen

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/close");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "10"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt antwortet auf ein Ticket im System.

Parameter

Parameter Beschreibung Beispielwert
tid Ticketnummer des Tickets 10
answer Antwort auf das Ticket meinText

HTTP Status Codes

Code Beschreibung
200 OK Ticket beantwortet

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/close");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"tid" => "10",
    
"answer" => "meinText"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Ticketkategorien im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Ticketkategorieliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("ticket/categories");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "cat": "Allgemeine Frage",
        "imap_host": "",
        "imap_username": "",
        "imap_password": ""
    },
    {
        "id": "3",
        "cat": "Sammelpostfach",
        "imap_host": "",
        "imap_username": "",
        "imap_password": ""
    }
]

Beschreibung

Der Endpunkt listet alle Ticketkategorien im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "userid": "9997",
        "rating": "3",
        "comment": "Test",
        "approved": "0"
    }
]

Beschreibung

Der Endpunkt zeigt eine Bewertung im System an.

Parameter

Parameter Beschreibung Beispielwert
rid Bewertungsnummer der Bewertung 1

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"rid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "1",
    "userid": "9997",
    "rating": "3",
    "comment": "Test",
    "approved": "0"
}

Beschreibung

Der Endpunkt zeigt eine Bewertung im System von einem Bestimmten Kunden an.

Parameter

Parameter Beschreibung Beispielwert
uid Kundennummer des Kunden 9997

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/getByUID");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"rid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "1",
    "userid": "9997",
    "rating": "3",
    "comment": "Test",
    "approved": "0"
}

Beschreibung

Der Endpunkt fügt eine Bewertung in das System ein.

Parameter

Parameter Beschreibung Beispielwert
userid Kundennummer des Kunden 9997
rating Sterne der Bewertung (Anzahl / 5) 3
comment Text der Bewertung meinText
approved Freigabestatus der Bewertung 0

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"userid" => "9997",
    
"rating" => "3",
    
"comment" => "meinText",
    
"approved" => "0"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine Bewertung aus dem System.

Parameter

Parameter Beschreibung Beispielwert
rid Bewertungsnummer der Bewertung 1

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"rid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt gibt eine Bewertung im System zur Anzeige frei.

Parameter

Parameter Beschreibung Beispielwert
rid Bewertungsnummer der Bewertung 1

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt freigegeben

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/approve");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"rid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt sperrt eine Bewertung im System zur Anzeige.

Parameter

Parameter Beschreibung Beispielwert
rid Bewertungsnummer der Bewertung 1

HTTP Status Codes

Code Beschreibung
200 OK Bewertungsobjekt gesperrt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("rating/disapprove");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"rid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt sperrt eine IP-Adresse oder ein Netz in der Firewall des Systems.

Parameter

Parameter Beschreibung Beispielwert
ip IP-Adresse oder -Netz 10.1.121.19

HTTP Status Codes

Code Beschreibung
200 OK IP gesperrt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("firewall/ban");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"ip" => "10.1.121.19"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt entsperrt eine IP-Adresse oder ein Netz in der Firewall des Systems.

Parameter

Parameter Beschreibung Beispielwert
ip IP-Adresse oder -Netz 10.1.121.19

HTTP Status Codes

Code Beschreibung
200 OK IP entsperrt

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("firewall/unban");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"ip" => "10.1.121.19"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt erfasst einen Anruf im System.

Parameter

Parameter Beschreibung Beispielwert
callerid CallerID des Anrufers Max Mustermann
callernumber Rufnummer des Anrufers +49000000000
note Notiz zum Anruf Mein Text

HTTP Status Codes

Code Beschreibung
200 OK Anruf erfasst

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("callnote/hook");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"callerid" => "Max Mustermann",
    
"callernumber" => "+49000000000",
    
"note" => "Mein Text"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt bietet eine Schnittstelle für die Direktkommunikation von Datafox Geräten im System.

Parameter

Parameter Beschreibung Beispielwert
checksum Prüfsumme der Datenübermittlung
Kennung Kommen (K) oder gehen (G) K
Ausweis_NR Ausweisnummer des Mitarbeiterausweises (Mitarbeiternummer) 9997
Datum Zeitstempel der Aktion 2019-08-02 16:18:47

HTTP Status Codes

Code Beschreibung
200 OK Zeit erfasst

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("datafox/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"checksum" => "dfg7987dfgv8ds7d9ds9rg9dfg7908d7f",
    
"Kennung" => "K",
    
"Ausweis_NR" => "9997",
    
"Datum" => "2019-08-02 16:18:47"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt bietet eine Schnittstelle für den Sivver Datafox Daemon im System.

Parameter

Parameter Beschreibung Beispielwert
action Kommen (K) oder gehen (G) K
employee Mitarbeiternummer des Mitarbeiters 9997
datetime Zeitstempel der Aktion 2019-08-02 16:18:47

HTTP Status Codes

Code Beschreibung
200 OK Zeit erfasst

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("datafox/hook");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"action" => "K",
    
"employee" => "9997",
    
"datetime" => "2019-08-02 16:18:47"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt gibt die Sitzungsdaten eines Zahlunsvorgangs im System zurück.

Parameter

Parameter Beschreibung Beispielwert
sid Sitzungsnummer der Sitzung B4T1S24U2A00Z9KR

HTTP Status Codes

Code Beschreibung
200 OK Sitzungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("payment/getSession");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"sid" => "B4T1S24U2A00Z9KR"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "1",
    "session_key": "B4T1S24U2A00Z9KR",
    "payment_method": "paypal",
    "invoice_id": "75",
    "created_on": "2020-02-01 10:45:45",
    "r_err": "https://meinlink.local/error",
    "r_suc": "https://meinlink.local/success",
    "p_closed": "0"
}

Beschreibung

Der Endpunkt generiert eine neue Zahlungssitzung für eine bestimmte Zahlungsmethode im System.

Parameter

Parameter Beschreibung Beispielwert
iid Rechnungsnummer der Rechnung 11
pm Zahlungsmethode der Rechnung paysafecard, paypal, wired_transfer, sofort, paymentwall, stripe
r_suc Link bei erfolgreicher Zahlung der Rechnung https://meinlink.local/success
r_err Link bei fehlgeschlagener Zahlung der Rechnung https://meinlink.local/error

HTTP Status Codes

Code Beschreibung
200 OK Sitzungsobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("payment/init");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"iid" => "11",
    
"pm" => "paypal",
    
"r_suc" => "https://meinlink.local/success",
    
"r_err" => "https://meinlink.local/error"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "session": "B4T1S24U2A00Z9KR",
    "link": "http://development.sivver.com/payment?session=B4T1S24U2A00Z9KR",
    "method": "paypal",
    "invoice": {
        "id": "75",
        "userid": "9997",
        "positions": "[{"name":"Test","description":"Test","price":"1.00","quantity":"1","take_inventory":"1"}]",
        "status": "0",
        "datetime": "2020-02-01 19:15:14",
        "contract_id": "0",
        "payment_type": "1",
        "archived": "1",
        "process_id": "240",
        "vat_percentage": "0",
        "booked": "1",
        "file_id": "109",
        "booked_to": "[{"account_no_having":"108","account_no_should":54,"amount":"1","receipt_file_id":"109","date_time":"2020-01-21 19:15:14"}]",
        "deptcollection": "0"
    }
}

Beschreibung

Der Endpunkt listet alle Warenhäuser im System auf.

Parameter

Parameter Beschreibung Beispielwert
Keine Parameter!

HTTP Status Codes

Code Beschreibung
200 OK Warenhausliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/list");

$api->auth("APIusername""APIpassword");

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "1",
        "wh_name": "Test",
        "wh_desc": "Testlager",
        "street": "Westring",
        "housenumber": "1",
        "postalcode": "33378",
        "city": "Rheda-Wiedenbrück",
        "state": "Nordrhein-Westfalen",
        "country": "Deutschland"
    }
]

Beschreibung

Der Endpunkt zeigt ein Warenhaus im System an.

Parameter

Parameter Beschreibung Beispielwert
whid Warenhausnummer des Warenhauses 1

HTTP Status Codes

Code Beschreibung
200 OK Warenhausobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/get");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "1",
    "wh_name": "Test",
    "wh_desc": "Testlager",
    "street": "Westring",
    "housenumber": "1",
    "postalcode": "33378",
    "city": "Rheda-Wiedenbrück",
    "state": "Nordrhein-Westfalen",
    "country": "Deutschland"
}

Beschreibung

Der Endpunkt fügt ein Warenhaus in das System ein.

Parameter

Parameter Beschreibung Beispielwert
wh_name Name des Warenhauses Test
wh_desc Beschreibung des Warenhauses Test
street Straße des Warenhauses Musterstraße
housenumber Hausnummer des Warenhauses 1
postalcode Postleitzahl des Warenhauses 10000
city Stadt des Warenhauses Musterstadt
state Bundesland des Warenhauses Musterland
country Land des Warenhauses Musterstaat

HTTP Status Codes

Code Beschreibung
200 OK Warenhausobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/add");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"wh_name" => "Testlager",
    
"wh_desc" => "Test",
    
"street" => "Musterstraße",
    
"housenumber" => "1",
    
"postalcode" => "10000",
    
"city" => "Musterstadt",
    
"state" => "Musterland",
    
"country" => "Musterstaat"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert ein Warenhaus im System.

Parameter

Parameter Beschreibung Beispielwert
whid Warenhausnummer des Warenhauses 1
data->wh_name Name des Warenhauses Test
data->wh_desc Beschreibung des Warenhauses Test
data->street Straße des Warenhauses Musterstraße
data->housenumber Hausnummer des Warenhauses 1
data->postalcode Postleitzahl des Warenhauses 10000
data->city Stadt des Warenhauses Musterstadt
data->state Bundesland des Warenhauses Musterland
data->country Land des Warenhauses Musterstaat

HTTP Status Codes

Code Beschreibung
200 OK Warenhausobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/update");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whid" => "1",
    
"data" => [
        
"wh_name" => "Testlager",
        
"wh_desc" => "Test",
        
"street" => "Musterstraße",
        
"housenumber" => "1",
        
"postalcode" => "10000",
        
"city" => "Musterstadt",
        
"state" => "Musterland",
        
"country" => "Musterstaat"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht ein Warenhaus im System.

Parameter

Parameter Beschreibung Beispielwert
whid Warenhausnummer des Warenhauses 1

HTTP Status Codes

Code Beschreibung
200 OK Warenhausobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/delete");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Fächer in einem Warenhaus im System auf.

Parameter

Parameter Beschreibung Beispielwert
whid Warenhausnummer des Warenhauses 1

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/listCompartments");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whid" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "16",
        "c_name": "Testfach",
        "c_desc": "Test",
        "wh_id": "1"
    }
]

Beschreibung

Der Endpunkt holt ein Fach aus dem System.

Parameter

Parameter Beschreibung Beispielwert
whid Warenhausnummer des Warenhauses 1
whcid Warenlagerfachnummer des Warenhauses 16

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/getCompartment");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whid" => "1",
    
"whcid" => "16"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

{
    "id": "16",
    "c_name": "Testfach",
    "c_desc": "Test",
    "wh_id": "1"
}

Beschreibung

Der Endpunkt fügt ein Lagerfach in das System ein.

Parameter

Parameter Beschreibung Beispielwert
c_name Name des Lagerfachs Testfach
c_desc Beschreibung des Lagerfachs Test
wh_id Warenhausnummer des Warenhauses 1

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachobjekt aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/addCompartment");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"c_name" => "Testfach",
    
"c_desc" => "Test",
    
"wh_id" => "1"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert ein Lagerfach im System.

Parameter

Parameter Beschreibung Beispielwert
whcid Warenlagerfachnummer des Lagerfachs 1
data->c_name Name des Lagerfachs Testfach
data->c_desc Beschreibung des Lagerfachs Test
data->wh_id Warenhausnummer des Warenhauses 1

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachobjekt modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/updateCompartment");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whcid" => "16",
    
"data" => [
        
"c_name" => "Testfach",
        
"c_desc" => "Test",
        
"wh_id" => "1"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht ein Lagerfach im System.

Parameter

Parameter Beschreibung Beispielwert
whcid Warenlagerfachnummer des Lagerfachs 16

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachobjekt zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/deleteCompartment");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whcid" => "16"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt listet alle Inventar zu Warenlager Verkettungen auf.

Parameter

Parameter Beschreibung Beispielwert
whcid Warenlagerfachnummer des Lagerfachs 16
invid Inventarnummer des Produktes 16

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachlinkliste aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/listInventoryLinks");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"whcid" => "16",
    
"invid" => "14"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "13",
        "comp_id": "16",
        "inventory_id": "14",
        "amount": "72"
    }
]

Beschreibung

Der Endpunkt zeigt eine Inventar zu Warenlager Verkettung an.

Parameter

Parameter Beschreibung Beispielwert
ilid Linknummer 13
whcid Warenlagerfachnummer des Lagerfachs 16
invid Inventarnummer des Produktes 16

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachlink aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/getInventoryLink");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"ilid" => "13",
    
"whcid" => "16",
    
"invid" => "14"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

[
    {
        "id": "13",
        "comp_id": "16",
        "inventory_id": "14",
        "amount": "72"
    }
]

Beschreibung

Der Endpunkt fügt eine Inventar zu Warenlager Verkettung in das System ein.

Parameter

Parameter Beschreibung Beispielwert
comp_id Warenlagerfachnummer des Lagerfachs 16
inventory_id Inventarnummer des Produktes 16
amount Aktueller Warenbestand 72

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachlink aufgebaut

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/addInventoryLink");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"comp_id" => "14",
    
"inventory_id" => "16",
    
"amount" => "72"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt modifiziert eine Inventar zu Warenlager Verkettung im System.

Parameter

Parameter Beschreibung Beispielwert
ilid Linknummer 13
data->comp_id Warenlagerfachnummer des Lagerfachs 14
data->inventory_id Inventarnummer des Produktes 16
data->amount Aktueller Warenbestand 72

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachlink modifiziert

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/updateInventoryLink");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"ilid" => "13",
    
"data" => [
        
"comp_id" => "14",
        
"inventory_id" => "16",
        
"amount" => "72"
    
]
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true

Beschreibung

Der Endpunkt löscht eine Inventar zu Warenlager Verkettung im System.

Parameter

Parameter Beschreibung Beispielwert
ilid Linknummer 13

HTTP Status Codes

Code Beschreibung
200 OK Lagerfachlink zerstört

Anfrage (Beispiel)

<?php
$api 
= new SivverAPI();

$api->destination("installation.mysivver.com");
$api->method("warehouse/deleteInventoryLink");

$api->auth("APIusername""APIpassword");

$parameters = [
    
"ilid" => "13"
];
$api->parameters($parameters);

$result $api->execute();
?>

Ergebnis (Beispiel)

true