Invoice


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
TagsDescription
INVOICE_ID Invoice ID
INVOICE_NUMBER Invoice number
INVOICE_TITLE Invoice title
CUSTOMER_ID A specific customer ID
MONTH Month
YEAR Year
START_DUE_DATE Invoices that are due from a specific date
END_DUE_DATE Invoices that are due up to a specific date
TYPE Payment type

RESPONSE
TagsDescription
INVOICE_ID Invoice ID
TYPE.
CUSTOMER_ID A specific customer ID
CUSTOMER_NUMBER The own customer number
CUSTOMER_COSTCENTER_ID ID of cost center
ORGANIZATION Company name [REQUIRED] when customer_type = business
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
COMMENT_ Comment
PAYMENT_TYPE Payment type : 1 = wire transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = pre payment | 6 = credit card
DAYS_FOR_PAYMENT Days until date of payment
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
AFFILIATE Affiliate
COUNTRY_CODE A country (ISO 3166 ALPHA-2)
VAT_ID VAT identification number
CURRENCY_CODE Currency code
TEMPLATE_ID Template ID
CONTACT_ID Contact ID
SUBSCRIPTION_ID Subscription ID
INVOICE_NUMBER Invoice number
INVOICE_TITLE Invoice title
INTROTEXT Introduction text
PAID_DATE Date of received payment
IS_CANCELED Flag for canceled status: 0 = no | 1 = yes
INVOICE_DATE Invoice date
DUE_DATE Due date
DELIVERY_DATE Delivery date
SERVICE_PERIOD_START NEW since 30.06.2020: Startdate of deliveryperiod
SERVICE_PERIOD_END NEW since 30.06.2020: Enddate of deliveryperiod
CASH_DISCOUNT_PERCENT Cash discount in percent
CASH_DISCOUNT_DAYS Period for cash discount in days
SUB_TOTAL Net amount
VAT_TOTAL Input VAT amount
VAT_ITEMS List of all articles for one entity
ITEMS List of items
TOTAL Total
PAYMENTS List of payments associated to the entity
PAYMENT_INFO Information on payment
DOCUMENT_URL URL of a document

invoice.create

Creates a new invoice.


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID
CUSTOMER_COSTCENTER_ID ID of cost center
CONTACT_ID Contact ID
CURRENCY_CODE Currency code
TEMPLATE_ID Template ID
TEMPLATE_HASH Unique id of the template
INTROTEXT Introduction text
INVOICE_TITLE Invoice title
INVOICE_DATE Invoice date
DELIVERY_DATE Delivery date
SERVICE_PERIOD_START NEW since 30.06.2020: Startdate of deliveryperiod
SERVICE_PERIOD_END NEW since 30.06.2020: Enddate of deliveryperiod
CASH_DISCOUNT_PERCENT Cash discount in percent
CASH_DISCOUNT_DAYS Period for cash discount in days
VAT_CASE Flag for Intra-community delivery: 0 = no | 1 = yes
IS_GROSS Flag for setting to gross price: 0 = no | 1 = yes
ITEMS Required List of items

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_ID Invoice ID

invoice.update

Updates the information of an invoice.


DATA
TagsDescription
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
TagsDescription
STATUS Result of the action

invoice.delete

Deletes an invoice


DATA
TagsDescription
INVOICE_ID Required Invoice ID

RESPONSE
TagsDescription
STATUS Result of the action

invoice.complete

Set a draft invoice as final.


DATA
TagsDescription
INVOICE_ID Required Invoice ID

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_NUMBER Invoice number

invoice.cancel

Cancel an invoice


DATA
TagsDescription
INVOICE_ID Required Invoice ID

RESPONSE
TagsDescription
STATUS Result of the action

invoice.sendbyemail

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


DATA
TagsDescription
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
TagsDescription
STATUS Result of the action

invoice.sendbypost

Send a completed invoice by post.


DATA
TagsDescription
INVOICE_ID Required Invoice ID

RESPONSE
TagsDescription
STATUS Result of the action
REMAINING_CREDITS Remaining credits

invoice.setpaid

Set an invoice as paid.


DATA
TagsDescription
INVOICE_ID Required Invoice ID
PAID_DATE Date of received payment
PAYMENT_METHOD Payment Method (e.g. paypal, cash, Berliner Volksbank)

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_NUMBER Invoice number
support@fastbill.com
© 2021 FastBill GmbH