About

This Node JS package makes it easy to consume E-filing's API (http://www.efiling.co.uk).

The WSDL can be found at http://api.efiling.co.uk/wsdl

If you have any questions, get in touch with us at https://www.formationsfactory.co.uk

Install

Install using npm:

npm instal node-efiling

To install and save the package to package.json:

npm instal node-efiling --save

Example usage

var Efiling = require('node-efiling');
var API = new Efiling.API('YOUR API KEY');

var user;
var registeredOffice;
var incorporation;
API.createClient()
    .then(function(result) {
        if (result.error) {
            // handle
        } else {
            return API.CreateUpdateUser({
                FirstName: 'John',
                LastName: 'Doe'
            });
        }
    })
    .then(function(result) {
        user = result.CreateUpdateUserResult;
    })
    .then(function() {
        return API.CreateUpdateAddress({
            NameNumber: '71-75',
            Street: 'Shelton Street',
            Town: 'London',
            County: '',
            PostCode: 'WC2H 9JQ',
            Country: {
                CountryId: '1' // 1 === UK
            }
        }, user);
    })
    .then(function(result) {
        registeredOffice = result.CreateUpdateAddressResult;
        return API.CreateUpdateIncorporation({
            Name: 'THE FORMATIONS FACTORY LTD',
            Type: {
                TypeId: 2 // 2 === LbS, 4 === LbG
            },
            RegisteredOffice: registeredOffice
        }, user);
    })
    .then(function(result) {
        console.log(result);
        incorporation = result.CreateUpdateIncorporationResult;
    });

Additional information

Company type IDs

"PLC": 1,
"LBS": 2,
"LBG": 3,
"LLP": 4

Country IDs

"UNITED KINGDOM": 1,
"ENGLAND": 2,
"SCOTLAND": 3,
"WALES": 4,
"NORTHERN IRELAND": 5,
"REPUBLIC OF IRELAND": 6,
"AFGHANISTAN": 7,
"ALBANIA": 8,
"ALGERIA": 9,
"AMERICAN SAMOA": 10,
"ANDORRA": 11,
"ANGOLA": 12,
"ANGUILLA": 13,
"ANTARCTICA": 14,
"ANTIGUA AND BARBUDA": 15,
"ARGENTINA": 16,
"ARMENIA": 17,
"ARUBA": 18,
"AUSTRALIA": 19,
"AUSTRIA": 20,
"AZERBAIJAN": 21,
"BAHAMAS": 22,
"BAHRAIN": 23,
"BANGLADESH": 24,
"BARBADOS": 25,
"BELARUS": 26,
"BELGIUM": 27,
"BELIZE": 28,
"BENIN": 29,
"BERMUDA": 30,
"BHUTAN": 31,
"BOLIVIA": 32,
"BOSNIA AND HERZEGOVINA": 33,
"BOTSWANA": 34,
"BOUVET ISLAND": 35,
"BRAZIL": 36,
"BRITISH INDIAN OCEAN TERRITORY": 37,
"BRUNEI DARUSSALAM": 38,
"BULGARIA": 39,
"BURKINA FASO": 40,
"BURUNDI": 41,
"CAMBODIA": 42,
"CAMEROON": 43,
"CANADA": 44,
"CAPE VERDE": 45,
"CAYMAN ISLANDS": 46,
"CENTRAL AFRICAN REPUBLIC": 47,
"CHAD": 48,
"CHILE": 49,
"CHINA": 50,
"CHRISTMAS ISLAND": 51,
"COCOS (KEELING) ISLANDS": 52,
"COLOMBIA": 53,
"COMOROS": 54,
"CONGO": 55,
"COOK ISLANDS": 56,
"COSTA RICA": 57,
"CROATIA": 58,
"CUBA": 59,
"CYPRUS": 60,
"CZECH REPUBLIC": 61,
"CôTE D'IVOIRE": 62,
"DENMARK": 63,
"DJIBOUTI": 64,
"DOMINICA": 65,
"DOMINICAN REPUBLIC": 66,
"EAST TIMOR": 67,
"ECUADOR": 68,
"EGYPT": 69,
"EL SALVADOR": 70,
"EQUATORIAL GUINEA": 71,
"ERITREA": 72,
"ESTONIA": 73,
"ETHIOPIA": 74,
"FALKLAND ISLANDS": 75,
"FAROE ISLANDS": 76,
"FIJI": 77,
"FINLAND": 78,
"FRANCE": 79,
"FRENCH GUIANA": 80,
"FRENCH POLYNESIA": 81,
"FRENCH SOUTHERN TERRITORIES": 82,
"GABON": 83,
"GAMBIA": 84,
"GEORGIA": 85,
"GERMANY": 86,
"GHANA": 87,
"GIBRALTAR": 88,
"GREECE": 89,
"GREENLAND": 90,
"GRENADA": 91,
"GUADELOUPE": 92,
"GUAM": 93,
"GUATEMALA": 94,
"GUINEA": 95,
"GUINEA-BISSAU": 96,
"GUYANA": 97,
"HAITI": 98,
"HEARD ISLAND AND MCDONALD ISLANDS": 99,
"HOLY SEE (VATICAN CITY STATE)": 100,
"HONDURAS": 101,
"HONG KONG": 102,
"HUNGARY": 103,
"ICELAND": 104,
"INDIA": 105,
"INDONESIA": 106,
"IRAN": 107,
"IRAQ": 108,
"IRELAND": 109,
"ISRAEL": 110,
"ITALY": 111,
"JAMAICA": 112,
"JAPAN": 113,
"JORDAN": 114,
"KAZAKSTAN": 115,
"KENYA": 116,
"KIRIBATI": 117,
"KUWAIT": 118,
"KYRGYSTAN": 119,
"LAO": 120,
"LATVIA": 121,
"LEBANON": 122,
"LESOTHO": 123,
"LIBERIA": 124,
"LIBYAN ARAB JAMAHIRIYA": 125,
"LIECHTENSTEIN": 126,
"LITHUANIA": 127,
"LUXEMBOURG": 128,
"MACAU": 129,
"MACEDONIA (FYR)": 130,
"MADAGASCAR": 131,
"MALAWI": 132,
"MALAYSIA": 133,
"MALDIVES": 134,
"MALI": 135,
"MALTA": 136,
"MARSHALL ISLANDS": 137,
"MARTINIQUE": 138,
"MAURITANIA": 139,
"MAURITIUS": 140,
"MAYOTTE": 141,
"MEXICO": 142,
"MICRONESIA": 143,
"MOLDOVA": 144,
"MONACO": 145,
"MONGOLIA": 146,
"MONTSERRAT": 147,
"MOROCCO": 148,
"MOZAMBIQUE": 149,
"MYANMAR": 150,
"NAMIBIA": 151,
"NAURU": 152,
"NEPAL": 153,
"NETHERLANDS": 154,
"NETHERLANDS ANTILLES": 155,
"NEW CALEDONIA": 156,
"NEW ZEALAND": 157,
"NICARAGUA": 158,
"NIGER": 159,
"NIGERIA": 160,
"NIUE": 161,
"NORFOLK ISLAND": 162,
"NORTH KOREA": 163,
"NORTHERN MARIANA ISLANDS": 164,
"NORWAY": 165,
"OMAN": 166,
"PAKISTAN": 167,
"PALAU": 168,
"PALESTINIAN TERRITORY OCCUPIED": 169,
"PANAMA": 170,
"PAPUA NEW GUINEA": 171,
"PARAGUAY": 172,
"PERU": 173,
"PHILIPPINES": 174,
"PITCAIRN": 175,
"POLAND": 176,
"PORTUGAL": 177,
"PUERTO RICO": 178,
"QATAR": 179,
"REUNION": 180,
"ROMANIA": 181,
"RUSSIAN FEDERATION": 182,
"RWANDA": 183,
"SAINT HELENA": 184,
"SAINT KITTS AND NEVIS": 185,
"SAINT LUCIA": 186,
"SAINT PIERRE AND MIQUELON": 187,
"SAINT VINCENT AND THE GRENADINES": 188,
"SAMOA": 189,
"SAN MARINO": 190,
"SAO TOME AND PRINCIPE": 191,
"SAUDI ARABIA": 192,
"SENEGAL": 193,
"SEYCHELLES": 194,
"SIERRA LEONE": 195,
"SINGAPORE": 196,
"SLOVAKIA": 197,
"SLOVENIA": 198,
"SOLOMON ISLANDS": 199,
"SOMALIA": 200,
"SOUTH AFRICA": 201,
"SOUTH GEORGIA": 202,
"SOUTH KOREA": 203,
"SPAIN": 204,
"SRI LANKA": 205,
"SUDAN": 206,
"SURINAME": 207,
"SVALBARD AND JAN MAYEN ISLANDS": 208,
"SWAZILAND": 209,
"SWEDEN": 210,
"SWITZERLAND": 211,
"SYRIA": 212,
"TAIWAN": 213,
"TAJIKISTAN": 214,
"TANZANIA": 215,
"THAILAND": 216,
"TOGO": 217,
"TOKELAU": 218,
"TONGA": 219,
"TRINIDAD AND TOBAGO": 220,
"TUNISIA": 221,
"TURKEY": 222,
"TURKMENISTAN": 223,
"TURKS AND CAICOS ISLANDS": 224,
"TUVALU": 225,
"UGANDA": 226,
"UKRAINE": 227,
"UNITED ARAB EMIRATES": 228,
"UNITED STATES": 229,
"UNITED STATES MINOR OUTLYING ISLANDS": 230,
"URUGUAY": 231,
"UZBEKISTAN": 232,
"VANUATU": 233,
"VENEZUELA": 234,
"VIET NAM": 235,
"VIRGIN ISLANDS (BRITISH)": 236,
"VIRGIN ISLANDS (U.S.)": 237,
"WALLIS AND FUTUNA ISLANDS": 238,
"WESTERN SAHARA": 239,
"YEMEN": 240,
"YUGOSLAVIA": 241,
"ZAIRE": 242,
"ZAMBIA": 243,
"ZIMBABWE": 244,
"JERSEY": 245,
"GUERNSEY": 246,
"IVORY COAST (COTE D'LVOIRE)": 247,
"ISLE OF MAN": 248,
"SERBIA": 249,
"MONTENEGRO": 250