Gutschriften

Alle Gut­schrif­ten auflisten

GET /api/credit-notes

<?xml version="1.0" encoding="UTF-8"?>
<credit-notes type="array" page="1" per_page="100" total="2">
    <credit-note>
        ...
    </credit-note>
    <credit-note>
        ...
    </credit-note>
</credit-notes>

Über Para­me­ter kann gefil­tert werden:

GET /api/credit-notes?credit-note_number=GS123

Lis­tet alle Gut­schrif­ten auf, die “GS123” in der Gut­schrif­ten­num­mer haben. Groß– und Klein­schrei­bung wird igno­riert.
Fol­gende Filter-Parameter ste­hen zur Verfügung:

Gut­schrif­ten aggre­giert auflisten

GET /api/credit-notes?group_by=client

Gut­schrif­ten kön­nen auch grup­piert abge­ru­fen wer­den. Obi­ges Bei­spiel grup­piert alle Gut­schrif­ten nach Kunde.
Fol­gende Werte ste­hen für den Para­me­ter group_by zur Verfügung:

Es kann auch nach meh­re­ren Kri­te­rien grup­piert wer­den. Dabei wer­den die gewünsch­ten Werte ein­fach per Komma anein­an­der­ge­hängt (?group_by=client,year). Die Rei­hen­folge der Werte bestimmt dabei die Rei­hen­folge der Aggregation.

Der Gruppierungs-Parameter kann auch mit den rest­li­chen Fil­tern kom­bi­niert werden.

<?xml version="1.0" encoding="UTF-8"?>
<credit-note-groups type="array" currency_code="USD">
    <credit-note-group>
        <total_gross type="float">347.28</total_gross>
        <total_net type="float">291.83</total_net>
        <client_id type="integer">476</client_id>
        <credit-note-params>
            <client_id type="integer">476</client_id>
        </credit-note-params>
    </credit-note-group>
    <credit-note-group>
        <total_gross type="float">1127.53</total_gross>
        <total_net type="float">947.50</total_net>
        <client_id type="integer">477</client_id>
        <credit-note-params>
            <client_id type="integer">477</client_id>
        </credit-note-params>
    </credit-note-group>
</credit-note-groups>

Ein­zelne Gut­schrift aufrufen

GET /api/credit-notes/{id}

<?xml version="1.0" encoding="UTF-8"?>
<credit-note>
    <id type="integer">1</id>
    <client_id type="integer">123</client_id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <credit-note_number>GS123</client_number>
    <number type="integer">123</number>
    <number_pre>RE</number_pre>
    <status>OPEN</status>
    <date type="date">2009-10-14</date>
    <address>Billomat GmbH &amp; Co. KG&#13;
Hollertszug 26&#13;
57562 Herdorf&#13;
Deutschland</address>
    <label>Projekt 123</label>
    <intro>Wir schreiben Ihnen folgende Positionen gut:</intro>
    <note>Vielen Dank!</note>
    <total_gross type="float">119.0</total_gross>
    <total_net type="float">100.0</total_net>
    <currency_code>EUR</currency_code>
    <quote type="float">1.0000</quote>
    <taxes type="array">
        <tax>
            <name>MwSt</name>
            <rate type="float">19.0</rate>
            <amount type="float">19.0</amount>
        </tax>
    </taxes>
</credit-note>

sta­tus kann fol­gende Werte haben:

• DRAFT (Ent­wurf)
• OPEN (offen)
• PAID (bezahlt)
• CANCELED (stor­niert)

Zusätz­lich zu der eigent­li­chen Gut­schrift wer­den noch die zusam­men­ge­fass­ten Steu­ern (taxes) mit zurückgegeben.

Die Gut­schrif­ten­po­si­tio­nen, Gut­schrif­ten­kom­men­tare und Zah­lun­gen kön­nen geson­dert abge­ru­fen werden.

Gut­schrift erstellen

POST /api/credit-notes

sta­tus ist bei der Erstel­lung immer DRAFT.

Die übri­gen Eigen­schaf­ten der Gut­schrift wer­den auto­ma­tisch berechnet.

Gut­schrif­ten­po­si­tio­nen (credit-note-items) kön­nen bei der Erstel­lung direkt mit ange­ge­ben wer­den. Es gel­ten die glei­chen XML-Elemente wie unter Gut­schrif­ten­po­si­tion erstel­len. Nur das XML-Element credit_note_id muss nicht mit ange­ge­ben werden.

<credit-note>
    <client_id>1</client_id>
    <date>2009-11-18</date>
    <note>Wir schreiben Ihnen gut:</note>
    <credit-note-items>
        <credit-note-item>
            <unit>Stück</unit>
            <unit_price>1.23</unit_price>
            <quantity>1.5</quantity>
            <title>Muster</title>
        </credit-note-item>
        <credit-note-item>
            <unit>Stunde</unit>
            <unit_price>90</unit_price>
            <quantity>8</quantity>
            <title>Arbeiten</title>
        </credit-note-item>
    </credit-note-items>
</credit-note>

<?xml version="1.0" encoding="UTF-8"?>
<credit-note>
    <id type="integer">1234</id>
    <client_id type="integer">1</client_id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <credit_note_number>RE124</credit_note_number>
    <number type="integer">124</number>
    <number_pre>RE</number_pre>
    <date type="date">2009-11-18</date>
    ...
</credit-note>

Gut­schrift bearbeiten

PUT /api/credit-notes/{id}

Eine Gut­schrift kann grund­sätz­lich nur im Entwurfs-Status (DRAFT) bear­bei­tet werden.

Gut­schrif­ten­po­si­tio­nen und Kom­men­tare kön­nen nicht direkt über die Gut­schrift bear­bei­tet wer­den. Bitte dafür über die ent­spre­chende Res­source gehen.

<credit-note>
    <date>2009-10-13</date>
</credit-note>

Gut­schrift löschen

DELETE /api/credit-notes/{id}

Löscht eine Gut­schrift inkl. aller dazu­ge­hö­ri­ger Doku­mente (PDFs), Gut­schrif­te­no­si­tio­nen und Kom­men­tare.

PDFs einer Gut­schrift aufrufen

GET /api/credit-notes/{id}/pdf

Als optio­na­ler Para­me­ter kann type=signed ver­wen­det wer­den, um das digi­tal signierte PDF aufzurufen.

An die­ser Stelle kann außer­dem der Para­me­ter format=pdf ver­wen­det wer­den, um das PDF direkt mit Mime­type “application/pdf” aufzurufen.

<pdf>
    <id type="integer">4882</id>
    <created type="datetime">2009-09-02T12:04:15+02:00</created>
    <credit_note_id type="integer">240</credit_note_id>
    <filename>credit-note_123.pdf</filename>
    <mimetype>application/pdf</mimetype>
    <filesize>70137</filesize>
    <base64file>{base64-kodiertes PDF}</base64file>
</pdf>

Gut­schrift abschließen

PUT /api/credit-notes/{id}/complete

Schließt eine Gut­schrift im Ent­wurfs­sta­tus (DRAFT) ab. Dabei wird der Sta­tus auf offen (OPEN) gesetzt, ein PDF erzeugt und im Datei­sys­tem abge­legt.
Wel­che Vor­lage für die PDF-Erzeugung benutzt wird, steu­ert der Para­me­ter optio­nale template_id.
Wir die­ser Para­me­ter nicht ange­ge­ben, wird die ein­ge­stellte Standard-Vorlage benutzt.

<complete>
    <template_id>123</template_id>
</complete>

Signier­tes PDF zu einer Gut­schrift hochladen

PUT /api/credit-notes/{id}/upload-signature

Lädt ein PDF mit einer digi­ta­len Signa­tur zur ange­ge­be­nen Gut­schrift hoch.
Die Gut­schrift darf sich nicht mehr im Entwurfs-Status (DRAFT) befinden.

Hin­weis: Eine (qua­li­fi­zierte) digi­tale Signa­tur kann NICHT direkt über die billomat[API] erstellt wer­den. Wir emp­feh­len, für diese Funk­tion direkt auf die PixelLetter-Schnittstelle oder einen ande­ren Dienst zurück zu greifen.

<signature>
    <base64file>{base64-kodiertes PDF}</base64file>
</signature>

Gut­schrift per E-Mail versenden

POST /api/credit-notes/{id}/email

<email>
    <from>info@billomat.com</from>
    <recipients>
        <to>info@billomat.com</to>
        <cc>mail@example.com</cc>
    </recipients>
    <subject>Ihre Gutschrift</subject>
    <body>Sehr geehrte Damen und Herren, ....</body>
    <filename>gutschrift</filename>
    <attachments>
        <attachment>
            <filename>zeichnung.pdf</filename>
            <mimetype>application/pdf</mimetype>
            <base64file>{base64-kodierte Datei}</base64file>
        </attachment>
    </attachments>
</email>

Gut­schrift stornieren

PUT /api/credit-notes/{id}/cancel