Skip to main content

Invoices

Workist XML​

Supported document type: Invoices
File extension: .xml

The Workist XML format for invoices includes general header information, recipient and sender details, payment information, a financial summary and line items.

Full Example​

<?xml version="1.0" encoding="UTF-8"?>
<invoice>
    <invoice_number>INV-2025-0042</invoice_number>
    <order_number>PO-2025-0001</order_number>
    <contract_number>CON-2025-100</contract_number>
    <delivery_note_number>DN-2025-300</delivery_note_number>
    <invoice_date>2025-03-20</invoice_date>
    <invoice_due_date>2025-04-19</invoice_due_date>
    <delivery_date>2025-03-15</delivery_date>
    <document_type>invoice</document_type>

    <recipient_address>
        <Code>RCPT-001</Code>
        <name>Acme Corporation</name>
        <street_and_nr>Hauptstrasse 42</street_and_nr>
        <misc>Building A</misc>
        <company_name>Acme Corp GmbH</company_name>
        <postcode>80331</postcode>
        <city>Munich</city>
        <country>DE</country>
        <country_subdivision>BY</country_subdivision>
        <email>invoices@acme.de</email>
        <phone>+49 89 12345678</phone>
    </recipient_address>

    <sender_supplier>
        <address>
            <name>Supplier Contact Name</name>
            <street_and_nr>Lieferantenweg 10</street_and_nr>
            <company_name>Best Supplier GmbH</company_name>
            <postcode>20095</postcode>
            <city>Hamburg</city>
            <country>DE</country>
            <email>info@bestsupplier.de</email>
            <phone>+49 40 99999999</phone>
        </address>
        <name>Best Supplier GmbH</name>
        <customer_number>SUP-500</customer_number>
        <customer_type>preferred</customer_type>
        <contact_person>Hans Mueller</contact_person>
        <vat_id>DE987654321</vat_id>
    </sender_supplier>

    <sender_vat_id>DE987654321</sender_vat_id>
    <sender_tax_number>143/123/45678</sender_tax_number>

    <sender_contact>
        <contact_id>SC-001</contact_id>
        <name>Hans Mueller</name>
        <email>hans@bestsupplier.de</email>
        <phone>+49 40 88888888</phone>
    </sender_contact>

    <Info_Text>Payment due within 30 days.</Info_Text>

    <payment>
        <payment_bank>Deutsche Bank AG</payment_bank>
        <payment_bic>DEUTDEFF</payment_bic>
        <payment_iban>DE89370400440532013000</payment_iban>
        <payment_method>bank_transfer</payment_method>
        <payment_reference>INV-2025-0042</payment_reference>
        <payment_swift>DEUTDEFF</payment_swift>
        <payment_terms_discount>2% within 10 days</payment_terms_discount>
        <payment_terms_due_days>30</payment_terms_due_days>
        <payment_terms_type>net</payment_terms_type>
        <payment_terms>Net 30 days</payment_terms>
    </payment>

    <summary>
        <currency>EUR</currency>
        <net_amount>1250.00</net_amount>
        <tax_rate>19</tax_rate>
        <tax_amount>237.50</tax_amount>
        <total_amount>1487.50</total_amount>
        <total_due>1487.50</total_due>
    </summary>

    <line_items>
        <line_item>
            <pos>10</pos>
            <article_id1>ART-001-A</article_id1>
            <article_id2>GTIN-12345</article_id2>
            <article_id3>EAN-67890</article_id3>
            <article_partition_specific_number>CUST-ART-555</article_partition_specific_number>
            <article_description>Industrial Sensor Module Type A</article_description>
            <quantity>100</quantity>
            <unit>PCE</unit>
            <unit_price>12.50</unit_price>
            <total_price>1250.00</total_price>
            <gross_price>14.88</gross_price>
            <price_unit>1</price_unit>
            <tax_rate>19</tax_rate>
            <tax_amount>237.50</tax_amount>
        </line_item>
    </line_items>
</invoice>

Header Fields​

XML ElementTypeDescription
invoice_numberTextInvoice number
order_numberTextAssociated purchase order number
contract_numberTextContract reference
delivery_note_numberTextAssociated delivery note number
invoice_dateDateInvoice date
invoice_due_dateDateDue date
delivery_dateDateDelivery date
document_typeTextDocument type (e.g. invoice, credit_note)
recipient_addressBlockInvoice recipient address
sender_supplierBlockSupplier information with nested address
sender_vat_idTextSupplier's VAT identification number
sender_tax_numberTextSupplier's tax number
sender_contactBlockSupplier's contact person (ID, name, email, phone)
Info_TextTextFree-text notes (up to 5 blocks of 70 characters each)

Payment Fields​

XML ElementTypeDescription
payment_bankTextBank name
payment_bicTextBIC code
payment_ibanTextIBAN
payment_methodTextPayment method (e.g. bank_transfer)
payment_referenceTextPayment reference number
payment_swiftTextSWIFT code
payment_terms_discountTextEarly payment discount terms
payment_terms_due_daysTextNumber of days until due
payment_terms_typeTextType of payment terms
payment_termsTextFull payment terms

Summary Fields​

XML ElementTypeDescription
currencyTextCurrency code (e.g. EUR, USD)
net_amountDecimalNet amount before taxes
tax_rateDecimalTax rate in percent
tax_amountDecimalTax amount
total_amountDecimalGross total amount
total_dueDecimalTotal amount due

Line Item Fields​

XML ElementTypeDescription
posTextLine item number
article_id1TextPrimary article ID
article_id2TextSecondary article ID
article_id3TextTertiary article ID
article_partition_specific_numberTextCustomer-specific article number
article_descriptionTextProduct description
quantityDecimalQuantity
unitTextUnit of measure
unit_priceDecimalPrice per unit
total_priceDecimalLine item total amount
gross_priceDecimalGross price per unit
price_unitTextPrice unit basis
tax_rateDecimalTax rate at line item level
tax_amountDecimalTax amount at line item level