Contract / Budgets

Get a contract budget by contract budget id

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

GET

/fm/contract/budgets/{contract_budget_id}

curl --request GET \
  --url https://api.catch-e.com/fm/contract/budgets/{contract_budget_id} \
  --header 'Authorization: <api-key>'

{
  "amount_gst": 123,
  "amount_net": 123,
  "billing_date": "YYYY-MM-DD",
  "billing_interval": "<string>",
  "billing_period": 123,
  "billing_period_item_no": 123,
  "billing_type_flag": "<string>",
  "contract_id": "100000",
  "id": "<string>",
  "payment_method": "direct-debit",
  "posting_class_code": "<string>",
  "posting_class_id": "<string>",
  "status_flag": "<string>"
}

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

Path Parameters

contract_budget_idstringrequired

Maximum string length: 40

Pattern: ^[0-9a-f]{40}$

Response

Success

amount_gstnumber

amount_netnumber

billing_datestring

Billing date

Example: YYYY-MM-DD

billing_intervalstring

billing_periodnumber

billing_period_item_nonumber

billing_type_flagstring

contract_idstring

Contract Id

Example: 100000

idstring

payment_methodenum<string>

Available options: direct-debit, cheque, cash, credit-card, eft, other

Example: direct-debit

posting_class_codestring

posting_class_idstring

status_flagstring

Still need help? Ask the team