Contract / Payments

Edit payment schedules for one or more payment structures

This method allows you to edit payment schedules for one or more payment structures. This method requires the ContractPaymentSchedules:Edit permission to be associated with your role.

PATCH

/fm/contract/payment-schedules

curl --request PATCH \
  --url https://api.catch-e.com/fm/contract/payment-schedules \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "amount_gst": 87.39,
    "amount_net": 873.91,
    "contract_payment_structure_id": "100000",
    "payment_date": "2021-01-27",
    "payment_period_item_no": 1,
    "payment_period_no": 1,
    "posting_class_id": "100006"
  },
  {
    "amount_gst": 87.39,
    "amount_net": 873.91,
    "contract_payment_structure_id": "100000",
    "payment_date": "2021-02-27",
    "payment_period_item_no": 1,
    "payment_period_no": 2,
    "posting_class_id": "100006"
  }
]
'

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

Array of payment schedule items to update

itemsobject[]

Show child attributes

Response

No Content

Still need help? Ask the team