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
IS_GROSS Gross flag, unit prices are gross prices: 0 = no | 1 = yes

RESPONSE
TagsDescription
INVOICE_ID Invoice ID
TYPE

Invoices of a specific type:

outgoingOutgoing invoices
draftDrafts
creditCredit notes
SUBTYPE

Invoice subtype:

standardStandard invoice
progress_invoiceProgress invoice
final_invoiceFinal 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:

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
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)
PAYMENT_TYPE Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card
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
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
TEMPLATE_ID Template ID
OCCURENCES Amount of recurring invoices: 0 = unlimited
FREQUENCY

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
START_DATE Start of invoice run (Format: YYYY-MM-DD)
EMAIL_NOTIFY Flog for delivery to own mail address: 0 = no | 1 = yes
OUTPUT_TYPE

Type of the automatically created invoice:

draftDraft invoice
outgoingFinalized invoice
INTROTEXT Introduction text
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

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 of the document (ISO 4217 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 the automatically created invoice:

draftDraft invoice
outgoingFinalized invoice
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
DISCOUNT_PERCENT Document discount in percent (0–100).
DISCOUNT_AMOUNT Document discount as an amount, always net.
IS_GROSS Gross flag, unit prices are gross prices: 0 = no | 1 = yes
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
DOCUMENT_ID ID of the generated PDF document
INVOICE_NUMBER Invoice number

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
INVOICE_ID Invoice ID
DOCUMENT_ID ID of the generated PDF document

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