FastBill API Documentation

invoice.get

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

FILTER

Tags Beschreibung

INVOICE_ID Rechnungs-ID

INVOICE_NUMBER Rechnungsnummer

INVOICE_TITLE Rechnungstitel

CUSTOMER_ID Eine bestimmte Kundennummer

MONTH Deprecated Monat

YEAR Deprecated Jahr

START_DUE_DATE Rechnungen die ab einem bestimmten Datum fällig werden (Format: YYYY-MM-DD)

END_DUE_DATE Rechnungen die bis zu einem bestimmten Datum fällig werden (Format: YYYY-MM-DD)

START_PAID_DATE Rechnungen mit einer Zahlung ab einem bestimmten Datum (Format: YYYY-MM-DD)

END_PAID_DATE Rechnungen mit einer Zahlung bis zu einem bestimmten Datum (Format: YYYY-MM-DD)

START_DATE Rechnungen ab einem bestimmten Datum (Format: YYYY-MM-DD)

END_DATE Rechnungen bis zu einem bestimmten Datum (Format: YYYY-MM-DD)

TYPE

Rechnungstyp:

`outgoing`	Rechnung
`draft`	Entwurf
`credit`	Stornorechnung

SUBTYPE

Rechnungs-Subtyp:

`standard`	Standardrechnung
`progress_invoice`	Abschlagsrechnung
`final_invoice`	Schlussrechnung

Für progress_invoice und final_invoice mit Vorgänger muss PREVIOUS_INVOICE_ID gesetzt sein.

START_LASTUPDATE Start des Filterzeitraums für das Feld LASTUPDATE (Format: YYYY-MM-DD)

END_LASTUPDATE Ende des Filterzeitraums für das Feld LASTUPDATE (Format: YYYY-MM-DD)

RESPONSE

Tags Beschreibung

INVOICE_ID Rechnungs-ID

TYPE

Rechnungstyp:

`outgoing`	Rechnung
`draft`	Entwurf
`credit`	Stornorechnung

SUBTYPE

Rechnungs-Subtyp:

`standard`	Standardrechnung
`progress_invoice`	Abschlagsrechnung
`final_invoice`	Schlussrechnung

Für progress_invoice und final_invoice mit Vorgänger muss PREVIOUS_INVOICE_ID gesetzt sein.

PREVIOUS_INVOICE_ID ID der Vorgängerrechnung in der Rechnungskette. Muss auf eine Abschlagsrechnung (SUBTYPE progress_invoice) verweisen und erfordert SUBTYPE progress_invoice oder final_invoice. Kunde, Umsatzsteuerfall, Brutto-Flag und Währung müssen innerhalb der Kette übereinstimmen; nicht mitgesendete Werte werden von der Vorgängerrechnung übernommen. 0 = keine Vorgängerrechnung

NEXT_INVOICE_ID ID der Nachfolgerrechnung in der Rechnungskette. 0 = keine Nachfolgerrechnung

CUSTOMER_ID Eine bestimmte Kundennummer

CUSTOMER_NUMBER Eigene Kundennummer

CUSTOMER_COSTCENTER_ID ID der Kostenstelle

ORGANIZATION Firmenname [REQUIRED] wenn customer_type = business

SALUTATION Anrede: mr = Herr | mrs = Frau | family = Familie | "empty" = ohne Titel

FIRST_NAME Vorname

LAST_NAME Nachname

ADDRESS Adresszeile 1

ADDRESS_2 Adresszeile 2

ZIPCODE Postleitzahl

CITY Stadt

COMMENT_ Bemerkung

DAYS_FOR_PAYMENT Tage bis zum Zahlungsziel

BANK_NAME Bankname

BANK_ACCOUNT_NUMBER Kontonummer

BANK_CODE Bankleitzahl

BANK_ACCOUNT_OWNER Kontoinhaber

BANK_IBAN IBAN

BANK_BIC BIC

CUSTOMER_ACCOUNTING_NOTE Kontierungshinweis

CONTRACT_REFERENCE Vertragsnummer

CUSTOMER_ORDER_REFERENCE Bestellnummer des Kunden

ORDER_REFERENCE Auftragsnummer

AFFILIATE Vertriebspartner

COUNTRY_CODE Länder-Code (ISO 3166 ALPHA-2)

VAT_ID USt-IdNr.

CURRENCY_CODE Standardwährung

TEMPLATE_ID Entwurfsnummer

CONTACT_ID Ansprechpartner ID

SUBSCRIPTION_ID Abonnement ID

INVOICE_NUMBER Rechnungsnummer

INVOICE_TITLE Rechnungstitel

INTROTEXT Einleitungstext

PAID_DATE Datum der Zahlung (Format: YYYY-MM-DD)

IS_CANCELED Flag für Stornierungsstatus: 0 = nein | 1 = ja

INVOICE_DATE Rechnungsdatum (Format: YYYY-MM-DD)

DUE_DATE Fälligkeitsdatum

DELIVERY_DATE Lieferdatum (Format: YYYY-MM-DD)

SERVICE_PERIOD_START Startdatum des Leistungszeitraums (Format: YYYY-MM-DD)

SERVICE_PERIOD_END Enddatum des Leistungszeitraums (Format: YYYY-MM-DD)

CASH_DISCOUNT_PERCENT Skonto in Prozent

CASH_DISCOUNT_DAYS Skonto-Zeitraum in Tagen

SUB_TOTAL Nettobetrag

VAT_TOTAL Vorsteuerbetrag

VAT_ITEMS Liste aller Artikel zu einem Datensatz

ITEMS Liste der Artikel

TOTAL Gesamtmenge

PAYMENTS Liste aller Zahlungen zu einem Datensatz

PAYMENT_INFO Informationen zu Zahlung

DOCUMENT_URL URL eines Dokuments

DETAILS_URL URL einer Rechnung

STATE

Status einer Rechnung: draft = Entwurf | canceled = Storniert | paid = Bezahlt | overdue = Überfällig | unpaid = Offen

Status einer Stornorechnung: issued = Erstellt | canceled = Storniert

invoice.create

Erstellen eines neuen Rechnungsentwurfs.

DATA

Tags Beschreibung

CUSTOMER_ID Required Eine bestimmte Kundennummer

CUSTOMER_COSTCENTER_ID ID der Kostenstelle

CONTACT_ID Ansprechpartner ID

SUBTYPE

Rechnungs-Subtyp:

`standard`	Standardrechnung
`progress_invoice`	Abschlagsrechnung
`final_invoice`	Schlussrechnung

Für progress_invoice und final_invoice mit Vorgänger muss PREVIOUS_INVOICE_ID gesetzt sein.

CURRENCY_CODE Standardwährung

TEMPLATE_ID Entwurfsnummer

TEMPLATE_HASH Eindeutige ID des Templates

INTROTEXT Einleitungstext

INVOICE_TITLE Rechnungstitel

INVOICE_DATE Rechnungsdatum (Format: YYYY-MM-DD)

DELIVERY_DATE Lieferdatum (Format: YYYY-MM-DD)

SERVICE_PERIOD_START Startdatum des Leistungszeitraums (Format: YYYY-MM-DD)

SERVICE_PERIOD_END Enddatum des Leistungszeitraums (Format: YYYY-MM-DD)

CASH_DISCOUNT_PERCENT Skonto in Prozent

CASH_DISCOUNT_DAYS Skonto-Zeitraum in Tagen

VAT_CASE

Umsatzsteuerfall:

`standard`	Standardrechnung
`small_business_regulation`	Kleinunternehmer
`b2c_eu_goods`	Warenlieferung, EU-Ausland (OSS Verfahren)
`b2c_noneu_goods`	Warenlieferung, Nicht-EU-Ausland
`b2b_eu_goods`	Warenlieferung, EU-Ausland
`b2b_eu_services`	Leistung, EU-Ausland (Reverse Charge)
`b2b_noneu_goods`	Warenlieferung, Nicht-EU-Ausland
`b2b_noneu_services`	Leistung, Nicht-EU-Ausland

IS_GROSS Flag ob auf Brutto umgestellt werden soll: 0 = no | 1 = yes

CUSTOMER_ACCOUNTING_NOTE Kontierungshinweis

CONTRACT_REFERENCE Vertragsnummer

CUSTOMER_ORDER_REFERENCE Bestellnummer des Kunden

ORDER_REFERENCE Auftragsnummer

ITEMS Required Liste der Artikel

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion
INVOICE_ID	Rechnungs-ID

invoice.update

Verändern der Daten eines Rechnungsentwurfes.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID
DELETE_EXISTING_ITEMS	Flag zur Löschung aller bestehenden Rechnungsposten: 0 = nein \| 1 = ja
See action	invoice.create

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion

invoice.delete

Löschen eines Rechnungsentwurfes.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion

invoice.complete

Erstellen einer fertigen Rechnung aus einem Rechnungsentwurf.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion
INVOICE_NUMBER	Rechnungsnummer

invoice.cancel

Stornieren einer Rechnung.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion

invoice.lock

Festschreiben einer Rechnung

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion

invoice.sendbyemail

Versenden einer abgeschlossenen Rechnung per E-Mail. Angehängt ist die Rechnung als PDF.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID
RECIPIENT Required	Empfänger
SUBJECT	Betreff
MESSAGE	e-Mail Text
RECEIPT_CONFIRMATION	Flag ob Empfangsbestätigung angefordert werden soll: 0 = nein \| 1 = ja

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion

invoice.sendbypost

Versenden einer abgeschlossenen Rechnung per Post.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion
REMAINING_CREDITS	Noch verbleibende Credits

invoice.setpaid

Eine Rechnung als bezahlt markieren.

DATA

Tags	Beschreibung
INVOICE_ID Required	Rechnungs-ID
PAID_DATE	Datum der Zahlung (Format: YYYY-MM-DD)
PAYMENT_METHOD	Zahlungsweise (z.B. Paypal, Bar, Berliner Volksbank)

RESPONSE

Tags	Beschreibung
STATUS	Ergebnis einer Aktion
INVOICE_NUMBER	Rechnungsnummer