Ropo One™ Unify

Unify service’s API calls

To be able to use Ropo’s unify service through REST, next API calls are required to have in place:

Posting unify invoices to Ropo One

Invoicechevron-right

Other most used REST API calls with Unify service are next ones:

Posting bypass payments for invoices which are in Ropo One

Paymentchevron-right

Posting credit note allocated or refunded information for invoices which are in Ropo One

Credit note allocationchevron-right

Get the invoice image from Ropo One. REST API call’s response returns the invoice image as pdf.

Get PDFchevron-right

Preview the invoice image before posting the invoice to Ropo One

Preview of invoicechevron-right

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.

Local print of invoicechevron-right

Unify: Posting unify invoice with minimum level information to Ropo One

Minimum required level information in dataset json of the invoice, for posting it to be unify invoice in Ropo One, are listed below:

Invoice

Invoice Data (dataset tag):

  • jobtype: Message type (e.g., 0 for invoice).

  • 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)


How to post the unify 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:

Prod environments:

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/JobAddJobActionarrow-up-right

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?