APIDocumentation

Deutsch | English | Español

Währung:

USD

Ihr Land ist:

Bitte Land auswählen!

2.2. Accounting
Prev	Chapter 2. Methods	Next

2.2. Accounting

The accounting object provides methods concerning to your account balance and invoices.

2.2.1. accounting.accountBalance

Account balance details.

2.2.1.1. Input

No parameters allowed

2.2.1.2. Output

Table 2.18. Parameters

Parameter	Description	Type
total	Accumulated amount of received payments	float
available	Deposit that is available for transactions	float
locked	Deposit that is locked for transactions in process	float
creditLimit	Customers credit limit value	float

2.2.2. accounting.creditLogById

Get information about a specified credit log.

2.2.2.1. Input

Table 2.19. Parameters

Parameter	Description	Type	Required	Default
creditLogId	ID of the credit log to be shown	int	true

2.2.2.2. Output

Table 2.20. Parameters

Parameter	Description	Type
log
... id	ID of the credit log	int
... amount	Amount value	float
... creditTime	Log timestamp	dateTime
... customerId	ID of the customer	int
... creditType	Payment method of the deposit	text64
... transactionId	Transaction ID of the deposit	text64
... refundId	Associated ID of the refund (if it there is one)	int
... transactionDetails	Details about the deposit (e.g. Paypal account)	text64
... currency	Currency of the deposit	text64
... last4	The last four digits of the card	text64

2.2.3. accounting.getInvoice

Returns invoice pdf document.

2.2.3.1. Input

Table 2.21. Parameters

Parameter	Description	Type	Required	Default
invoiceId	Id of the invoice	text64	true

2.2.3.2. Output

Table 2.22. Parameters

Parameter	Description	Type	Optional
pdf	Invoice pdf as base64 encoded	base64

2.2.4. accounting.getReceipt

Returns receipt pdf document.

2.2.4.1. Input

Table 2.23. Parameters

Parameter	Description	Type	Required
id	id of the payment	int	true
amount	amount to be receipt or refund	text64	true
details	details required for pdf text	text64	true
date	date of request	text64	true

2.2.4.2. Output

Table 2.24. Parameters

Parameter	Description	Type	Optional
pdf	Receipt/Refund PDF as base64 encoded	base64

2.2.5. accounting.getstatement

Statement PDF Document of customers transactions.

2.2.5.1. Input

Table 2.25. Parameters

Parameter	Description	Type	Required	Default
dateFrom	Log start date	timestamp	true
dateTo	Log end date	timestamp	true
format	Format of the requested document	documentformat	false	pdf
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.2.5.2. Output

Table 2.26. Parameters

Parameter	Description	Type	Optional
pdf	Invoice pdf as base64 encoded	base64
raw	Invoice pdf as base64 encoded	text255

2.2.6. accounting.listInvoices

Get list of available invoices.

2.2.6.1. Input

No parameters allowed

2.2.6.2. Output

Table 2.27. Parameters

Parameter	Description	Type
count	Total number of invoices	int
invoice
... invoiceId	Id of the invoice	text64
... date	Date of invoice	date
... afterTax	Bill including tax	float
... preTax	Bill without tax	float
... type	Kind of invoice	text64

2.2.7. accounting.lockedFunds

Log of locked deposit.

2.2.7.1. Input

Table 2.28. Parameters

Parameter	Description	Type	Required	Default
dateFrom	Locked funds start date	timestamp	false
dateTo	Locked funds end date	timestamp	false
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.2.7.2. Output

Table 2.29. Parameters

Parameter	Description	Type
funds
... date	Lock timestamp	dateTime
... domain	Domain name for locked fund	text64
... amount	Locked amount value	float
... status	Locked domain status	text64
sslFunds
... certificateId	Certificate ID	int
... creationDate	Date of credit locking	dateTime
... commonName	If already set the commonName of the certificate	text255
... netto	Locked certificate status	float
... vat	VAT	float
... productId	Product ID	int
... productName	Name of the product	text255
... status	Locked certificate status	text64

2.2.8. accounting.log

Log of customers transactions.

2.2.8.1. Input

Table 2.30. Parameters

Parameter	Description	Type	Required	Default
dateFrom	Log start date	timestamp	false
dateTo	Log end date	timestamp	false
priceMin	Minimum price of log entry	float	false	0.0
priceMax	Maximum price of log entry	float	false
page	Page number for paging	int	false	1
pagelimit	Max number of results per page	int	false	20

2.2.8.2. Output

Table 2.31. Parameters

Parameter	Description	Type
count	Total number of log entries	int
sum	Sum of amount	float
log
... date	Log timestamp	dateTime
... amount	Amount value	float
... type	Type of action	text64
... details	Log details	text64
... refundable	Indicates whether the payment is refundable or not	boolean

2.2.9. accounting.refund

Request a refund of your unneeded funds.

2.2.9.1. Input

Table 2.32. Parameters

Parameter	Description	Type	Required	Default
creditlogid	ID of the deposit to be refunded	int	true
amount	Amount to be refunded	float	true

2.2.9.2. Output

No additional return parameters

2.2.10. accounting.sendbypost

Requests postal delivery of an invoice.

2.2.10.1. Input

Table 2.33. Parameters

Parameter	Description	Type	Required	Default
invoiceId	Id of the invoice	text64	true
acceptCosts	Set to true to accept the incurred costs	boolean	true	false
sendTwice	Set to true to accept duplicated delivery-requests for a single invoice	boolean	false	false
testing	Testing mode, no real action	boolean	false