FastBill API Documentation

invoice.get

Requests the details of one or more invoices. When no filter is set, 10 invoices will be delivered. A LIMIT up to 100 invoices is possible. The RESPONSE contains a "list of invoices" and each of them with the following fields.

FILTER

Tags Description

INVOICE_ID Invoice ID

INVOICE_NUMBER Invoice number

INVOICE_TITLE Invoice title

CUSTOMER_ID A specific customer ID

MONTH Deprecated Month

YEAR Deprecated Year

START_DUE_DATE Invoices that are due from a specific date (Format: YYYY-MM-DD)

END_DUE_DATE Invoices that are due up to a specific date (Format: YYYY-MM-DD)

START_PAID_DATE Invoices with a payment from a specific date (Format: YYYY-MM-DD)

END_PAID_DATE Invoices with a payment up to a specific date (Format: YYYY-MM-DD)

START_DATE Invoices from a specific date (Format: YYYY-MM-DD)

END_DATE Invoices until a specific date (Format: YYYY-MM-DD)

TYPE

Invoice type:

`outgoing`	Outgoing invoice
`draft`	Draft
`credit`	Credit note

SUBTYPE

Invoice subtype:

`standard`	Standard invoice
`progress_invoice`	Progress invoice
`final_invoice`	Final invoice

For progress_invoice and final_invoice with a predecessor, PREVIOUS_INVOICE_ID must be set.

IS_GROSS Gross flag, unit prices are gross prices: 0 = no | 1 = yes

START_LASTUPDATE Start date of the filter period for the field LASTUPDATE (Format: YYYY-MM-DD)

END_LASTUPDATE End date of the filter period for the field LASTUPDATE (Format: YYYY-MM-DD)

RESPONSE

Tags Description

INVOICE_ID Invoice ID

TYPE

Invoice type:

`outgoing`	Outgoing invoice
`draft`	Draft
`credit`	Credit note

SUBTYPE

Invoice subtype:

`standard`	Standard invoice
`progress_invoice`	Progress invoice
`final_invoice`	Final invoice

For progress_invoice and final_invoice with a predecessor, PREVIOUS_INVOICE_ID must be set.

CUSTOMER_ID A specific customer ID

CUSTOMER_NUMBER The own customer number

CUSTOMER_COSTCENTER_ID ID of cost center

CONTACT_ID Contact ID

PROJECT_ID A specific project ID

CURRENCY_CODE Currency of the document (ISO 4217 code)

BASE_CURRENCY_CODE

Base currency that EXCHANGE_RATE refers to (ISO 4217 code)

EXCHANGE_RATE

Stored exchange rate between the document currency (CURRENCY_CODE) and the base currency (BASE_CURRENCY_CODE). Amount in base currency = amount ÷ EXCHANGE_RATE.

Is 1 if document currency and base currency are identical.

DELIVERY_DATE Delivery date (Format: YYYY-MM-DD)

INVOICE_TITLE Invoice title

CASH_DISCOUNT_PERCENT Cash discount in percent

CASH_DISCOUNT_DAYS Period for cash discount in days

DISCOUNT_BASE_AMOUNT Net amount the document discount is applied to (after item discounts).

DISCOUNT_PERCENT Document discount in percent.

DISCOUNT_AMOUNT Document discount as a net amount.

DISCOUNT_TOTAL Total of all discounts (item discounts × quantity + document discount). With IS_GROSS = 1 the item discounts are gross.

SUB_TOTAL Net amount

VAT_TOTAL Input VAT amount

VAT_CASE

VAT case:

`standard`	Standard invoice
`small_business_regulation`	Small business
`b2c_eu_goods`	Invoice to consumer in another EU country
`b2c_noneu_goods`	Export delivery to non-EU
`b2b_eu_goods`	Delivery to EU (Reverse Charge)
`b2b_eu_services`	Service to EU (Reverse Charge)
`b2b_noneu_goods`	Export delivery to non-EU
`b2b_noneu_services`	Service to non-EU

VAT_ITEMS List of all articles for one entity

ITEMS List of items

TOTAL Gross amount

IS_GROSS Gross flag, unit prices are gross prices: 0 = no | 1 = yes

ORGANIZATION Company name [REQUIRED] when customer_type = business

NOTE Note

SALUTATION Salutation: mr | mrs | family | "empty"

FIRST_NAME First name

LAST_NAME Last name

ADDRESS Address

ADDRESS_2 Address 2

ZIPCODE ZIP code

CITY City

SERVICE_PERIOD_START Start date of service period (Format: YYYY-MM-DD)

SERVICE_PERIOD_END End date of service period (Format: YYYY-MM-DD)

BANK_NAME Bank name

BANK_ACCOUNT_NUMBER Bank account number

BANK_CODE Bank code

BANK_ACCOUNT_OWNER Bank account owner

BANK_IBAN IBAN

BANK_BIC BIC

REFERENCED_INVOICE_ID ID of the underlying document. For an invoice created from an estimate this is the ESTIMATE_ID, for a cancellation invoice the INVOICE_ID of the cancelled invoice. Only present on derived documents.

COMMENTS List of comments associated to the entity. Only present if at least one comment exists.

CUSTOMER_ACCOUNTING_NOTE Customer accounting note

CONTRACT_REFERENCE Contract reference

CUSTOMER_ORDER_REFERENCE Customer order reference

ORDER_REFERENCE Sales order reference

COUNTRY_CODE A country (ISO 3166 ALPHA-2)

VAT_ID VAT identification number

TEMPLATE_ID Template ID

INVOICE_NUMBER Invoice number

INTROTEXT Introduction text

PAID_DATE Date of received payment (Format: YYYY-MM-DD)

IS_CANCELED Flag for canceled status: 0 = no | 1 = yes

INVOICE_DATE Invoice date (Format: YYYY-MM-DD)

DUE_DATE Due date

PAYMENT_INFO Information on payment

PAYMENTS List of payments associated to the entity

LASTUPDATE Date of latest update

DOCUMENT_URL URL of a document

DETAILS_URL Link to the detail page of the invoice in FastBill. Returned for invoices, drafts and credit notes.

STATE

Status of an invoice: draft | canceled | paid | overdue | unpaid

State of a credit note: issued | canceled

PREVIOUS_INVOICE_ID ID of the predecessor invoice in the invoice chain. Must reference a progress invoice (SUBTYPE progress_invoice) and requires SUBTYPE progress_invoice or final_invoice. Customer, VAT case, gross flag and currency must match within the chain; values not sent are inherited from the predecessor invoice. 0 = no predecessor invoice

NEXT_INVOICE_ID ID of the successor invoice in the invoice chain. 0 = no successor invoice

invoice.create

Creates a new invoice.

DATA

Tags Description

CUSTOMER_ID Required A specific customer ID

CUSTOMER_COSTCENTER_ID ID of cost center

CONTACT_ID Contact ID

PROJECT_ID A specific project ID

SUBTYPE

Invoice subtype:

`standard`	Standard invoice
`progress_invoice`	Progress invoice
`final_invoice`	Final invoice

For progress_invoice and final_invoice with a predecessor, PREVIOUS_INVOICE_ID must be set.

CURRENCY_CODE Currency of the document (ISO 4217 code)

TEMPLATE_ID Template ID

TEMPLATE_HASH Unique id of the template

INTROTEXT Introduction text

INVOICE_TITLE Invoice title

INVOICE_DATE Invoice date (Format: YYYY-MM-DD)

DELIVERY_DATE Delivery date (Format: YYYY-MM-DD)

SERVICE_PERIOD_START Start date of service period (Format: YYYY-MM-DD)

SERVICE_PERIOD_END End date of service period (Format: YYYY-MM-DD)

CASH_DISCOUNT_PERCENT Cash discount in percent

CASH_DISCOUNT_DAYS Period for cash discount in days

DISCOUNT_PERCENT Document discount in percent (0–100).

DISCOUNT_AMOUNT Document discount as an amount, always net.

VAT_CASE

VAT case:

`standard`	Standard invoice
`small_business_regulation`	Small business
`b2c_eu_goods`	Invoice to consumer in another EU country
`b2c_noneu_goods`	Export delivery to non-EU
`b2b_eu_goods`	Delivery to EU (Reverse Charge)
`b2b_eu_services`	Service to EU (Reverse Charge)
`b2b_noneu_goods`	Export delivery to non-EU
`b2b_noneu_services`	Service to non-EU

IS_GROSS Gross flag, unit prices are gross prices: 0 = no | 1 = yes

CUSTOMER_ACCOUNTING_NOTE Customer accounting note

CONTRACT_REFERENCE Contract reference

CUSTOMER_ORDER_REFERENCE Customer order reference

ORDER_REFERENCE Sales order reference

ITEMS Required List of items

RESPONSE

Tags	Description
STATUS	Result of the action
INVOICE_ID	Invoice ID
DOCUMENT_ID	ID of the generated PDF document
INVOICE_NUMBER	Invoice number

invoice.update

Updates the information of an invoice.

DATA

Tags	Description
INVOICE_ID Required	Invoice ID
DELETE_EXISTING_ITEMS	Flag for deletion of all existing invoice items: 0= no \| 1 = yes
See action	invoice.create

RESPONSE

Tags	Description
STATUS	Result of the action
INVOICE_ID	Invoice ID
DOCUMENT_ID	ID of the generated PDF document

invoice.delete

Deletes an invoice

DATA

Tags	Description
INVOICE_ID Required	Invoice ID

RESPONSE

Tags	Description
STATUS	Result of the action

invoice.complete

Set a draft invoice as final.

DATA

Tags	Description
INVOICE_ID Required	Invoice ID

RESPONSE

Tags	Description
STATUS	Result of the action
INVOICE_ID	Invoice ID
INVOICE_NUMBER	Invoice number
DOCUMENT_ID	ID of the generated PDF document

invoice.cancel

Cancel an invoice

DATA

Tags	Description
INVOICE_ID Required	Invoice ID

RESPONSE

Tags	Description
STATUS	Result of the action
INVOICE_ID	Invoice ID

invoice.lock

Lock an invoice

DATA

Tags	Description
INVOICE_ID Required	Invoice ID

RESPONSE

Tags	Description
STATUS	Result of the action

invoice.sendbyemail

Send a completed invoice by e-mail. The invoice is attached as PDF file.

DATA

Tags	Description
INVOICE_ID Required	Invoice ID
RECIPIENT Required	Recipient (array with corresponding keys)
SUBJECT	Subject
MESSAGE	e-mail text
RECEIPT_CONFIRMATION	Flag for receiving acknowledgment of receipt: 0 = no \| 1 = yes

RESPONSE

Tags	Description
STATUS	Result of the action

invoice.sendbypost

Send a completed invoice by post.

DATA

Tags	Description
INVOICE_ID Required	Invoice ID

RESPONSE

Tags	Description
STATUS	Result of the action
REMAINING_CREDITS	Remaining credits

invoice.setpaid

Set an invoice as paid.

DATA

Tags	Description
INVOICE_ID Required	Invoice ID
PAID_DATE	Date of received payment (Format: YYYY-MM-DD)
PAYMENT_METHOD	Payment Method (e.g. paypal, cash, Berliner Volksbank)

RESPONSE

Tags	Description
STATUS	Result of the action
INVOICE_NUMBER	Invoice number