Contract / Budgets

Insert new contract budgets

This method requires the ContractBudgets:Insert permission to be associated with your role. The ContractSuspended 422 validation key is returned for a Contract carrying a Suspend Date only where the tenant's fm / invoice_suspended_contracts_flag global control is not set to yes; where it is yes, an adjustment may be inserted on a suspended (or terminated) Contract.

POST

/fm/contract/budgets/insert

curl --request POST \
  --url https://api.catch-e.com/fm/contract/budgets/insert \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "billing_date": "YYYY-MM-DD",
    "billing_period": 1,
    "billing_period_item_no": 2,
    "budgets": {},
    "contract_id": "100001",
    "payment_method": "direct-debit"
  }
]
'

{
  "affected_records": 123
}

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

JSON payload

itemsobject[]

Show child attributes

Response

Contract budgets created successfully

affected_recordsinteger

Example: 123

Still need help? Ask the team