Manipulate Company Data (API Filing): transaction

Methods

post - Create a transaction
get - Get a transaction
put - Update a transaction

Resource

{
    "closed_at": "date-time",
    "closed_by": {
        "email": "string",
        "forename": "string",
        "id": "string",
        "language": "string",
        "surname": "string"
    },
    "company_name": "string",
    "company_number": "string",
    "created_at": "date-time",
    "created_by": {
        "email": "string",
        "forename": "string",
        "id": "string",
        "language": "string",
        "surname": "string"
    },
    "description": "string",
    "etag": "string",
    "filings": {
        "<key>": {
            "company_number": "string",
            "cost": "string",
            "created_on": "date-time",
            "description": "string",
            "description_identifier": "string",
            "description_values": {
                "<key>": "string"
            },
            "links": {
                "resource": "string"
            },
            "processed_at": "date-time",
            "refund_processed_at": "date-time",
            "refund_requested_at": "date-time",
            "refund_status": "string",
            "reject_reasons": [
                {
                    "english": "string",
                    "welsh": "string"
                }
            ],
            "status": "string",
            "type": "string"
        }
    },
    "id": "string",
    "kind": "string",
    "links": {
        "payment": "string",
        "self": "string",
        "validation_status": "string"
    },
    "reference": "string",
    "resources": {
        "<key>": {
            "kind": "string",
            "links": {
                "costs": "string",
                "resource": "string",
                "validation_status": "string"
            },
            "updated_at": "date-time",
            "updated_by": {
                "email": "string",
                "forename": "string",
                "id": "string",
                "language": "string",
                "surname": "string"
            }
        }
    },
    "resume_journey_uri": "string",
    "status": "string",
    "submitted_by": {
        "application_id": "string",
        "user_id": "string"
    },
    "updated_at": "date-time"
}

Properties

Name	Type	Description	Additional
closed_at	date-time	The date and time the transaction was closed.	Optional, read only.
closed_by	object	The user who closed the transaction	Optional, read only.
closed_by.email	string	The user's email address.	Read only.
closed_by.forename	string	The user's forename.	Optional, read only.
closed_by.id	string	The user's unique identifier.	Read only.
closed_by.language	string	The language to use for electronic communications related to this transaction. This is BROKEN because it cannot be set by client! and only applies to `closed_by` Possible values are: `en` `cy`	Read only.
closed_by.surname	string	The user's surname.	Optional, read only.
company_name	string	The company name the transaction is for.	Optional, read only.
company_number	string	The company number of the company that the transaction will modify. The user must be authorised to create transactions for this company (at least one matching company-permission scope must be present on the supplied `access_token`). If no company number is supplied, the transaction will be created outside of any company and cannot be used to modify existing company data.	Optional
created_at	date-time	The date and time the transaction was created.	Read only.
created_by	object	The user who created the transaction.	Read only.
created_by.email	string	The user's email address.	Read only.
created_by.forename	string	The user's forename.	Optional, read only.
created_by.id	string	The user's unique identifier.	Read only.
created_by.language	string	The language to use for electronic communications related to this transaction. This is BROKEN because it cannot be set by client! and only applies to `closed_by` Possible values are: `en` `cy`	Read only.
created_by.surname	string	The user's surname.	Optional, read only.
description	string	The description of intent for this transaction.
etag	string	The ETag of the resource	Read only.
filings	object	Collection of the legal filings generated from the resources contained within this transaction, once the transaction is closed and processed. Each filing is given it's own unique `submission_id`.	Optional, read only.
filings.<key>	map of object	Map of filing `submission_id` to filing object.	Optional
filings.<key>.company_number	string	The company number of the company the filing was created.	Optional, read only.
filings.<key>.cost	string	The cost of the filing, in pounds.	Optional, read only.
filings.<key>.created_on	date-time	The date the filing was created.	Optional, read only.
filings.<key>.description	string	The description of the filing.	Optional, read only.
filings.<key>.description_identifier	string	The description identifier of the filing. Possible values are: `abridged-accounts` `change-registered-office-address`	Optional, read only.
filings.<key>.description_values	object	A collection of key / value string pairs to be used to populate placeholders in the description indicated by `description_identifier`.	Optional, read only.
filings.<key>.description_values.<key>	map of string	key / value string pair.	Optional, read only.
filings.<key>.links	object	A set of URLs related to the resource.	Read only.
filings.<key>.links.resource	string	Link to the resource from which this filing was derived.	Read only.
filings.<key>.processed_at	date-time	The date and time the filing was processed.	Optional, read only.
filings.<key>.refund_processed_at	date-time	The date and time at which the refund was processed.	Optional, read only.
filings.<key>.refund_requested_at	date-time	The date and time at which the refund was requested.	Optional, read only.
filings.<key>.refund_status	string	The status of the refund.	Optional, read only.
filings.<key>.reject_reasons[]	array	List of reject reasons.	Optional, read only.
filings.<key>.reject_reasons[].english	string	The reject reason in english.	Read only.
filings.<key>.reject_reasons[].welsh	string	The reject reason in welsh.	Optional, read only.
filings.<key>.status	string	The status of the filing following processing. Possible values are: `accepted` `processing` `rejected`	Read only.
filings.<key>.type	string	The type of filing. Possible values are: `accounts` `change-of-registered-office-address`	Read only.
id	string	The transaction ID	Read only.
kind	string	The type of resource. Possible values are: `transaction`	Read only.
links	object	A set of URLs related to the transaction.	Read only.
links.payment	string	The URL of the payment resource for the transaction. If present, returned data incudes itemised costs for chargable resources within the transaction.	Optional, read only.
links.self	string	The URL of the transaction.	Read only.
links.validation_status	string	The URL of the validation status resource for the transaction.	Read only.
reference	string	The user reference assiged to this transaction.	Optional
resources	object	List of resources contained within this transaction.	Optional, read only.
resources.<key>	map of object	Map of resource 'identifier' to resource object	Optional
resources.<key>.kind	string	The type of resource. Possible values are: `accounts`	Read only.
resources.<key>.links	object	A set of URLs related to the resource.	Read only.
resources.<key>.links.costs	string	The URL of the costs resource related to this resource. If present, returns itemised costs for the resource.	Optional, read only.
resources.<key>.links.resource	string	The URL of the resource.	Read only.
resources.<key>.links.validation_status	string	The URL of the validation status resource for the resource.	Optional, read only.
resources.<key>.updated_at	date-time	The date and time the resource was updated.	Read only.
resources.<key>.updated_by	object	The user who last updated the resource.	Read only.
resources.<key>.updated_by.email	string	The user's email address.	Read only.
resources.<key>.updated_by.forename	string	The user's forename.	Optional, read only.
resources.<key>.updated_by.id	string	The user's unique identifier.	Read only.
resources.<key>.updated_by.language	string	The language to use for electronic communications related to this transaction. This is BROKEN because it cannot be set by client! and only applies to `closed_by` Possible values are: `en` `cy`	Read only.
resources.<key>.updated_by.surname	string	The user's surname.	Optional, read only.
resume_journey_uri	string	The URL that can be used to resume a web journey associated with this transaction.	Optional
status	string	The status of the transaction. Possible values are: `open` `closed`
submitted_by	object	The data returned on a closure of a transaction to determine which avenue the filing has come from	Optional, read only.
submitted_by.application_id	string	The ID of the Api Client used to complete the transaction	Optional, read only.
submitted_by.user_id	string	The ID of the User used to complete the transaction	Optional, read only.
updated_at	date-time	The date and time the transaction was updated.	Optional, read only.

transaction resource

Methods

Resource

Properties