Firmendaten

Mit dieser Api werden die Firmendaten (Mandanten) ausgegeben.

Felder

property	title	required	default	type	examples
shid	Eindeutige ID des Datensatzes			integer
parentSHID	Eltern ID			integer
name	Name			string
description	Beschreibung			string
standardCountry	Land			string
accountingSales	Umsätze; Buchhaltung / Konten			string
accountingSalesNational	Buchhaltung / Konten pro Land			object
accountingSalesInternational	Umsätze International; Buchhaltung / Konten			string
accountingVoucher	Gutscheine; Buchhaltung / Konten			string
accountingVoucherNational	Gutscheine pro Land; Buchhaltung / Konten			object
accountingVoucherInternational	Gutscheine International; Buchhaltung / Konten			string
accountingDeliverycost	Versandkosten; Buchhaltung / Konten			string
accountingDeliverycostNational	Versandkosten pro Land; Buchhaltung / Konten			object
accountingDeliverycostInternational	Versandkosten International; Buchhaltung / Konten			string
accountingRetoure	Retouren Retouren; Buchhaltung / Konten			string
accountingRetoureNational	Retouren pro Land; Buchhaltung / Konten			object
accountingRetoureInternational	Retouren International; Buchhaltung / Konten			string
accountingChargeback	Rückbuchung; Buchhaltung / Konten			string
accountingChargebackNational	Rückbuchung pro Land; Buchhaltung / Konten			object
accountingChargebackInternational	Rückbuchung International; Buchhaltung / Konten			string
accountingCustomer	Kundenkonto; Buchhaltung / Konten			string
accountingCustomerNational	Kundenkonto pro Land; Buchhaltung / Konten			object
accountingCustomerInternational	Kundenkonto International; Buchhaltung / Konten			string
accountingCustomerFlag	Feste Kundenkonten		0	string
accountingInvoiceNumberrangeStart	Rechnungsnummernkreis pro Land			object
provider	Provider; Anbindung an externe Systeme			string
providerName	Provider Bezeichnung			string
providerDescription	Provider Beschreibung			string
erpID	Eindeutige ID im Drittsystem; Datum für den Datenaustausch mit Drittsystemen			string
erpName	Name des Drittsystems; Datum für den Datenaustausch mit Drittsystemen			string
erpNumber	Eindeutige Nummer im Drittsystem; Datum für den Datenaustausch mit Drittsystemen			string
erpLastUpdate	Letzte Aktualisierung; Datum für den Datenaustausch mit Drittsystemen			string
erpCreation	Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen			string
archived	Archivierungsflag; 0: in Verwendung; 1: Datensatz ist archiviert		0	string

Eine Firma auslesen

Die URL /api/company/[SHID] liefert eine Firma (Mandant) zurück

{
    "dataset": {
        "39887013-301b-4f06-a3ca-096b109c9e86": {
            "shid": 1,
            "parentSHID": null,
            "name": "Shopcloud",
            "description": "Beschreibung",
            "standardCountry": "de",
            "accountingSalesNational": {
                "de": "",
                "at": "",
                "nl": "",
                "ch": "",
                "lu": "",
                "be": "",
                "dk": "",
                "fr": "",
                "ie": "",
                "gb": "",
                "it": ""
            },
            "accountingSales": "440000",
            "accountingDeliverycost": "440200",
            "accountingVoucher": "440300",
            "accountingRetoure": "440100",
            "accountingChargeback": "",
            "accountingSalesInternational": "",
            "accountingDeliverycostNational": {
                "de": "",
                "at": "",
                "nl": "",
                "ch": "",
                "lu": "",
                "be": "",
                "dk": "",
                "fr": "",
                "ie": "",
                "gb": "",
                "it": ""
            },
            "accountingDeliverycostInternational": "",
            "accountingVoucherNational": {
                "de": "",
                "at": "",
                "nl": "",
                "ch": "",
                "lu": "",
                "be": "",
                "dk": "",
                "fr": "",
                "ie": "",
                "gb": "",
                "it": ""
            },
            "accountingVoucherInternational": "",
            "accountingRetoureNational": {
                "de": "",
                "at": "",
                "nl": "",
                "ch": "",
                "lu": "",
                "be": "",
                "dk": "",
                "fr": "",
                "ie": "",
                "gb": "",
                "it": ""
            },
            "accountingRetoureInternational": "",
            "accountingChargebackNational": null,
            "accountingChargebackInternational": "",
            "accountingCustomerNational": {
                "de": "",
                "at": "",
                "nl": "",
                "ch": "",
                "lu": "",
                "be": "",
                "dk": "",
                "fr": "",
                "ie": "",
                "gb": "",
                "it": ""
            },
            "accountingCustomer": "",
            "accountingCustomerInternational": "",
            "accountingCustomerFlag": "",
            "accountingInvoiceNumberrangeStart": {},
            "provider": "",
            "providerName": "",
            "providerDescription": "",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2008-11-28T17:03:23",
            "erpCreation": "0000-01-01T00:00:00",
            "archived": "0"
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Firmendaten auslesen

Die URL /api/company?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG] liefert alle Firmendaten zurück. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/company?page=0&count=5

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Firma suchen

Über die URL /api/company/search?q=[QUERY] können Firmendaten gesucht werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/company/search?q=shid%3D1

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}