Ropo One™ Embed

Embed service’s API calls

To be able to use Ropo’s Embed service through REST, the following API calls are required at minimum:

Posting embed invoices to Ropo One

Invoice

Other most used REST API calls with Embed service

• Posting bypass payments for invoices which are in Ropo One

Payment

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

Get PDF

• Preview the invoice image before posting the invoice to Ropo One

Preview of invoice

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

---

Embed: Posting Embed 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)

Accountrow

• accountid: Specifies the account code for the transaction

• debit and credit: Indicate the amounts to be debited or credited

• desc: Provides a description of the transaction

• netamount: The net amount excluding VAT

• vatamount: The VAT amount

• taxpr: The VAT percentage

Example JSON

{
  "datastream": {
    "dataset": [
      {
        "jobtype": "0",
        "company": "Example Company",
        "address": "123 Example Street",
        "postcode": "12345",
        "city": "Example City",
        "customertype": "1",
        "billdate": "2025-05-09",
        "paydate": "2025-06-09",
        "payrow": [
          {
            "desc": "Product Description",
            "count": "1",
            "amount": "100.00",
            "taxpr": "24.00"
          }
        ],
        "accountrow": [
          {
            "accountid": "1701",
            "debit": 124.0,
            "credit": null,
            "desc": "Invoice line",
            "netamount": 100.0,
            "vatamount": 24.0,
            "taxpr": 24
          },
          {
            "accountid": "3000",
            "debit": null,
            "credit": 124.0,
            "desc": "Invoice line",
            "netamount": 100.0,
            "vatamount": 24.0,
            "taxpr": 24
          }
        ]
      }
    ]
  }
}

---

How to post the Embed 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 its own cidand 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

---

Authorization

First, you need to do the authorization with cid and apicode which Ropo has given to your knowledge:

Fetch the token from the desired environment with your cid and apicode:

curl -X POST "https://rc.ropo24.fi/rest/token" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -d "{\"cid\":\"CIDCODE\",\"apicode\":\"APICODE\"}"

As a response, you will get the token:

{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3MDAwMDczIiwic2NvcGUiOltdLCJyb2xlcyI6WyJhcGljb2RlIl0sImlhdCI6MTc0Njc3NDQ0NywiZXhwIjoxNzQ2NzgxNjQ3fQ.OJGk9_760dldmaLIkqis2zv8hay5m6VsTDmiTfFuJUo_rTlrEgZXSyrnxhK50Xmfds9z-G-PXPfaJnQX_NnmKw"}

---

Posting the job

Then use the token as authorization header when posting job to Ropo One:

curl -X POST "https://rc.ropo24.fi/rest/jobs" \
  -H "accept: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "datastream": {
      "dataset": [
        {
          "jobtype": "0",
          "company": "Example Company",
          "address": "123 Example Street",
          "postcode": "12345",
          "city": "Example City",
          "customertype": "1",
          "billdate": "2025-05-09",
          "paydate": "2025-06-09",
          "payrow": [
            {
              "desc": "Product Description",
              "count": "1",
              "amount": "100.00",
              "taxpr": "24.00"
            }
          ],
          "accountrow": [
            {
              "accountid": "1701",
              "debit": 124,
              "credit": null,
              "desc": "Sales Account",
              "netamount": 100,
              "vatamount": 24,
              "taxpr": 24
            },
            {
              "accountid": "3000",
              "debit": null,
              "credit": 124,
              "desc": "Receivable Account",
              "netamount": 100,
              "vatamount": 24,
              "taxpr": 24
            }
          ]
        }
      ]
    }
  }'

---

Response

As a response to posting the job to Ropo One, Ropo One gives the information whether the job was accepted or rejected.

{
  "result": [
    {
      "accepted": 1,
      "amount": 124,
      "billnum": "3224",
      "billcode": "",
      "error": null,
      "evoicetype": "",
      "jobid": 28118113,
      "jobstatus": "0",
      "jobtype": "0",
      "notice": null,
      "origbillnum": null,
      "ownref": "",
      "print": null,
      "receiver": "Example Company",
      "reference": "157000073281181136",
      "sendtype": "post"
    }
  ],
  "errors": [],
  "accepted": 1
}