Payment

Register a payment for an existing invoice.

Use this when the debtor paid outside Ropo’s settlement flow.

This is typical when the debtor pays to your own account.

Registering a payment can close or update the invoice state. Make sure you don’t double-register the same payment.

Prerequisites

The invoice must already exist in Ropo One.

You must reference the invoice using one of these identifiers:

• billcode (preferred)
• jobid
• billnum

Send only one identifier when possible.

If you send multiple identifiers, Ropo uses this lookup order:

1. billcode
2. jobid
3. billnum

Required fields

• paydate (format: YYYY-MM-DD)
• amount

Optional fields

These fields are use case specific:

• identifier
• type (example: directpayment)
• creditnotebillnum
• description

Example

{
  "amount": "710.00",
  "billcode": "1234567",
  "billnum": "R1234567",
  "paydate": "2017-10-10",
  "identifier": "insurance",
  "type": "directpayment",
  "creditnotebillnum": "26251",
  "description": "Payment received to the client bank account"
}

Add payment to existing job.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

JobAddPayment

amountnumberRequired

Amount of payment

Example: 710.00

billcodestringOptional

Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467

billnumstringOptional

Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: R123467

jobidintegerOptional

Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467

paydatestringRequired

Date of payment

Example: 2017-10-10

identifierstringOptional

Payment targeting identifier

Example: insurance

typestringOptional

Payment type

Example: directpayment

creditnotebillnumstringOptional

Credit note invoice number

Example: 26251

descriptionstringOptional

Description of payment

Example: Capital amount increased due to agreement change.

Responses

201

Payment response

application/json

JobAddPaymentResponse

jobidintegerOptional

Id of job

Example: 123456

billnumstringOptional

Billnum of job

Example: R12345

billcodestringOptional

Reference of job

Example: 123456

paydatestringOptional

Date of payment

Example: 2017-10-10

amountnumberOptional

Amount of payment

Example: 710.00

capitalbeforenumberOptional

Open capital before payment

Example: 710.00

capitalafternumberOptional

Open capital after payment

Example: 0.00

focusedtocapitalnumberOptional

Amount focused to opencapital

Example: 710.00

interestbeforenumberOptional

Amount before to interest

Example: 0.00

interestafternumberOptional

Amount after to interest

Example: 0.00

focusedtointerestnumberOptional

Amount focused to interest

Example: 0.00

noticefeebeforenumberOptional

Amount after to customer notice fee

Example: 0.00

noticefeeafternumberOptional

Amount before to customer notice fee

Example: 0.00

focusedtonoticefeenumberOptional

Amount focused to customer notice fee

Example: 0.00

unfocusednumberOptional

Unfocused amount

Example: 0.00

statusidnumberOptional

0 : UNDONE, 1 : FAIL, 2 : OLD, 3 : ROPO, 4 : ROPO Refund, 5 : CLOSE, 6 : OHISPAY, 8 : IGNORE, 9 : DIFFCID, 10 : NOT FOUND, 11 : CANCELLED. Only with value 6 Http-Responsecode is 201 other 400

Example: 6

statustextnumberOptional

additional information

Example: Capital kirjattu

400

Bad request

application/json

401

Unauthorized

post/jobs/payment

HTTPcURLJavaScriptPython

POST /rest/jobs/payment HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "amount": "710.00",
  "billcode": "123467",
  "billnum": "R123467",
  "jobid": "123467",
  "paydate": "2017-10-10",
  "identifier": "insurance",
  "type": "directpayment",
  "creditnotebillnum": "26251",
  "description": "Capital amount increased due to agreement change."
}

{
  "jobid": "123456",
  "billnum": "R12345",
  "billcode": "123456",
  "paydate": "2017-10-10",
  "amount": "710.00",
  "capitalbefore": "710.00",
  "capitalafter": "0.00",
  "focusedtocapital": "710.00",
  "interestbefore": "0.00",
  "interestafter": "0.00",
  "focusedtointerest": "0.00",
  "noticefeebefore": "0.00",
  "noticefeeafter": "0.00",
  "focusedtonoticefee": "0.00",
  "unfocused": "0.00",
  "statusid": "6",
  "statustext": "Capital kirjattu"
}