Update contract information

This guide explains the functionality and messages used to update contract information in Ropo One.

Interface can be used for example updating contract status in Ropo One.

This documentation describes Ropo One interface (RestAPI) and message format (JSON). If this doesn’t apply to possibilities that client and their system can provide, then other interfaces (SFTP) and message formats can be agreed as long as they match to Ropo One requirements. Other interfaces and message formats must be discussed and agreed separately during implementation project.

Field	Description	Mandatory / Optional	Example
contract_ no	Contract number (identifier). Is used to find contract which is requested to be updated	Mandatory	CN18 2838
name	Contract name	Optional	Home Insura nce
startdate	Start date for contract	Optional	2023- 06-10
enddate	End date for contract	Optional	2025- 06-10
contracts tatus	Contract status Available options: • active • terminated • closed	Optional	Termi nated
type	Contract type	Optional	Insura nce
terminati on_date	Date for contract termination if invoices are not paid before.	Optional	2023- 08-01
terminati onterm	Term to be used when calculating termination date. If termination date is calculated in Ropo24.	Optional	14

Update a contract

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ContractUpdateRequest

Responses

200

Returns success message if contract was succesfully updated.

application/json

ContractUpdateRequest

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch/contract

PATCH /rest/contract HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "data": {
    "contract_no": "123456",
    "name": "Network contract",
    "startdate": "2017-06-01",
    "enddate": "2018-06-01",
    "contractstatus": "closed",
    "type": "insurance",
    "termination_date": "2022-06-01",
    "terminationterm": "14",
    "product": "Home insurance"
  }
}

{
  "data": {
    "contract_no": "123456",
    "name": "Network contract",
    "startdate": "2017-06-01",
    "enddate": "2018-06-01",
    "contractstatus": "closed",
    "type": "insurance",
    "termination_date": "2022-06-01",
    "terminationterm": "14",
    "product": "Home insurance"
  }
}