Status Updates (polling)

Retrieve invoice status changes from the Ropo One platform.

Use this for lifecycle tracking and reconciliation.

NOTE, this service is parallel with Status Notification (events) Service. Recommendation is to use events service where Ropo acts as active party when status changes occurs.

How to query

• Recommended: call the endpoint without optional parameters.

  • You get all unrecorded status changes.

    • Each request returns maximum of 1000 status changes.

    • to get all status changes keep polling until service returns http status code 204

• Optional: use one filter parameter:

  • Use parameters only if needed to update statuses for single day or single invoice. For continuous polling use service without parameters

    • date: returns changes for that date (YYYY-MM-DD).

    • billnum: returns changes for one invoice.

      • Use this only for single-invoice checks.

Legacy notes

If only mandatory parameters are sent, the interface returns all unrecorded state changes, this is the recommended way to use the interface. Only one of the optional parameters can be sent.

Parameter: date The interface returns the status changes for that day Date format: YYY-MM-DD

Parameter: billnum The interface returns the status changes for that invoice number. This parameter is not recommended to use for mass queries

This should be used only for single request only. For multiple invoice updates and querys it is recommended to use the interface with out parameters or with date parameter.

Get jobs status update information

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

datestringOptional

Date (YYYY-MM-DD) to define to get all status update of given day.

billnumstringOptional

Invoice number. Response will contain all status updates for the invoice.

Responses

200

Successful operation

application/json

JobsStatusUpdatesResult

204

No Content, No status updates to return

400

Bad Request

application/json

401

Unauthorized

get

/jobs/statusupdates

HTTPcURLJavaScriptPython

GET /rest/jobs/statusupdates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "result": {
    "status": [
      {
        "jobid": "1",
        "statusid": "P12345",
        "billnum": "10123",
        "openamount": "10.0",
        "origamount": "15.0",
        "opencapital": "6.0",
        "openinterest": "3.0",
        "openexpenses": "1.0",
        "statustype": "payment",
        "statustime": "2016-12-30 14:31:26",
        "statusref": "Sample reason of update",
        "statustext": "Detailed information of update",
        "statuscode": "0",
        "paydate": "2016-12-30",
        "amount": "10.0"
      }
    ]
  }
}