foxyoffice-API

 

---

Wenn Sie Daten mit foxyoffice über eine Schnittstelle austauschen möchten, so steht Ihnen hierfür die foxyoffice-API zur Verfügung.
API ist die Abkürzung von „Application Programming Interface“, auf Deutsch „Programmierschnittstelle“.
Für die Nutzung dieser Schnittstelle sollten Sie, oder die handelnde Person, ein grundlegendes technisches Verständnis haben.
Gerne können Sie sich mit dem foxyoffice-Support in Verbindung setzen, wenn Sie mehr über die foxyoffice-API erfahren möchten.

Generelles zur API

• Der Datenaustausch passiert über URL.
• Die übertragenen Daten sind UTF-8 codiert.
• Die Daten werden im JSON-Format übertragen.
• Die foxyoffice-API ist eine RESTful API.
• Der Aufruf ist natürlich auch über die sichere HTTPS-Verbindung möglich.
• Parameter müssen mit „/“ getrennt werden.
• Als letzter Parameter muss immer der API-Key angegeben werden, den Sie in Ihrer foxyoffice-Anwendung unter „Stammdaten“ -> „Einstellungen“ finden.

---

 

Funktionen der foxyoffice-API

Fakturierung: Rechnung hinzufügen

URL-Aufruf
<Ihre foxyoffice-URL>/billing/api/addInvoice/<Ihr foxyoffice-API-Key>

POST-Daten
data[Invoice][number]
data[Invoice][date] (JJJJ-MM-TT)
data[Invoice][address]
data[Invoice][company_id]
data[Invoice][paid] (true/false, 0 oder 1) data[Invoice][canceled] (true/false, 0 oder 1)
data[Invoice][leading_text] data[Invoice][info] data[Invoice][payment_target]

data[InvoicePosition][0][text]
data[InvoicePosition][0][amount]
data[InvoicePosition][0][unit]
data[InvoicePosition][0][price]
data[InvoicePosition][0][tax_percent]
data[InvoicePosition][0][discount]

data[InvoicePosition][1][text]
data[InvoicePosition][1][amount]
data[InvoicePosition][1][unit]
data[InvoicePosition][1][price]
data[InvoicePosition][1][tax_percent]
data[InvoicePosition][1][discount]
...

Rückgabe
Die foxyoffice-ID der angelegten Rechnung im JSON-Format.

Fakturierung: Rechnungsdaten auslesen

URL-Aufruf
<Ihre foxyoffice-URL>/billing/api/getInvoice/<invoiceID>/<Ihr foxyoffice-API-Key>

Rückgabe
Die angeforderten Rechnungsdaten im JSON-Format.

 
Fakturierung: Rechnungsdaten eines Zeitraumes abfragen

URL-Aufruf
<Ihre foxyoffice-URL>/billing/api/searchInvoicesByDate/<vonDatum (JJJJ-MM-TT)>/<bisDatum (JJJJ-MM-TT)>/<Ihr foxyoffice-API-Key>

Rückgabe
Die angeforderten Rechnungsdaten eines angegebenen Zeitraumes im JSON-Format.

Kontakte: Kontakt hinzufügen

URL-Aufruf
<Ihre foxyoffice-URL>/contacts/api/addCompany/<Ihr foxyoffice-API-Key>

POST-Daten
data[Company][name]
data[Company][address]
data[Company][info]
data[Company][customer] (true/false -> 0 oder 1) data[Company][supplier] (true/false -> 0 oder 1)
data[Company][uid_countrycode] data[Company][uid_number]

Rückgabe
Die foxyoffice-ID des angelegten Kontaktes im JSON-Format.

E/A-Buchhaltung: Buchungen auslesen

URL-Aufruf
<Ihre foxyoffice-URL>/ea/api/getEntries/<von JJJJ-MM-TT>/<bis JJJJ-MM-TT>/<Ihr foxyoffice-API-Key>

Rückgabe
Die angeforderten Buchungen im definierten Zeitraum im JSON-Format.

E/A-Buchhaltung: Buchung hinzufügen

URL-Aufruf 
<Ihre foxyoffice-URL>/ea/api/addEntry/<Ihr foxyoffice-API-Key> 

POST-Daten
data[Entry][text] 
data[Entry][amount] 
data[Entry][amount_gross] 
data[Entry][tax] 
data[Entry][tax_percent] 
data[Entry][type] (normal, ig_lieferung, ig_leistung, drittland_lieferung, drittland_leistung) 
data[Entry][payment_method_id] (1=KA - Kassa, 2=BK - Bank, 3=KK - Kreditkarte) 
data[Entry][payment_date] (JJJJ-MM-TT) 
data[Entry][account_id] (Standard: bei Type=income->4020, bei Type=expense->7800) 
data[Entry][expense] (0=income, 1=expense) 

Optional
data[Entry][invoice_date] (JJJJ-MM-TT)
 
Rückgabe
Die foxyoffice-ID der angelegten Buchung im JSON-Format.

E/A-Buchhaltung: Buchung aktualisieren

URL-Aufruf 
<Ihre foxyoffice-URL>/ea/api/updateEntry/<entryId>/<Ihr foxyoffice-API-Key> 

POST-Daten
data[Entry][text] 
data[Entry][amount] 
data[Entry][amount_gross] 
data[Entry][tax] 
data[Entry][tax_percent] 
data[Entry][type] (normal, ig_lieferung, ig_leistung, drittland_lieferung, drittland_leistung) 
data[Entry][payment_method_id] (1=KA - Kassa, 2=BK - Bank, 3=KK - Kreditkarte) 
data[Entry][payment_date] (JJJJ-MM-TT) 
data[Entry][account_id] (Standard: bei Type=income->4020, bei Type=expense->7800) 
data[Entry][invoice_date] (JJJJ-MM-TT) data[Entry][verbucht] (0=nicht verbucht, 1=verbucht) 

Rückgabe
"Success"

Fakturierung: Rechnung suchen

URL-Aufruf 
<Ihre foxyoffice-URL>/billing/api/searchInvoice/<full_number>/<Ihr foxyoffice-API-Key> 

Rückgabe
Die angeforderte Rechnung im JSON-Format.