Ropo One™ Connect
Connect service’s API calls
Connect service contains two individual services (Information logistic service and reminder / debt collection service).
Information logistic service is for invoice distribution to the recipient
Reminder and debt collection service is for collecting open receivables from debtors
To be able to use Ropo’s Connect service through REST, next API calls are required to have in place:
Posting Information logistic invoices to Ropo One (information logistic service)
InvoicePosting invoices which should be reminded or collected to Ropo One (reminder and debt collection service)
ReminderDebt CollectionOther most used REST API calls with unify service are next ones
Information logistic service
Get the invoice image from Ropo One. REST API call’s response returns the invoice image as pdf.
Preview the invoice image before posting the invoice to Ropo One
Post the invoice as a local print to Ropo One and send the invoice by yourself to the recipient. REST API call’s response returns the invoice image as pdf.
Reminder and debt collection services:
Posting bypass payments or capital cancellations for invoices which are in Ropo One in reminder and debt collection services.
Posting credit note allocated or refunded information for invoices which are in Ropo One in reminder and debt collection services.
Connect: Posting information logistic invoice with minimum level information to Ropo One
Minimum required level information in dataset json of the invoice, for posting it to be information logistic invoice in Ropo One, are listed below:
Invoice
Invoice Data (dataset tag):
jobtype: Message type 300
address: Address of the recipient.
postcode: Customer’s postal code.
company: b2b end customer’s name (if customer type = 1)
person: b2c end customer’s name (if customer type = 2)
city: Customer’s post office.
customertype: Client type (1 = company, 2 = private person).
billdate: Date of invoice in the form of YYYY-MM-DD.
paydate: Date of issue in the form of yyyy-mm-dd.
Invoice Rows (payrow tag):
desc: Name of the product.
count: Number of items.
amount: Unit price (excl. tax)
taxpr: Value Added Tax (0-100)
Example:
How to post the information logistic invoice job to Ropo One
You need to know to which country and to which environment you are posting the reminder job. Ropo has country specific environments for testing and production purposes.
Test environments:
FIN: https://rc.ropo24.fi
SWE: https://rc.ropo24.se
NOR: https://rc.ropo24.no
Prod environments:
FIN: https://ropo24.fi
SWE: https://ropo24.se
NOR: https://ropo24.no
For each environment your company’s Ropo One profile has own cid and apicode.
When posting jobs to Ropo One, you should be using jobs API-call: example swagger link to finnish environment https://rc.ropo24.fi/swagger/#/jobs/JobAddJobAction
First you need to do the authorization with cid and api code which Ropo has given to your knowledge:
Fetch the token from wanted environment with your cid and api code
As a response, you will get the token
Then use the token as authorization header when posting job to Ropo One
As a response to posting the job to Ropo One, Ropo One gives the information was the job accepted or rejected from Ropo One.
Connect: Posting invoices with minimum required level information to Ropo’s reminder and debt collection services into Ropo One
In reminder and debt collection services Ropo could start the service from the reminder status or from debt collection status. If you are posting invoice to be reminder in Ropo One, you don’t need to post it again as debt collection, since Ropo One will proceed the reminded invoice to be in debt collection automatically if it’s not paid by the debtor.
Posting invoice to be reminded with minimum level information to Ropo One
Invoice which will be reminded monitored by Ropo.
Minimum level information in dataset json of the invoice, for posting it to be reminder in Ropo One, are listed below:
jobtype = type of the job. Jobtype 1 is reminder
billcode = invoice reference. This will be used as a default to be settlement reference of money payment to your settlement account.
amount = open capital amount of the invoice
billnum = invoice number of the invoice
person = Consumer debtor’s name. NOTE! company field should be used with company debtor.
address = Debtor’s Street address
postcode = Debtor’s post code
city = Debtor’s postal town
customertype = customer type. 2 = person, 1 = company
billdate = invoice date of the invoice
paydate = invoice’s due date
Example:
How to post the reminder job to Ropo One
You need to know to which country and to which environment you are posting the reminder job. Ropo has country specific environments for testing and production purposes.
Test environments:
FIN: https://rc.ropo24.fi
SWE: https://rc.ropo24.se
NOR: https://rc.ropo24.no
Prod environments:
FIN: https://ropo24.fi
SWE: https://ropo24.se
NOR: https://ropo24.no
For each environment your company’s Ropo One profile has own cid and apicode.
When posting jobs to Ropo One, you should be using jobs API-call: example swagger link to finnish environment https://rc.ropo24.fi/swagger/#/jobs/JobAddJobAction
First you need to do the authorization with cid and api code which Ropo has given to your knowledge:
Fetch the token from wanted environment with your cid and api code
As a response, you will get the token
Then use the token as authorization header when posting job to Ropo One
As a response to posting the job to Ropo One, Ropo One gives the information was the job accepted or rejected from Ropo One.
Posting invoice to be collected with minimum level information to Ropo One
NOTE! In reminder and debt collection services Ropo could start the service from the reminder status or from debt collection status. If you have posted the invoice to be reminder in Ropo One, you don’t need to post it again as debt collection, since Ropo One will proceed the reminded invoice to be in debt collection automatically if it’s not paid by the debtor.
But if, you haven’t posted the invoice already to Ropo One as reminder, you could post it to be collected by Ropo One.
Invoice which will be collected and monitored by Ropo.
Minimum required level information in dataset json of the invoice, for posting it to be reminder in Ropo One, are listed below:
jobtype = type of the job. Jobtype 2 is debt collection.
billcode = invoice reference. This will be used as a default to be settlement reference of money payment to your settlement account.
amount = open capital amount of the invoice
billnum = invoice number of the invoice
person = Consumer debtor’s name. NOTE! company field should be used with company debtor.
address = Debtor’s Street address
postcode = debtor’s post code
city = debtor’s postal town
customertype = customer type. 2 = person, 1 = company
Noticedate = Date when creditor has sent the reminder to the debtor (Mandatory in Finland).
billdate = invoice date of the invoice
paydate = invoice’s due date
Example:
How to post the debt collection job to Ropo One
You need to know to which country and to which environment you are posting the reminder job. Ropo has country specific environments for testing and production purposes.
Test environments:
FIN: https://rc.ropo24.fi
SWE: https://rc.ropo24.se
NOR: https://rc.ropo24.no
Prod environments:
FIN: https://ropo24.fi
SWE: https://ropo24.se
NOR: https://ropo24.no
For each environment your company’s Ropo One profile has own cid and apicode.
When posting jobs to Ropo One, you should be using jobs API-call: example swagger link to finnish environment https://rc.ropo24.fi/swagger/#/jobs/JobAddJobAction
First you need to do the authorization with cid and api code which Ropo has given to your knowledge:
Fetch the token from wanted environment with your cid and api code
As a response, you will get the token
Then use the token as authorization header when posting job to Ropo One
As a response to posting the job to Ropo One, Ropo One gives the information was the job accepted or rejected from Ropo One.
Last updated
Was this helpful?