eCollect Creditor API Documentation
Description
The eCollect API is built using REST technology.
JSON will be returned in all responses from the API, including errors.
Please, request a sandbox account to explore the eCollect creditor API.
Authentication
Immediately after the registration you can start using the eCollect API. In your eCollect account / settings you can find your personal API-Keys needed for the API authentication.
Please, choose the sandbox API keys for using the testing environment. The files in the sandbox / testing environment will not be processed by eCollect - the submitting is for testing purposes only.
API Endpoint
The API can be accessed at the following URL
https : // api.ecollect.org /
eCollect only accepts SSL encrypted requests. The endpoint for live and sandbox environment is the same - target system is identified by the API-Key.
Actions
Parameters
Name | Required |
---|---|
file_id | ✓ |
Fetching file data and file status from eCollect.
file_id
The file-ID eCollect provided you in the response of the postfile method. eg:
ca_puc9ox7sx4Tx0
Response
{ "status": "success", "status_message": "", "file_id": "ca_puc9ox7sx4Tx0", "file_identcode": "000XXX-F000XXXXX", "file_upload_date": "2016-03-31", "file_status": "Full payment", "file_status_group": "CLEARED", "file_status_date": "2016-06-06", "file": { "subject_matter_of_claim": "Mitgliedsbeitrag xxx.com Dienstleistung", "contractual_item": "Premium-Mitgliedschaft", "contract_date": "2015-10-21", "date_of_delivery": "2015-10-21", "claim_due_date": "2015-10-21", "file_currency": "EUR", "claim_gross_amount": 69.00, "claim_vat_included": null, "file_notes": null, "debtor_identcode": "000XXX-F000XXXXX", "debtor_fingerprint": "di_XrlXp3XXXXX0X", "debtor_individual_title": "", "debtor_individual_firstname": "Max", "debtor_individual_secondname": "Mustermann", "debtor_individual_gender": "m", "debtor_individual_birthname": "", "debtor_individual_date_of_birth": "1986-01-01", "debtor_individual_place_of_birth": "", "debtor_company_name": "", "debtor_company_register": "", "debtor_company_register_no": "", "debtor_company_vat_id": "", "debtor_company_type": "", "additional_charges": [ { "add_charge_net_amount": "6.00", "add_charge_vat_included": "", "add_charge_due_date": "", "currency_id": "1", "add_charge_label": "Rücklastschrift Gebühr", "add_charge_type_id": "bank_charges", "creation": "2016-03-31 10:14:52" }, { "add_charge_net_amount": "20.00", "add_charge_vat_included": "", "add_charge_due_date": "", "currency_id": "1", "add_charge_label": "Bearbeitungsgebühr", "add_charge_type_id": "processing_fee", "creation": "2016-03-31 10:14:52" } ], "file_metadata": [ { "key": "account_first_name", "value": "Max", "creation": "2016-03-31 10:14:52" }, { "key": "account_second_name", "value": "Mustermann", "creation": "2016-03-31 10:14:52" }, { "key": "account_gender", "value": "m", "creation": "2016-03-31 10:14:52" }, { "key": "account_user", "value": "XXX", "creation": "2016-03-31 10:14:52" }, { "key": "account_reference", "value": "XXX", "creation": "2016-03-31 10:14:52" }, { "key": "account_email_address", "value": "humandreams@gmx.de", "creation": "2016-03-31 10:14:52" }, { "key": "bank_account_no", "value": "13764200", "creation": "2016-03-31 11:14:12" }, { "key": "bank_clearing_no", "value": "XXX", "creation": "2016-03-30 11:14:12" }, { "key": "ip_address_transaction", "value": "91.XX.XX.XX", "creation": "2016-03-30 11:14:12" }, { "key": "reminder_date_1", "value": "2015-10-21", "creation": "2016-03-30 11:14:12" } ], "debtor_metadata": [ { "key": "username", "value": "XXX", "creation": "2016-03-31 10:14:52" } ], "debtor_address": [ { "fingerprint": "eNozXXXX", "address_country": "DE", "address_state": "", "address_zip": "XXX", "address_city": "XXX", "address_line1": "XXX", "address_line2": "", "address_creation": "2016-03-31 10:14:52", "address_deactivated": "1", "address_source_type": "", "address_source": "", "address_label": "" } ], "contact_details": [ { "fingerprint": "eNozs7CxXXX", "contact_type": "email", "contact_label": "Email. #1", "contact_country": "DE", "contact_record": "XXX", "contact_source_type": "", "contact_source": "", "creation": "2016-03-31 10:14:52", "contact_active": "1" } ], "debtor_representatives": [], "outstanding_amount": 0, "received_payments": 168.57, "debtor_individual_creation": "2016-03-31 10:14:52", "debtor_company_creation": "", "source_type": "api", "source": "import", "file_transfer": "regular" }, "file_history": [ { "type": "event", "obj": { "event_name": "payment", "event_timestamp": "2016-06-01 10:37:48", "event_amount": 168.57, "event_currency": "EUR" } }, { "type": "status_change", "obj": { "file_status_timestamp": "2016-06-01 10:37:48", "file_status": "Full payment", "file_group": "CLEARED" } }, { "type": "event", "obj": { "event_name": "letter returns", "event_timestamp": "2016-05-31 06:45:01" } }, { "type": "event", "obj": { "event_name": "email out", "event_timestamp": "2016-05-23 08:40:01" } }, { "type": "event", "obj": { "event_name": "letter out", "event_timestamp": "2016-05-23 08:36:04" } }, { "type": "status_change", "obj": { "file_status_timestamp": "2016-05-23 08:32:01", "file_status": "In progress", "file_group": "AUTOCOLLECT" } }, { "type": "status_change", "obj": { "file_status_timestamp": "2016-05-23 08:31:01", "file_status": "Initiate", "file_group": "AUTOCOLLECT" } }, { "type": "status_change", "obj": { "file_status_timestamp": "2016-05-23 08:30:19", "file_status": "Done", "file_group": "ENRICHMENT" } } ], "documents": [ { "document_id": "doc_cMXXX", "file_name": "000XXX.pdf", "comment": null, "type": null, "b64_content": XXX }, { "document_id": "doc_cXXXX", "file_name": "debcol-letter-XXX.pdf", "comment": null, "type": null, "b64_content": null } ], "statement": { "statement_creation": "2016-06-06 10:37:48", "statement_fingerprint": "cs_XXXX", "statement_identcode": "000XXX-S000XXXXX" } }
Please, click on the "File Status" link on the left side to find further informations about the file_status and file_status_group values.
On the one hand the file object contains the data you provided at file creation / submissioni. On the other hand there is some further data enriched by eCollect.
Please, pay attention to the additional objects provided by eCollect:
file_history
File history contains the collecting steps accomplished by ecollect and other events related to the current item.
documents
Documents related to the current file.
statements
If a statement for the current file already exists the statement object contains the data you need for fetching a detailed file statement. Please, take a look at the getstatement API method.
Parameters
Name | Required |
---|---|
file_id | |
file_state_group | |
debtor_fingerprint | |
debtor_name | |
debtor_email | |
date_of_delivery_from | |
date_of_delivery_till |
Multiple files can be retrieved by calling the getfiles API method. Please, pay attention to the additional parameters in the following example..
file_id
The file-ID eCollect provided you in the response of the postfile method. eg:
ca_puc9ox7sx4Tx0
file_state_group
Filtering the files by the state groups. Please, click on the "File Status" link on the left side to find further informations about the file_status and file_status_group values.
debtor_fingerprint
Fetching all files for a debtor with the provided debtor_fingerprint.
di_YrlXp3XXX
debtor_name
Filtering by debtor name
debtor_email
Filtering by debtor email
date_of_delivery_from
Fetching all the files with wera submitted after date_of_delivery_from
Expected date format Y-m-d (2016-12-21)
date_of_delivery_till
Fetching all the files with wera submitted before date_of_delivery_from
Expected date format Y-m-d (2016-12-21)
order_by
Expected values:
- file_fingerprint - debtor_name - debtor_email - state - debtor_id - debtor_created - debtor_identcode - debtor_country - debtor_type - debtor_outstandings - claim_total
order_direction
Expected values:
- asc - desc
offset
Offset
limit
Limit: max value 40
Response
Multiple file objects of the same type as in in the API method getfile.Parameters
Name | Required business |
Required individual |
---|---|---|
file_currency | ✓ | ✓ |
claim_gross_amount | ✓ | ✓ |
claim_vat_included | ||
claim_due_date | ✓ | ✓ |
subject_matter_of_claim | ✓ | ✓ |
contractual_item | ✓ | ✓ |
contract_date | ✓ | ✓ |
date_of_delivery | ||
file_metadata | ||
additional_charges | ||
debtor_metadata | ||
debtor_company_name | ✓ | |
debtor_company_type | ✓ | |
debtor_company_register | ||
debtor_company_register_no | ||
debtor_company_vat_id | ||
debtor_individual_title | ||
debtor_individual_firstname | ✓ | |
debtor_individual_secondname | ✓ | |
debtor_individual_gender | ✓ | |
debtor_individual_place_of_birth | ||
debtor_individual_date_of_birth | ||
debtor_address | ✓ | ✓ |
contact_details | ||
debtor_representatives |
Submitting files to eCollect
file_currency
3-letter iso 4217 code for currency of all amounts included in the file
claim_gross_amount
A positive numeric representing your principal claim including VAT, 2 decimal places
claim_vat_included
A positive numeric representing the amount of vat included in "claim_gross_amount". 2 decimal places. If no VAT included, submit 0.00
claim_due_date
Due date of the principal amount of this file.
subject_matter_of_claim
The subject matter of the principal claim. Usually this should contain a brief description the product or service provided to the debtor.
contractual_item
The contractual item of your claim against the debtor.
required
contract_date
Date the debtor entered into the contractual relationship causing your claim.
date_of_delivery
Date you delivered your product or service to the debtor. If no date is provided here, we will use the "claim_due_date" instead.
file_metadata
A set of key/value pairs that you can attach to the file object. It can be useful for storing additional information about the claim in a structured format. (e.g. transaction ID or invoice number).
Example: Posting 2 key value pairs to eCollect. (for convenience represented as a html form)
<form> ... <input name="file_metadata[0][key]" value="contract_period" /> <input name="file_metadata[0][value]" value="2 years" /> ... </form>
You are free to choose the key names on your own.
additional_charges
Additional charges to be collected with the principal claim. Typically this is used for adding reminder fees, interest or various additional costs generated by the payment default of your client. The number of additional charges is limited to xx.
Example: Posting several additional charges (for convenience represented as a html form)
<form> ... <input name="additional_charges[0][add_charge_gross_amount]" value="" /> <input name="additional_charges[0][add_charge_vat_included]" value="" /> <input name="additional_charges[0][add_charge_due_date]" value="" /> <input name="additional_charges[0][add_charge_type]" value="" /> <input name="additional_charges[0][add_charge_label]" value="" /> <input name="additional_charges[1][add_charge_gross_amount]" value="" /> <input name="additional_charges[1][add_charge_vat_included]" value="" /> <input name="additional_charges[1][add_charge_due_date]" value="" /> <input name="additional_charges[1][add_charge_type]" value="" /> <input name="additional_charges[1][add_charge_label]" value="" /> ... </form>
Additional charge keys
add_charge_gross_amount
required, if an additional charge is amended. A positive numeric representing your additional charge including vat
add_charge_vat_included
required, if an additional charge is amended. A positive integer representing the amount of vat included in "add_charge_net_amount". If no VAT is included add "0".
add_charge_due_date
due date of this additional charge.
add_charge_type
Available types of additional charges:
interest
reminder_fee
bank_charges
processing_fee
data_preparation
expenses
*required
add_charge_label
Describe the subject-matter of your additional charge.
debtor_metadata
A set of key/value pairs that you can attach to the debtor object. It can be useful for storing additional information about the client in a structured format. (e.g. customer ID)
Example: Posting 2 key value pairs to eCollect. (for convenience represented as a html form)
<form> ... <input name="debtor_metadata[0][key]" value="family_status" /> <input name="debtor_metadata[0][value]" value="unmarried" /> ... </form>
You are free to choose the key names on your own.
Company parameters
The company object contains various information about the debtor, if the debtor is a company. Although not all information is required, every extra info helps us to collect your outstandings.
debtor_company_name
Name of the legal entity including entity type.
debtor_company_type
Limitd, Pty. Ltd., GmbH, UG, AG, ...
debtor_company_register
optional
debtor_company_register_no
optional
debtor_company_vat_id
VAT ID, depending on the company domicile.
Individual parameters
The individual object contains all the information about the debtor as an individual, or the individual representing the owing company. Although not all information is required, every extra info helps us to collect your outstandings.
debtor_individual_title
Title of the debtor, if available
debtor_individual_firstname
Debtor's first name. required
debtor_individual_secondname
Debtor's second name.
debtor_individual_gender
optional
debtor_individual_place_of_birth
optional
debtor_individual_date_of_birth
Format: YYYY-MM-TT
Addresses and contact data
debtor_address
The address object contains various types of records of the individual debtor or company. Although not all information is required, every extra info helps us to collect your outstandings. If you have various contact records available, kindly provide all of them.
Example: Posting several address entries (for convenience represented as a html form)
<form> ... <input name="debtor_address[0][address_line1]" value="Evergreen Terrace23" /> <input name="debtor_address[0][address_line2]" value="top floor" /> <input name="debtor_address[0][address_city]" value="Springfield" /> <input name="debtor_address[0][address_state]" value="Oregon" /> <input name="debtor_address[0][address_zip]" value="00001" /> <input name="debtor_address[0][address_country]" value="US" /> <input name="debtor_address[0][address_label]" value="Hauptadresse" /> <input name="debtor_address[1][address_line1]" value="East Oak Street 1" /> <input name="debtor_address[1][address_line2]" value="" /> <input name="debtor_address[1][address_city]" value="Little Pwagmattasquarmsettport" /> <input name="debtor_address[1][address_state]" value="" /> <input name="debtor_address[1][address_zip]" value="00002" /> <input name="debtor_address[1][address_country]" value="US" /> <input name="debtor_address[1][address_label]" value="Nebenadresse" /> ... </form>
Debtor address keys
address_line1
required.
address_line2
optional.
address_city
required.
address_state
optional.
address_zip
required.
address_country
required.
address_label
eg. main address
optional.
contact_details
The address object contains various types of records of the individual debtor or company. Although not all information is required, every extra info helps us to collect your outstandings. If you have various contact records available, kindly provide all of them.
Example: Posting several contact details entries (for convenience represented as a html form)
<form> ... <input name="contact_details[0][contact_type]" value="email" /> <input name="contact_details[0][contact_label]" value="Private email" /> <input name="contact_details[0][contact_country]" value="DE" /> <input name="contact_details[0][contact_record]" value="info@ecollect.net" /> <input name="contact_details[1][contact_type]" value="phone" /> <input name="contact_details[1][contact_label]" value="Customer" /> <input name="contact_details[1][contact_country]" value="DE" /> <input name="contact_details[1][contact_record]" value="123456789" /> ... </form>
Contact details keys
contact_type
Type of the contact record. Currently there are 6 different types applicable: email, fax, phone, cellphone, web, other.
contact_label
Label of contact record, if needed. (Whatsapp, Wechat, Skype)
contact_country
Country of the contact data (if exists)
optional.
contact_record
Phone numbers with country-prefix!
debtor_representatives
Please, provide here up to several representatives with separate contact data..
Example: Posting representatives entries (for convenience represented as a html form)
<form> ... <input name="debtor_representatives[0][representative_title]" value="Dr" /> <input name="debtor_representatives[0][representative_firstname]" value="Audrey" /> <input name="debtor_representatives[0][representative_secondname]" value="Ellison" /> <input name="debtor_representatives[0][representative_gender]" value="m" /> <input name="debtor_representatives[0][representative_position]" value="CEO" /> <input name="debtor_representatives[0][representative_phone]" value="+49 69 12345670" /> <input name="debtor_representatives[0][representative_fax]" value="+49 69 12345671" /> <input name="debtor_representatives[0][representative_cellphone]" value="+49 179 12345670" /> <input name="debtor_representatives[0][representative_email]" value="info@ecollect.net" /> <input name="debtor_representatives[0][representative_web]" value="https://wwww.ecollect.org" /> ... </form>
Debtor representatives keys
representative_title
optional
representative_firstname
required
representative_secondname
required
representative_gender
required
representative_position
optional
representative_phone
optional
representative_cellphone
optional
representative_email
optional
representative_web
optional
Response
You get a JSON formatted object as response to your posts
{ "status": "success", "status_message": "Everything is fine", "ecollect_file_id": "ca_piyDbOtT8VfeY", "errors": [] }
You can use ecollect_file_id for further operation with the submitted file.
Error Messages
Example
{ "contact_details_0": [ "contact_type: Contact Type cannot be blank." ] }
Error in the contact detail entry on position 0 (=1)
Parameters
Name | Required |
---|---|
ecollect_id | ✓ |
cancel_status | ✓ |
cancel_comment | ✗ |
Cancel the collection procedure.
Parameters
ecollect_id
The file-ID eCollect provided you in the response of the postfile method.
cancel_status
direct_payment, claim_invalid,...
cancel_comment
The reason why you cancel your claim
Response
{ "status":"success", "status_message":"", "ecollect_file_id":"fi_6288DST4Z", "errors":[] }
Error Messages
{ "status":"error", "status_message":"", "ecollect_file_id":"fi_6288DST4Z", "errors":[ { "field":"ecollect_id", "message":"ecollect_id not valide", } ] }
Parameters
Name | Required |
---|---|
file_id | ✓ |
amount | ✓ |
currency | ✓ |
value_date | ✗ |
subject_matter | ✗ |
payee | ✗ |
payee_label | ✗ |
If a debt is payed directly to the creditor or to a third party the creditor has to inform ecollect about it by calling the API method directpayment.
file_id
eCollect file_id, eg.:
ca_puc9ox7sx4Tx0
required.
amount
The amount payed directly to creditor or to a third party
required.
currency
3-letter iso 4217 code
required.
value_date
The valuta date of the payment
subject_matter
Subject matter which was provided with the payment.
optional.
payee
- creditor - third_party
This data maybe important for further communication with the debtor.
optional.
payee_label
Label of the third party the debt was payed to.
optional.
Response
{ "status": "success", "status_message": "Your payment was successfully submitted to eCollect AG.“ }
Parameters
Name | Required |
---|---|
file_id | ✓ |
amount | ✓ |
currency | ✓ |
value_date | ✗ |
subject_matter | ✗ |
For reducing the debt amount the creditor can use the addcreditnote API method.
file_id
eCollect file_id, eg.:
ca_puc9ox7sx4Tx0
required.
amount
Credit note amount
currency
3-letter iso 4217 code
required.
value_date
The valuta date of the payment
subject_matter
Subject matter which was provided with the payment.
optional.
Response
{ "status": "success", "status_message": "Your payment was successfully submitted to eCollect AG.“ }
Parameters
Name | Required |
---|---|
format | ✗ |
item_type | ✗ |
date_from | ✗ |
date_to | ✗ |
debtor_name | ✗ |
file_id | ✗ |
limit | ✗ |
offset | ✗ |
Use getcreditorbalance to fetch balance items. User limit and offset to iterate over all items. Beside balance items you get a summary of the current balance and a total of payouts of your creditor.
format
Folliwing format types accepted:
- csv - json
item_type
Different balance entry types, eg. creditor_payout,installment_carryover ...
optional.
- creditor_payout - installment_carryover - statement_balance - direct_payment
date_from
Fetching balance entries > date_from. Format Y-m-d (2016-06-22)
optional.
date_to
Fetching balance entries < date_to. Format Y-m-d (2016-06-22)
optional.
debtor_name
Fetching balance entries related to files of debtor_name
optional.
file_id
Fetching balance entries related to file with the fingerpint file_id
optional.
limit
Limit
optional.
offset
Offset
optional.
Response
{ "status": "success", "items_overall_count": "2234", "items_current_count": 40, "balance_items": [ { "counter": 1, "item_file_id": "000XXX-F000XXXXX", "item_debtor_id": "000XXX-DI00XXXXX", "item_payout_value": "96.00", "item_payout_currency": "EUR", "item_date": "2016-06-22", "item_datetime": "2016-06-22 08:12:00", "item_debtor_name": "Max Mustermann", "item_file_closure_state": "CLEARED - Minimal deficit", "item_case_fingerprint": "ca_ieq1cXXXXXX", "item_cd_fingerprint": "di_JxXdCWXXXXXX", "item_type": "statement_balance", "item_description": "CLEARED - Minimal deficit", "item_debtor_value": "130.22", "item_debtor_currency": "EUR" }, { "counter": 1, "item_file_id": "000XXX-F0000XXXX", "item_debtor_id": "000XXX-DI000XXXX", "item_payout_value": "22.22", "item_payout_currency": "EUR", "item_date": "2016-06-21", "item_datetime": "2016-06-21 10:48:04", "item_debtor_name": "Susi Sonnenschein", "item_file_closure_state": null, "item_case_fingerprint": "ca_gYrGnqXXXXX", "item_cd_fingerprint": "di_YptAOIXXXXX", "item_type": "installment_carryover", "item_description": "Bank transfer", "item_debtor_value": "22.22", "item_debtor_currency": "EUR" }, { "counter": 1, "item_file_id": "000XXX-F000XXXXX", "item_debtor_id": "000XXX-DI00XXXXX", "item_payout_value": "0.00", "item_payout_currency": "EUR", "item_date": "2016-06-07", "item_datetime": "2016-06-07 06:53:22", "item_debtor_name": "Max Mustermann", "item_file_closure_state": null, "item_case_fingerprint": "ca_Ll0AgYXXXXX", "item_cd_fingerprint": "di_kvGFuXXXXXX", "item_type": "direct_payment", "item_description": "Direct Payment to Creditor XYZ", "item_debtor_value": "111.00", "item_debtor_currency": "EUR" } ], "current_balance": "2222.01", "current_balance_currency": "EUR", "current_payouts": "145124.03", "current_payouts_currency": "EUR" }
Parameters
Name | Required |
---|---|
format | ✗ |
limit | ✗ |
offset | ✗ |
Use getstatements to fetch latest statements. You can use limit and offset to iterate over the statements.The result is ordered by statement creation date, latest first.
A statements is generated if a file is closed with a cleared status. With the statement fingerprint and the api call getstatement you can fetch some details and a pdf version of the statement.
format
Expected format values
- json - csv
limit
Limit
optional.
offset
Offset
optional.
Results
{ "status": "success", "items_overall_count": "1020", "items_current_count": 40, "statement_items": [ ... ], "documents": [], "statement": { "statement_creation": "2016-04-05 12:24:32", "statement_fingerprint": "cs_syH8XXXXX", "statement_identcode": "000XXX-S0000XXXX" } } ] }
Parameters
Name | Required |
---|---|
statement_id | ✓ |
file_id | ✓ |
You can provide statement_id which you've got from „getstatements“ API method or directly a file_id. (file fingerprint code)
statement_id
Please, use the statement_fingerprint out of the getstatements API method result for fetching a detailed statement.
file_id
You also can use the file_id for fetching a detailed statement for a file.
Result
{ "status": "success", "status_message": "", "statement": { "statement_fingerprint": "cs_syH8XXXXX", "statement_identcode": "000XXX-S0000XXXX", "statement_creation": "2016-04-05 12:24:32", "statement_pdf": null, "file_details": { ... }, "balance_postings": { "items": [ { "counter": 1, "item_file_id": "000XXX-F0000XXXX", "item_debtor_id": "000251-DI0003603", "item_payout_value": "0.00", "item_payout_currency": "EUR", "item_date": "2016-04-06", "item_datetime": "2016-04-06 09:26:11", "item_debtor_name": "XXXX XXXXX", "item_file_closure_state": "CLEARED - Installment full payment", "item_case_fingerprint": "ca_6vpkXXXX", "item_cd_fingerprint": "di_7zR3wXXXXX", "item_type": "statement_balance", "item_description": "CLEARED - Installment full payment", "item_debtor_value": "20.00", "item_debtor_currency": "EUR" }, { "counter": 1, "item_file_id": "000XXX-F0000XXX", "item_debtor_id": "000XXX-DI000XXXX", "item_payout_value": "16.00", "item_payout_currency": "EUR", "item_date": "2015-12-02", "item_datetime": "2015-12-02 00:00:00", "item_debtor_name": "XXXX XXXXX", "item_file_closure_state": "CLEARED - Installment full payment", "item_case_fingerprint": "ca_6vpkXXXXX", "item_cd_fingerprint": "di_7zR3wXXXXX", "item_type": "installment_carryover", "item_description": "Bank transfer", "item_debtor_value": "20.00", "item_debtor_currency": "EUR" }, ... ], "items_current_count": 9 }, "statement_details": { "recoveries": { "payments_received_ecollect": [ { "payment_date": "2015-05-04", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-06-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-07-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-08-03", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-09-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-10-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-11-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2015-12-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2016-01-05", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2016-02-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2016-03-02", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" }, { "payment_date": "2016-04-06", "payment_debtor_value": 20, "payment_debtor_currency": "EUR", "payment_creditor_value": 20, "payment_creditor_currency": "EUR" } ], "payments_received_creditor": [] }, "accounting_of_charges": [ { "charge_property": "collection_fee", "charge_description": "Collection fee (Reverse Charge)", "charge_value_net": 58.5, "charge_value_vat": 0, "charge_value_gross": 58.5, "charge_currency": "EUR" }, { "charge_property": "waiving_collection_fee", "charge_description": "Waiving for collection fee", "charge_value_net": 0, "charge_value_vat": 0, "charge_value_gross": 0, "charge_currency": "EUR" }, { "charge_property": "collection_expenses", "charge_description": "Direct costs \/ Expenses (Reverse Charge)", "charge_value_net": 11.7, "charge_value_vat": 0, "charge_value_gross": 11.7, "charge_currency": "EUR" }, { "charge_property": "waiving_collection_expenses", "charge_description": "Waiving for direct costs \/ Expenses", "charge_value_net": 0, "charge_value_vat": 0, "charge_value_gross": 0, "charge_currency": "EUR" }, { "charge_property": "interest", "charge_description": "Interest (VAT 0%)", "charge_value_net": 9.93, "charge_value_vat": 0, "charge_value_gross": 9.93, "charge_currency": "EUR" }, { "charge_property": "waiving_interest", "charge_description": "Waiving for interest", "charge_value_net": 0, "charge_value_vat": 0, "charge_value_gross": 0, "charge_currency": "EUR" }, { "charge_property": "comission", "charge_description": "Commission", "charge_value_net": 0, "charge_value_vat": 0, "charge_value_gross": 0, "charge_currency": "EUR" } ], "file_summary": { "payments_received_total": 240, "payments_received_ecollect": 240, "payments_received_ceditor": 0, "credit_by_creditor": 0, "total_charges_ecollect": 80.13, "balance_installment_carryover": [ { "advance_payout_date": "2015-05-04", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-06-02", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-07-02", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-08-03", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-09-02", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-10-02", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-11-02", "advance_payout_value": 20, "advance_payout_currency": "EUR" }, { "advance_payout_date": "2015-12-02", "advance_payout_value": 16, "advance_payout_currency": "EUR" } ], "balance_file_statement": [ { "file_statement_date": "2016-04-06", "file_statement_value": 0, "file_statement_currency": "EUR" } ] } } } }
Errors
Error Message
API Key authorization failed. Please ensure that your user ID and the API key are correct
Error Message
The requested URL was not found.
Description
This error is returned whenever a collection or a resource prevents the use of the POST method.
Error Message
POST calls are not accepted for this request.
Error Message
The server encountered an error processing your request.
Error Message
The requested method is not implemented.