Contract / Budgets

Delete contract budgets

Delete a pending Adjustment or Credit contract budget line.

POST

/fm/contract/budgets/delete

curl --request POST \
  --url https://api.catch-e.com/fm/contract/budgets/delete \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_period": 16,
  "billing_period_item_no": 2,
  "contract_id": "100000"
}
'

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

This method requires the ContractBudgets:Delete permission to be associated with your role.

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

billing_periodintegerrequired

Billing period of the line to delete

Example: 16

billing_period_item_nointegerrequired

Item number of the line to delete. Every fm_contract_budgets row sharing this contract_id, billing_period, and billing_period_item_no (across all posting/budget classes) is deleted as one unit.

Required range: 1 <= x <= 255

Example: 2

contract_idstringrequired

Contract Id

Example: 100000

Response

Success

Still need help? Ask the team