GetContractBillingStatus
Overview
Returns the billing status and billing structure information for a specific contract.
Supplementary SWAGGER documentation: https://api.catch-e.com/docs
Permissions
This method requires the ContractBilling:Get permission to be associated with your role.
HTTP Method
Use the HTTP Method 'GET' for consuming this web service.
Header Parameters
URL Example
https://api.catch-e.com/fm/contract/billing/status/{contract_id}Response Example
JSON
{
"billing_started": "yes",
"previous_period": 0,
"previous_date": "YYYY-MM-DD",
"previous_interval": "string",
"next_period": 0,
"next_date": "YYYY-MM-DD",
"next_interval": "string",
"life_budget": {
"wlf": {
"net": 0,
"gst": 0,
"total": 0
},
"ltd": {
"net": 0,
"gst": 0,
"total": 0
},
"remaining": {
"net": 0,
"gst": 0,
"total": 0
}
},
"rental_billing_summary": {
"initial": {
"billing_date": "YYYY-MM-DD",
"period": 0,
"invoice_no": "string",
"invoice_type": "string",
"net": 0,
"gst": 0,
"total": 0
},
"previous": {
"billing_date": "YYYY-MM-DD",
"period": 0,
"invoice_no": "string",
"invoice_type": "string",
"net": 0,
"gst": 0,
"total": 0
},
"next": {
"billing_date": "YYYY-MM-DD",
"period": 0,
"invoice_no": "string",
"invoice_type": "string",
"net": 0,
"gst": 0,
"total": 0
},
"final": {
"billing_date": "YYYY-MM-DD",
"period": 0,
"invoice_no": "string",
"invoice_type": "string",
"net": 0,
"gst": 0,
"total": 0
}
},
"lease_structure": {
"term": 0,
"contract_start": "YYYY-MM-DD",
"contract_end": "YYYY-MM-DD",
"posting_map_id": "string",
"contract_type_code": "string",
"contract_type_name": "string",
"inertia_flag": "yes"
},
"billing_structure": {
"billing_interval": "string",
"total_billings": 0,
"initial_billings": 0,
"periodic_billings": 0,
"periodic_start": 0,
"periodic_start_date": "YYYY-MM-DD",
"common_day": "string",
"periods_remaining": 0,
"payment_method": "direct-debit",
"initials_billed": true,
"periodics_billed": true
}
}
Response - 200 OK
Returns billing status, budget information, rental billing summaries, lease structure details and billing configuration for the specified contract.
JSON
{
"billing_started_flag": "yes",
"previous_period": 7,
"previous_date": "2010-09-01",
"previous_interval": "monthly",
"next_period": 8,
"next_date": "2010-10-01",
"next_interval": "monthly",
"life_budget": {
"wlf": {
"net": 74694.90,
"gst": 7469.35,
"total": 82164.25
},
"ltd": {
"net": 14938.98,
"gst": 1493.87,
"total": 16432.85
},
"remaining": {
"net": 59755.95,
"gst": 5975.49,
"total": 65731.44
}
},
"rental_billing_summary": {
"initial": {
"billing_date": "",
"period": 0,
"invoice_no": "",
"invoice_type": "",
"net": 0,
"gst": 0,
"total": 0
},
"previous": {
"billing_date": "2010-09-01",
"period": 7,
"invoice_no": "101979",
"invoice_type": "combined",
"net": 2134.14,
"gst": 213.41,
"total": 2347.55
},
"next": {
"billing_date": "2010-10-01",
"period": 8,
"invoice_no": "",
"invoice_type": "",
"net": 2134.14,
"gst": 213.41,
"total": 2347.55
},
"final": {
"billing_date": "2013-01-01",
"period": 35,
"invoice_no": "",
"invoice_type": "",
"net": 2134.14,
"gst": 213.41,
"total": 2347.55
}
},
"lease_structure": {
"term": 36,
"contract_start": "2010-03-14",
"contract_end": "2013-03-13",
"posting_map_id": "100014",
"contract_type_code": "NOM",
"contract_type_name": "Novated Fully Maintained",
"inertia_flag": "no"
},
"billing_structure": {
"billing_interval": "monthly",
"total_billings": 35,
"initial_billings": 0,
"periodic_billings": 35,
"periodic_start": 1,
"periodic_start_date": "2010-03-14",
"common_day": "1",
"periods_remaining": 28,
"payment_method": "",
"initials_billed": true,
"periodics_billed": true
}
}Response - 401 Unauthorized
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Unauthorized",
"status": 401,
"detail": "Unauthorized"
}
Possible causes:
You have not authenticated before calling the API.
The current session token has expired and authentication is required again.
Response - 403 Forbidden
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Forbidden",
"status": 403,
"detail": "Forbidden"
}You do not have permission to access this endpoint.
To grant access:
Go to System Roles.
Open role web_services.
Navigate to Roles / APIs.
Enable the permission required for this API.
Response - 404 Not Found
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Not Found",
"status": 404,
"detail": "Not Found"
}Response - 406 Not Acceptable
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Not Acceptable",
"status": 406,
"detail": "Not Acceptable"
}Response - 422 Unprocessable Entity
JSON
{
"warning_messages": {
"fieldName": {
"warningExceptionCode": "A textual description of the warning exception"
}
},
"validation_messages": {
"fieldName": {
"validationExceptionCode": "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"
}
The supplied data is invalid, incorrectly formatted, or a required field is missing.
Response - 423 Locked
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Locked",
"status": 423,
"detail": "Locked"
}Response - 500 Internal Error
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "string",
"status": 599,
"detail": "string"
}Response - Default Unexpected Error
JSON
{
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "string",
"status": 599,
"detail": "string"
}