chargeDetails resource

Methods

• get - Get a single charge for a company

Resource Representation

{
   "acquired_on" : "date",
   "assets_ceased_released" : "string",
   "charge_code" : "string",
   "charge_number" : "integer",
   "classification" : {
      "description" : "string",
      "type" : "string"
   },
   "covering_instrument_date" : "date",
   "created_on" : "date",
   "delivered_on" : "date",
   "etag" : "string",
   "id" : "string",
   "insolvency_cases" : [
      {
         "case_number" : "integer",
         "links" : {
            "case" : "string"
         },
         "transaction_id" : "integer"
      }
   ],
   "links" : {
      "self" : "string"
   },
   "more_than_four_persons_entitled" : "boolean",
   "particulars" : {
      "chargor_acting_as_bare_trustee" : "boolean",
      "contains_fixed_charge" : "boolean",
      "contains_floating_charge" : "boolean",
      "contains_negative_pledge" : "boolean",
      "description" : "string",
      "floating_charge_covers_all" : "boolean",
      "type" : "string"
   },
   "persons_entitled" : [
      {
         "name" : "string"
      }
   ],
   "resolved_on" : "date",
   "satisfied_on" : "date",
   "scottish_alterations" : {
      "has_alterations_to_order" : "boolean",
      "has_alterations_to_prohibitions" : "boolean",
      "has_restricting_provisions" : "boolean"
   },
   "secured_details" : {
      "description" : "string",
      "type" : "string"
   },
   "status" : "string",
   "transactions" : [
      {
         "delivered_on" : "date",
         "filing_type" : "string",
         "insolvency_case_number" : "integer",
         "links" : {
            "filing" : "string",
            "insolvency_case" : "string"
         },
         "transaction_id" : "integer"
      }
   ]
}

Parameter Name	Type	Description	Additional
acquired_on	date	The date the property or undertaking was acquired on	Optional.
assets_ceased_released	string	Cease/release information about the charge. For enumeration descriptions see assets-ceased-released section in the enumeration mappings. Possible values are: property-ceased-to-belong part-property-release-and-ceased-to-belong part-property-released part-property-ceased-to-belong whole-property-released multiple-filings whole-property-released-and-ceased-to-belong	Optional.
charge_code	string	The charge code is a replacement of the mortgage description	Optional. Only applied to charges submitted post april 2013
charge_number	integer	The charge number is used to reference an individual charge	Only applied to charges submitted pre april 2013
classification	object	Classification information
classification.description	string	Details of the charge classification
classification.type	string	The type of charge classication. For enumeration descriptions see classificationDesc section in the enumeration mappings. Possible values are: charge-description nature-of-charge
covering_instrument_date	date	The date by which the series of debentures were created	Optional.
created_on	date	The date the charge was created	Optional.
delivered_on	date	The date the charge was submitted to Companies House	Optional.
etag	string
id	string	The id of the charge	Optional.
insolvency_cases	object	The insolvency cases related to this charge	Optional.
insolvency_cases.case_number	integer	The number of this insolvency case	Optional.
insolvency_cases.links	object	The resources related to this insolvency case	Optional.
insolvency_cases.links.case	string	Link to the insolvency case data	Optional.
insolvency_cases.transaction_id	integer	The id of the insolvency filing	Optional.
links	object	The resources related to this charge	Optional.
links.self	string	Link to the this charge data
more_than_four_persons_entitled	boolean	Charge has more than four person entitled	Optional. Only applied to charges submitted post april 2013
particulars	object	Details of charge or undertaking	Optional.
particulars.chargor_acting_as_bare_trustee	boolean	The chargor is acting as a bare trustee for the property	Optional.
particulars.contains_fixed_charge	boolean	The charge contains a fixed charge	Optional.
particulars.contains_floating_charge	boolean	The charge contains a floating charge	Optional.
particulars.contains_negative_pledge	boolean	The charge contains a negative pledge	Optional.
particulars.description	string	Details of charge particulars
particulars.floating_charge_covers_all	boolean	The floating charge covers all the property or undertaking or the company	Optional.
particulars.type	string	The type of charge particulars. For enumeration descriptions see particular-description section in the enumeration mappings. Possible values are: short-particulars charged-property-description charged-property-or-undertaking-description brief-description
persons_entitled	object	People that are entitled to the charge	Optional.
persons_entitled.name	string	The name of the person entitled.
resolved_on	date	The date the issue was resolved on	Optional.
satisfied_on	date	The date the charge was satisfied	Optional.
scottish_alterations	object	Information about alterations for Scottish companies	Optional.
scottish_alterations.has_alterations_to_order	boolean	The charge has alterations to order	Optional.
scottish_alterations.has_alterations_to_prohibitions	boolean	The charge has alterations to prohibitions	Optional.
scottish_alterations.has_restricting_provisions	boolean	The charge has provisions restricting the creation of further charges	Optional.
secured_details	object	Information about what is secured against this charge	Optional.
secured_details.description	string	Details of the amount or obligation secured by the charge
secured_details.type	string	The type of secured details. For enumeration descriptions see secured-details-description section in the enumeration mappings. Possible values are: amount-secured obligations-secured
status	string	The status of the charge. For enumeration descriptions see status section in the enumeration mappings. Possible values are: outstanding fully-satisfied part-satisfied satisfied
transactions	object	Transactions that have been filed for the charge.	Optional.
transactions.delivered_on	date	The date the filing was submitted to Companies House	Optional.
transactions.filing_type	string	Filing type which created, updated or satisfied the charge	Optional.
transactions.insolvency_case_number	integer	The insolvency case related to this filing	Optional.
transactions.links	object	The resources related to this filing	Optional.
transactions.links.filing	string	Link to the charge filing data	Optional.
transactions.links.insolvency_case	string	Link to the insolvency case related to this filing	Optional.
transactions.transaction_id	integer	The id of the filing	Optional.