Modify Agreement

PATCH 
/agreements/:id

Modify an existing agreement. Rules

• Excluding the initiatingParty there must only be uniLateral or biLateral fields present. They are mutually exclusive.

• If uniLateral.destination.account.type is "BSB" then uniLateral.destination.account.bsb and uniLateral.destination.account.number are required.

• If uniLateral.destination.account.type is "alternateIdentification" then uniLateral.destination.account.alternateIdentification.type and uniLateral.destination.account.alternateIdentification.value are required.

Request

Responses

202

Accepted

Response Headers

Content-Language
Content-Type

400

Bad Request

Request is not well-formed, syntactically incorrect, or violates schema.

Response Headers

Content-Language
Content-Type

401

Unauthorized

Requires authentication

Response Headers

Content-Language
Content-Type

403

Forbidden

Token is missing required authorization scope

Response Headers

Content-Language
Content-Type

404

Not Found

Response Headers

Content-Language
Content-Type

422

Unprocessable Entity

The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.

Response Headers

Content-Language
Content-Type

500

Internal Server Error

An internal server error has occurred.

Response Headers

Content-Language
Content-Type

503

Service Unavailable - Temporarily Unavailable

Response Headers

Content-Language
Content-Type