Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
We are hiring!
Deutsch | English | Español

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

ParameterDescriptionTypeOptional
totalAccumulated amount of received payments float  
availableDeposit that is available for transactions float  
lockedDeposit that is locked for transactions in process float  
creditLimitCustomers 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

ParameterDescriptionTypeRequiredDefault
creditLogIdID of the credit log to be shown int true 

2.2.2.2. Output

Table 2.20. Parameters

ParameterDescriptionTypeOptional
log   
... idID of the credit log int  
... amountAmount value float  
... creditTimeLog timestamp dateTime  
... customerIdID of the customer int  
... creditTypePayment method of the deposit text64  
... transactionIdTransaction ID of the deposit text64  
... refundIdAssociated ID of the refund (if it there is one) int  
... transactionDetailsDetails about the deposit (e.g. Paypal account) text64  
... currencyCurrency of the deposit text64  
... last4The 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

ParameterDescriptionTypeRequiredDefault
invoiceIdId of the invoice text64 true 

2.2.3.2. Output

Table 2.22. Parameters

ParameterDescriptionTypeOptional
pdfInvoice pdf as base64 encoded base64  

2.2.4. accounting.getReceipt

Returns receipt pdf document.

2.2.4.1. Input

Table 2.23. Parameters

ParameterDescriptionTypeRequiredDefault
idid of the payment int true 
amountamount to be receipt or refund text64 true 
detailsdetails required for pdf text text64 true 
datedate of request text64 true 

2.2.4.2. Output

Table 2.24. Parameters

ParameterDescriptionTypeOptional
pdfReceipt/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

ParameterDescriptionTypeRequiredDefault
dateFromLog start date timestamp true 
dateToLog end date timestamp true 
formatFormat of the requested document documentformat falsepdf
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.2.5.2. Output

Table 2.26. Parameters

ParameterDescriptionTypeOptional
pdfInvoice pdf as base64 encoded base64  
rawInvoice 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

ParameterDescriptionTypeOptional
countTotal number of invoices int  
invoice   
... invoiceIdId of the invoice text64  
... dateDate of invoice date  
... afterTaxBill including tax float  
... preTaxBill without tax float  
... typeKind of invoice text64  

2.2.7. accounting.lockedFunds

Log of locked deposit.

2.2.7.1. Input

Table 2.28. Parameters

ParameterDescriptionTypeRequiredDefault
dateFromLocked funds start date timestamp false 
dateToLocked funds end date timestamp false 
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.2.7.2. Output

Table 2.29. Parameters

ParameterDescriptionTypeOptional
funds   
... dateLock timestamp dateTime  
... domainDomain name for locked fund text64  
... amountLocked amount value float  
... statusLocked domain status text64  
sslFunds   
... certificateIdCertificate ID int  
... creationDateDate of credit locking dateTime  
... commonNameIf already set the commonName of the certificate text255  
... nettoLocked certificate status float  
... vatVAT float  
... productIdProduct ID int  
... productNameName of the product text255  
... statusLocked certificate status text64  

2.2.8. accounting.log

Log of customers transactions.

2.2.8.1. Input

Table 2.30. Parameters

ParameterDescriptionTypeRequiredDefault
dateFromLog start date timestamp false 
dateToLog end date timestamp false 
priceMinMinimum price of log entry float false0.0
priceMaxMaximum price of log entry float false 
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.2.8.2. Output

Table 2.31. Parameters

ParameterDescriptionTypeOptional
countTotal number of log entries int  
sumSum of amount float  
log   
... dateLog timestamp dateTime  
... amountAmount value float  
... typeType of action text64  
... detailsLog details text64  
... refundableIndicates 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

ParameterDescriptionTypeRequiredDefault
creditlogidID of the deposit to be refunded int true 
amountAmount 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

ParameterDescriptionTypeRequiredDefault
invoiceIdId of the invoice text64 true 
acceptCostsSet to true to accept the incurred costs boolean truefalse
sendTwiceSet to true to accept duplicated delivery-requests for a single invoice boolean falsefalse
testingTesting mode, no real action boolean false 

2.2.10.2. Output

No additional return parameters