Direct Integration API icon

Direct Integration API

2.0.x
(0 reviews)

RelatedCompany

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "RelatedCompany": [
                    {
                        "Director": [{
                            "@x_Director": "uRelatedCompanyDir"
                        }],
                        "Contact": {
                            "@x_Address": "aca611351c8b",
                            "@PreferredContact": "Email",
                            "@Email": "email@email.com",
                            "OfficePhone": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "78"
                            },
                            "OfficeFax": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "78"
                            },
                            "ContactPerson": {
                                "@x_ContactPerson": "uRelatedCompanyCP"
                            }
                        },
                        "@BusinessName": "RP BusinessName1",
                        "@CompanyName": "RP CompanyName1",
                        "@NZBNVerified": "No",
                        "@UniqueID": "uAccountant",
                        "@NZBN": "NZBN",
                        "@CompanyNumber": "CompanyNumber",
                        "@DateRegistered": "2020-01-01",
                        "@RegisteredInCountry": "NZ",
                        "@RegisteredForGST": "No",
                        "@GSTRegisteredDate": "2020-01-01",
                        "@TypeOfIncorporation": "Ltd",
                        "@IsHoldingCompany": "No"
                    }
                ]
            }
        }
    }
}
Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
RelatedCompanyA business enterprise (including company, sole trader, partnership, trust, or government department) that is not an applicant but has a role in some aspect of the applicationarrayPackage.Content.Application.RelatedCompany
DirectorContains a reference to an applicant or related party that is a director of the companyarrayPackage.Content.Application.RelatedCompany.Director
@x_DirectorContains a reference to an applicant or related party that is a director of the companystringPackage.Content.Application.RelatedCompany.Director.x_Director
ContactContains contact details for the trust applicantobjectPackage.Content.Application.RelatedCompany.Contact
@x_AddressThe mailing address of the companystringPackage.Content.Application.RelatedCompany.Contact.x_Address
@PreferredContactThe preferred method for contacting this applicantstringPackage.Content.Application.RelatedCompany.Contact.PreferredContactYesEmail,Work Phone
@EmailAn email address for the truststringPackage.Content.Application.RelatedCompany.Contact.EmailYes,if preferedcontact is Email
OfficePhoneOffice number for the trustobjectPackage.Content.Application.RelatedCompany.Contact.OfficePhone
@CountryCodeCaptures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digitsstringPackage.Content.Application.RelatedCompany.Contact.OfficePhone.CountryCodeYes,if preferedcontact is office phone64
@NewZealandDialingCodeThe Area Code prefix for a New Zealand telephone numberstringPackage.Content.Application.RelatedCompany.Contact.OfficePhone.NewZealandDialingCodeYes,if preferedcontact is office phone01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@NumberThe local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once onlystringPackage.Content.Application.RelatedCompany.Contact.OfficePhone.NumberYes,if preferedcontact is office phone
OfficeFaxFax number for the trustobjectPackage.Content.Application.RelatedCompany.Contact.OfficeFax
@CountryCodeCaptures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digitsstringPackage.Content.Application.RelatedCompany.Contact.OfficeFax.CountryCode64
@NewZealandDialingCodeThe Area Code prefix for a New Zealand telephone numberstringPackage.Content.Application.RelatedCompany.Contact.OfficeFax.NewZealandDialingCode01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@NumberThe local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once onlystringPackage.Content.Application.RelatedCompany.Contact.OfficeFax.NumberYes
ContactPersonContains information for the contact person for the trustobjectPackage.Content.Application.RelatedCompany.Contact.ContactPerson
@x_ContactPersonA contact person for the truststringPackage.Content.Application.RelatedCompany.Contact.ContactPerson.x_ContactPersonYes
@BusinessNameThe business name or trading name of the companystringPackage.Content.Application.RelatedCompany.BusinessName
@CompanyNameThe registered name of the companystringPackage.Content.Application.RelatedCompany.CompanyName
@NZBNVerifiedFlag to indicate that the business number has been verified by a searchstringPackage.Content.Application.RelatedCompany.NZBNVerified
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.RelatedCompany.UniqueID
@NZBNThe NZBN of the related companystringPackage.Content.Application.RelatedCompany.NZBN
@CompanyNumberThe registered Company Number of the related companystringPackage.Content.Application.RelatedCompany.CompanyNumber
@DateRegisteredIndicates the date when the company was registeredstringPackage.Content.Application.RelatedCompany.DateRegistered
@RegisteredInCountryIndicates the country where the company is registeredstringPackage.Content.Application.RelatedCompany.RegisteredInCountry
@RegisteredForGSTFlag to indicate whether the company is registered for GSTstringPackage.Content.Application.RelatedCompany.RegisteredForGST
@GSTRegisteredDateIf registered for GST, the date from which the company is registeredstringPackage.Content.Application.RelatedCompany.GSTRegisteredDate
@TypeOfIncorporationThe company structure, in the form of the type of incorporationstringPackage.Content.Application.RelatedCompany.TypeOfIncorporation
@IsHoldingCompanyIndicate if the company is a holding companystringPackage.Content.Application.RelatedCompany.IsHoldingCompany

Reviews