Contract / Billing

Get contract billing status

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

GET

/fm/contract/billing/status

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

{
  "billing_started": "yes",
  "billing_structure": {
    "billing_interval": "<string>",
    "common_day": "<string>",
    "initial_billings": 0,
    "initials_billed": true,
    "payment_method": "direct-debit",
    "periodic_billings": 0,
    "periodic_start": 0,
    "periodic_start_date": "YYYY-MM-DD",
    "periodics_billed": true,
    "periods_remaining": 0,
    "total_billings": 0
  },
  "lease_structure": {
    "contract_end": "YYYY-MM-DD",
    "contract_start": "YYYY-MM-DD",
    "contract_type_code": "<string>",
    "contract_type_name": "<string>",
    "inertia_flag": "yes",
    "posting_map_id": "<string>",
    "term": 0
  },
  "life_budget": {
    "ltd": {
      "gst": 0,
      "net": 0,
      "total": 0
    },
    "remaining": {
      "gst": 0,
      "net": 0,
      "total": 0
    },
    "wlf": {
      "gst": 0,
      "net": 0,
      "total": 0
    }
  },
  "next_date": "YYYY-MM-DD",
  "next_interval": "<string>",
  "next_period": 0,
  "previous_date": "YYYY-MM-DD",
  "previous_interval": "<string>",
  "previous_period": 0,
  "rental_billing_summary": {
    "final": {
      "billing_date": "YYYY-MM-DD",
      "gst": 0,
      "invoice_no": "<string>",
      "invoice_type": "<string>",
      "net": 0,
      "period": 0,
      "total": 0
    },
    "initial": {
      "billing_date": "YYYY-MM-DD",
      "gst": 0,
      "invoice_no": "<string>",
      "invoice_type": "<string>",
      "net": 0,
      "period": 0,
      "total": 0
    },
    "next": {
      "billing_date": "YYYY-MM-DD",
      "gst": 0,
      "invoice_no": "<string>",
      "invoice_type": "<string>",
      "net": 0,
      "period": 0,
      "total": 0
    },
    "previous": {
      "billing_date": "YYYY-MM-DD",
      "gst": 0,
      "invoice_no": "<string>",
      "invoice_type": "<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

Query Parameters

contract_idstringqueryrequired

Contract Id

Maximum string length: 10

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

Response

Success

billing_startedenum<string>

Available options: yes, no

billing_structureobject

Billing configuration/status, equivalent to the "Billing Structure" panel on the legacy Contract Billing screen. When no billing schedule exists yet, these values are derived from the contract's own persisted defaults and the client's billing defaults, mirroring the legacy screen's behaviour before a contract has started billing.

Show child attributes

lease_structureobject

Contract term/dates/type/inertia, equivalent to the "Lease Structure" panel on the legacy Contract Billing screen. Most of this is also available on getContract; it's duplicated here for convenience.

Show child attributes

life_budgetobject

Whole-of-life budget totals, equivalent to the "Life Budget" panel on the legacy Contract Billing screen.

Show child attributes

next_datestring

Next pending billing date

Example: YYYY-MM-DD

next_intervalstring

Next pending billing interval

next_periodinteger

Next pending billing period

Example: 0

previous_datestring

Last billing date

Example: YYYY-MM-DD

previous_intervalstring

Last billing interval

previous_periodinteger

Last billing period

Example: 0

rental_billing_summaryobject

Per-period billing totals, equivalent to the "Rental Billing Summary" panel on the legacy Contract Billing screen.

Show child attributes

Still need help? Ask the team