Contracts

Perform a contract funds check

This method requires the Contract:FundsCheck permission to be associated with your role.

GET

/fm/contract/funds

curl --request GET \
  --url 'https://api.catch-e.com/fm/contract/funds?contract_id=%3Cstring%3E' \
  --header 'Authorization: <api-key>'

{
  "actual": 10240.35,
  "actual_balance": 88.75,
  "actual_gst": 930.94,
  "actual_net": 9309.41,
  "available": 1121.66,
  "available_balance": 2154.57,
  "budget": 11362.01,
  "budget_gst": 1032.91,
  "budget_net": 10329.1,
  "budgets": {
    "Finance": {
      "actual": 7436.16,
      "actual_gst": 676.01,
      "actual_net": 6760.15,
      "available": -619.68,
      "available_to_claim": "no",
      "budget": 6816.48,
      "budget_gst": 619.68,
      "budget_net": 6196.8,
      "posting_class_codes": [
        "CSD",
        "FIN"
      ],
      "report_budget_as_actual": "no",
      "variance": -619.68
    },
    "Maintenance": {
      "actual": 334,
      "actual_gst": 30.36,
      "actual_net": 303.64,
      "available": 412.24,
      "available_to_claim": "yes",
      "budget": 746.24,
      "budget_gst": 67.84,
      "budget_net": 678.4,
      "posting_class_codes": [
        "M",
        "MAINT",
        "S"
      ],
      "report_budget_as_actual": "no",
      "variance": 412.24
    }
  },
  "funds_received": 10329.1,
  "funds_variance": 1032.91,
  "variance": 1121.66
}

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

Query Parameters

contract_idstringqueryrequired

Contract Id

Maximum string length: 10

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

Response

Success

actualnumber

Example: 10240.35

actual_balancenumber

Example: 88.75

actual_gstnumber

Example: 930.94

actual_netnumber

Example: 9309.41

availablenumber

Example: 1121.66

available_balancenumber

Example: 2154.57

budgetnumber

Example: 11362.01

budget_gstnumber

Example: 1032.91

budget_netnumber

Example: 10329.1

budgetsobject

funds_receivednumber

Example: 10329.1

funds_variancenumber

Example: 1032.91

variancenumber

Example: 1121.66

Still need help? Ask the team