Revenues


revenue.get

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


FILTER
TagsDescription
See action invoice.get

RESPONSE
TagsDescription
INVOICE_ID Invoice ID
TYPE Invoices of a specific type: outgoing | draft | credit
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
CURRENCY_CODE Currency code
DELIVERY_DATE Delivery date
INVOICE_TITLE Invoice title
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
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
COMMENTS List of comments associated to the entity
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
IS_CANCELED Flag for canceled status: 0 = no | 1 = yes
INVOICE_DATE Invoice date
DUE_DATE Due date
PAYMENT_INFO Information on payment
LASTUPDATE Date of latest update
DOCUMENT_URL URL of a document

revenue.create

Creates a revenue entry. You can optionally attach a file with the request.

ATTENTION! – If an attachment is to be transferred, a POST- request of the type „multipart/form-data“ is required. In this case, the request-body has to contain the following parts:

  • document -> Data, that is to be transferred
  • httpbody -> XML- oder JSON-datablock

Structure of POST-requests in Multipart-form:

curl -v -X POST \
-u {E-Mail-Adresse}:{API-Key} \
-H 'Content-Type: multipart/form-data, boundary=AaB03x' \
-d '{xml body}' \ https://my.fastbill.com/api/1.0/api.php

POST /api/1.0/api.php HTTP/1.0
Host: my.fastbill.com
Content-type: multipart/form-data, boundary=AaB03x
Content-Length: {Größe des Inhalts}

--AaB03x content-disposition: form-data; name="httpbody"
{XML- oder JSON-Daten}
--AaB03x
content-disposition: form-data; name="document"; filename{Dateiname}"
Content-Type: {MIME Typ}
Content-Transfer-Encoding: binary
{Datei-Inhalt}
--AaB03x--

DATA
TagsDescription
INVOICE_DATE Required Invoice date
DUE_DATE Due date
CUSTOMER_ID Required A specific customer ID
INVOICE_NUMBER Invoice number
COMMENT
SUB_TOTAL Required Net amount
VAT_TOTAL Input VAT amount
CURRENCY_CODE Currency code

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_ID Invoice ID

revenue.setpaid

Mark a revenue as "paid"


DATA
TagsDescription
INVOICE_ID Required Invoice ID
PAID_DATE Date of received payment

RESPONSE
TagsDescription
STATUS Result of the action
INVOICE_NUMBER Invoice number

revenue.delete

Delete a revenue entry.


DATA
TagsDescription
INVOICE_ID Required Invoice ID

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