Recurring invoices


recurring.get

Request the details of one ore more recurring invoices. When no filter is set, 10 recurring 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

RESPONSE
TagsDescription
INVOICE_ID Invoice ID
TYPE Invoices of a specific type: outgoing | draft | credit
CUSTOMER_ID A specific customer ID
CUSTOMER_COSTCENTER_ID ID of cost center
CURRENCY_CODE Currency code
TEMPLATE_ID Template ID
INTROTEXT Introduction text
INVOICE_NUMBER Invoice number
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 (Format: YYYY-MM-DD)
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
TOTAL Total
VAT_ITEMS List of all articles for one entity
ITEMS List of items

recurring.create

Creation of a recurring invoice


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID
CUSTOMER_COSTCENTER_ID ID of cost center
CURRENCY_CODE Currency code
TEMPLATE_ID Template ID
INTROTEXT Introduction text
START_DATE Required Start of invoice run (Format: YYYY-MM-DD)
FREQUENCY Required

Frequency of invoice run:

weeklyWeekly
2 weeksEvery 2 weeks
4 weeksEvery 4 weeks
monthlyMonthly
2 monthsEvery 2 months
3 monthsQuarterly
6 monthsEvery 6 months
yearlyYearly
OCCURENCES Amount of recurring invoices: 0 = unlimited
OUTPUT_TYPE Required Type of automatically created invoice: draft | Outgoing
EMAIL_NOTIFY Flog for delivery to own mail address: 0 = no | 1 = yes
DELIVERY_DATE Delivery date (Format: YYYY-MM-DD)
CASH_DISCOUNT_PERCENT Cash discount in percent
CASH_DISCOUNT_DAYS Period for cash discount in days
VAT_CASE

VAT case:

standardStandard invoice
small_business_regulationSmall business
b2c_eu_goodsInvoice to consumer in another EU country
b2c_noneu_goodsExport delivery to non-EU
b2b_eu_goodsDelivery to EU (Reverse Charge)
b2b_eu_servicesService to EU (Reverse Charge)
b2b_noneu_goodsExport delivery to non-EU
b2b_noneu_servicesService to non-EU
TEMPLATE_HASH Unique id of the template
ITEMS Required List of items

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_ID Invoice ID

recurring.update

Update data of recurring 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 recurring.create

RESPONSE
TagsDescription
STATUS Result of the action

recurring.delete

Delete recurring invoice


DATA
TagsDescription
INVOICE_ID Required Invoice ID

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