Estimate


estimate.get

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


FILTER
TagsDescription
CUSTOMER_ID A specific customer ID
ESTIMATE_ID Estimate ID
ESTIMATE_NUMBER Estimate number
START_DATE Estimates from a specific date (Format: YYYY-MM-DD)
END_DATE Estimates until a specific date (Format: YYYY-MM-DD)

RESPONSE
TagsDescription
ESTIMATE_ID Estimate ID
STATE Status: a = created | b = sent | c = negotiation | d = accepted | e = rejected | f = invoiced
CUSTOMER_ID A specific customer ID
CUSTOMER_NUMBER The own customer number
CUSTOMER_COSTCENTER_ID ID of cost center
PROJECT_ID A specific project ID
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
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
COUNTRY_CODE A country (ISO 3166 ALPHA-2)
VAT_ID VAT identification number
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.

TEMPLATE_ID Template ID
ESTIMATE_NUMBER Estimate number
INTROTEXT Introduction text
ESTIMATE_DATE Estimate date
DUE_DATE Due date
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_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
DOCUMENT_URL URL of a document
INVOICE_TITLE Invoice title

estimate.create

Creation of a new offer


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID
ESTIMATE_DATE Estimate date
ITEMS Required List of items
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
TEMPLATE_ID Template ID
TEMPLATE_HASH Unique id of the template

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_NUMBER Estimate number
DOCUMENT_ID ID of the generated PDF document
ESTIMATE_ID Estimate ID

estimate.createinvoice

Creation of an invoice out of an estimate


DATA
TagsDescription
ESTIMATE_ID Required Estimate ID

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_ID Invoice ID
DOCUMENT_ID ID of the generated PDF document
INVOICE_NUMBER Invoice number

estimate.delete

Deletion of an offer


DATA
TagsDescription
ESTIMATE_ID Estimate ID

RESPONSE
TagsDescription
STATUS Result of the action

estimate.sendbyemail

Sending of an offer by mail. The offer is attached as PDF file.


TagsDescription
ESTIMATE_ID Required Estimate ID
RECIPIENT Required Recipient
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
support@fastbill.com
© 2021 FastBill GmbH