Contracts API: getContractFunds

Overview

Overview

This API allows you to retrieve values that are displayed in the Funds Check pop-up.
This is called by Contract ID.
You can schedule reports that use Funds Check values by using the funds_check placeholder library.
You can also use the funds_check placeholder library to return values using exportQuery reports too.

Visit https://api.test.catch-e.com/docs/#/Contracts/getContractFunds

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'SignonToken:Create'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

API access to this function is provided to the role 'web-services' as the default setting.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Endpoint

https://api.catch-e.com/fm/contract/funds

Input Fields

Query Parameters

Input Example

https://api.catch-e.com/fm/contract/funds?contract_id=100000

Output Example (Successful)

{
  "budgets": {
    "Finance": {
      "budget": 57791.88,
      "budget_net": 52538.04,
      "budget_gst": 5253.84,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 57791.88,
      "available": 0,
      "posting_class_codes": [
        "CSD",
        "FIN"
      ],
      "available_to_claim": "no",
      "report_budget_as_actual": "no"
    },
    "Maintenance": {
      "budget": 6050.16,
      "budget_net": 5500.08,
      "budget_gst": 550.08,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 6050.16,
      "available": 6050.16,
      "posting_class_codes": [
        "S",
        "M",
        "MAINT"
      ],
      "available_to_claim": "yes",
      "report_budget_as_actual": "no"
    },
    "Tyres": {
      "budget": 6415.2,
      "budget_net": 5832,
      "budget_gst": 583.2,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 6415.2,
      "available": 6415.2,
      "posting_class_codes": [
        "T"
      ],
      "available_to_claim": "yes",
      "report_budget_as_actual": "no"
    },
    "Registration / CTP": {
      "budget": 1814.76,
      "budget_net": 1649.88,
      "budget_gst": 164.88,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 1814.76,
      "available": 1814.76,
      "posting_class_codes": [
        "CTP",
        "REG"
      ],
      "available_to_claim": "yes",
      "report_budget_as_actual": "no"
    },
    "Insurance": {
      "budget": 571.32,
      "budget_net": 519.48,
      "budget_gst": 51.84,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 571.32,
      "available": 571.32,
      "posting_class_codes": [
        "INSUP",
        "ISD",
        "INSFEE",
        "FSL",
        "INS"
      ],
      "available_to_claim": "no_if_payment_active",
      "report_budget_as_actual": "no",
      "payment_active": false
    },
    "Fees": {
      "budget": 0,
      "budget_net": 0,
      "budget_gst": 0,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 0,
      "available": 0,
      "posting_class_codes": [
        "NFEE",
        "MFEE",
        "FFEE",
        "IFEE",
        "DFEE"
      ],
      "available_to_claim": "ignore",
      "report_budget_as_actual": "yes"
    },
    "Fuel": {
      "budget": 51480,
      "budget_net": 46800,
      "budget_gst": 4680,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 51480,
      "available": 51480,
      "posting_class_codes": [
        "F"
      ],
      "available_to_claim": "yes",
      "report_budget_as_actual": "no"
    },
    "Other": {
      "budget": 122.12,
      "budget_net": 111,
      "budget_gst": 11.12,
      "actual": 122.12,
      "actual_net": 111,
      "actual_gst": 11.12,
      "variance": 0,
      "available": 0,
      "posting_class_codes": [
        "ECMC",
        "A",
        "EW",
        "CEO",
        "RRES",
        "SDR",
        "DC",
        "LRN",
        "BF",
        "WOF",
        "TR",
        "R",
        "MCLB",
        "RVEH",
        "GINS",
        "TOL",
        "O",
        "W",
        "FDEL",
        "INT",
        "PRI",
        "ODO",
        "INF",
        "ECM",
        "RSA"
      ],
      "available_to_claim": "yes",
      "report_budget_as_actual": "no"
    },
    "Road Side Assistance": {
      "budget": 0,
      "budget_net": 0,
      "budget_gst": 0,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 0,
      "available": 0,
      "posting_class_codes": [
        "AMFEE"
      ],
      "available_to_claim": "ignore",
      "report_budget_as_actual": "yes"
    },
    "Budgeted Inclusions": {
      "budget": 0,
      "budget_net": 0,
      "budget_gst": 0,
      "actual": 0,
      "actual_net": 0,
      "actual_gst": 0,
      "variance": 0,
      "available": 0,
      "posting_class_codes": [
        "DRINS",
        "IPBAM"
      ],
      "available_to_claim": "no",
      "report_budget_as_actual": "no"
    }
  },
  "budget": 124245.44,
  "budget_net": 112950.48,
  "budget_gst": 11294.96,
  "actual": 122.12,
  "actual_net": 111,
  "actual_gst": 11.12,
  "variance": 124123.32,
  "available": 66331.44,
  "funds_received": 0,
  "funds_variance": -124245.44,
  "available_balance": -57914,
  "actual_balance": -122.12
}

Error Response

{
  "warning_messages": {
    "fieldName": {
      "warningException": "A textual description of the warning exception."
    }
  },
  "validation_messages": {
    "fieldName": {
      "validationException": "A textual description of the validation exception."
    }
  },
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Failed Validation"
}