id	numeric, required

type	alpha_dash, required

Search in bills
@return Data Table object

(also Data Table args)

q	string
client_id	integer (incl. search params)
client_number	string
delivery_note_attached	string
date	date (incl. search params)
time	date (incl. search params)
nr	string
type	in: D, C, O, K, S, F, R, P, all
status	string
description	string
bill_text	string
payment_type	string
currency	string
net_amount	float (incl. search params)
gross_amount	float (incl. search params)
total_amount	float (incl. search params)
payment_type_discount	float (incl. search params)
payment_type_discount_percentage	float (incl. search params)
vat_amount	float (incl. search params)
payment_date	date (incl. search params)
delivery_date	string
due_date	string
dd_list_date	date (incl. search params)
order_nr	integer (incl. search params)
batch_date	date (incl. search params)
lastname	string
firstname	string
email	string
company	string
country	string
language	string
city	string
zip	string
is_final	string
filter_data	string
groups	string
groups_excluded	string
groups_restricted	string
saveByFilterName	string
iNewFilterCategory	string
saveByFilterId	integer
sSaveFilterData	string
requestStoredFilter	in: 0, 1
filter_category_id	integer (incl. search params)
currentFilterId	string
columnManager	string
createtime	string
ts	string
addressextension1	string
addressextension2	string

Get bill including all its details
like list of articles

id	integer, required

Create an empty bill
This is required before adding any items to the bill
@param: currency (3 char currency code (TODO:// default should be the company's primary currency))
@param: type (singe char code that defines the type of the bill: default D)
@param: payment_type ( INVOICE | SEPA | PAYPAL etc: default: INVOICE)

client_id	integer, required
currency	string
type	string
payment_type	string
delivery_date	date
due_date	date
delivery_address_id	integer
billing_address_id	integer
template_id	integer

Alias of the create function

client_id	numeric, required
type	required, in: D, C, O, K, S, F, R, P, all
currency	string
status	in: OPEN, PAID, PARTIAL_PAID, CANCELLED, REMINDED, ACCEPTED
date	date
payment_type	string
due_date	date
delivery_date	date
description	string
delivery_address_id	integer
shipping_id	integer
delivery_type	in: partial_delivery, total_delivery
billing_address_id	integer
template_id	numeric

Set a multiple bills as paid
@params ids is a comma separated list of bill ids Ex. 581,1104,1103

ids	ids, required

Add an item to a bill

bill_id	integer, required
article_id	integer, required
qty	float
price	numeric
vat_percent	float
tax_included	integer
name	string

Update an item from a bill
Note: Updates cannot happen once the bill is finalized

bill_id	integer, required
article_id	integer, required
booked_article_id	integer, required
price	numeric
vat_percent	float
qty	float
tax_included	integer
name	string

Delete an item from a bill
Note: Items cannot be deleted once the bill is finalized

bill_id	integer, required
booked_article_id	integer, required

Finalize the bill
This action will lock the bill for changes, will create a PDF and send notifications if necessary

id	integer, required

ids	ids, required

Validate alpha string part and start numbers
@params

company_id	numeric, required
numbers	array, required

Set a single bill as paid
@params id is the bill id

id	integer, required
payment_date	date
paid_amount	float
status	in: PAID, PARTIAL_PAID

Set a single bill as canceled
@params id is the bill id

id	integer, required

Set a single bill as unpaid
@params id is the bill id

id	integer, required

Creates a delivery note from one invoice
@param id is the bill id
@param address_id is optional. If this is set, a different shipping address will be used. address_id is the id of the supplementary address.
If this parameter is omited, the shiping address will be the same as the default client address
@param delivery_date - optional, set another delivery date. Format: YYYY-MM-DD

id	integer, required
address_id	integer
delivery_date	string

Notify one or more bills by email
@param required: bill_ids (ids of the bills, comma separated)

bill_ids

ids, required

Create reminders
@param required: bill_ids (ids of the bills, comma separated)
@param reminder_settings_id - id of reminder template to be used

bill_ids	ids, required
reminder_settings_id	integer, required

Send reminders
@param required: bill_ids (ids of the bills, comma separated)
@param reminder_settings_id - id of reminder template to be used

bill_ids	ids, required
reminder_settings_id	integer, required

Regenerate PDF of a bill
@param required: id (id of the bill to be regenerated)

id	ids, required

Process of generating Unbilled Invoices
This finalizes bills for all bills that have boookings and were not yet finalized

The clients are informed about the bill generation by email if the option is checked
After finalizing the bills the process creates a merged PDF document. The user who initiated the tasks is informed by company message
The company also gets a notification by email if that option is checked
@paramoptional: email_client [ 0 or 1 ] default 0
@paramoptional: email_company [ 0 or 1 ] default 0
@return Value: Array (task which will be executed)

email_client	in: 0, 1
email_company	in: 0, 1
email_affiliate	in: 0, 1
generation_start_time	string, required
document_type	string, required
minimum_amount	string

Get generated invoices if automatic process is completed
@param generation_start_time: start time saved in AutomaticProcess table
@return Value: Array generated invoices

generation_start_time	string, required
document_type	string, required

Process of generating Print Invoices
This creates a merged PDF document for all bills that have not been printed. The user who initiated the tasks is informed by company message
@paramoptional: email_company [ 0 or 1 ] default 0
The company also gets a notification by email if that option is checked
@return Value: Array (task which will be executed)

email_company

in: 0, 1

billId	string, required
customerId	string, required
newBillType	string, required
fromType	string, required
template_id	string

bill_ids	ids, required
newBillType	string, required
template_id	string

id	ids, required

bill_ids	ids, required
company_id	integer, required

id	ids, required
currentUserLang	string

id	string, required
lang	string

id	ids, required

id	string
name	string, required
type	required, string, in: standardformcontract, revocation
data	string, required

start

string

dataTableMethod	string, required
sDatatableKey	string

articles_ids	required, json
payment_method	string
client_id	string
shipping_method	string
delivery_address_id	string
add_payment_item	boolean
add_shipping_item	boolean

ids	ids, required
document_type	string

ids	ids, required
status	in: OPEN, PAID, CANCELLED, ACCEPTED, required

id	numeric, required
write	boolean

Get one record based on id

id	integer, required

Edit one record

id	integer, required
client_id	numeric
type	in: D, C, O, K, S, F, R, P, all
currency	string
status	in: OPEN, PAID, PARTIAL_PAID, CANCELLED, REMINDED, ACCEPTED
date	date
due_date	date
delivery_date	date
template_id	integer
payment_type	string
bill_text	string
description	string
delivery_address_id	integer
shipping_id	integer
delivery_type	in: partial_delivery, total_delivery
billing_address_id	integer
add_payment_item	boolean
add_shipping_item	boolean

Delete one record

id	integer, required
confirmed	boolean

Get Change Log for an object

id	integer, required

Get Comments related to an object -
@param id is the object id and not the comment id
@return Data Table object

(also Data Table args)

id	integer, required

Get one comment
@param id is the object id

id	integer, required
comment_id	integer, required

Add a comment to an object
@param id: id of the object to which a comment should be added
@param comment: text of the comment

id	integer, required
comment	string, required

Update a comment
@params comment_id is the id previously returned by getcomments
@param comment: text of the comment
@param id: id of the object to which a comment should be added

id	integer, required
comment_id	integer, required
comment	string, required

Delete a comment
@params comment_id is the id previously returned by getcomments

id	integer, required
comment_id	integer, required