GET api/Account?nif={nif}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
nif

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Account
NameDescriptionTypeAdditional information
IntegrationKey

Integration Key (PK)

string

None.

CAE3

CAE Code

string

None.

Activity

Text Value Enum Activity Code

string

None.

EnumActivityCode

Enum Activity Code

EnumActivityCodes

None.

ActivityCodeOptionSelected

Activity Code

Collection of Object

None.

Name

Name

string

None.

Email

Email

string

None.

CommercialName

CommercialName

string

None.

EnumAccountCategoryCode

Enum Account Category Code

AccountCategoryCode

None.

AccountCategoryCodeOptionSelected

Account Category Code

integer

None.

AccountCategoryCode

Text Value Enum Account CategoryCode

string

None.

VAT

VAT

string

None.

Telephone

Telephone

string

None.

OtherTelephone

Other Telephone

string

None.

PrimaryContact

Primary Contact

string

None.

EnumTypeOfAddress

Enum Type Of Address

TypeOfAddress

None.

TypeOfAddressOptionSelected

Type of AddressCode

integer

None.

TypeOfAddress

Text Value Enum Type Of Address

string

None.

Address

Address

string

None.

PostalCode

Postal Code

string

None.

City

City

string

None.

Country

Country

string

None.

PostalBoxOffice

Postal Box Office

string

None.

Website

Website

string

None.

EnumIndustryCode

Enum Industry Code

IndustryCode

None.

IndustryCodeOptionSelected

Industry Code

integer

None.

IndustryCode

Text Value Enum Industrycode

string

None.

NumberCardAEP

Number of card AEP

string

None.

Contact

Primary Contact of Account

Contact

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "IntegrationKey": "sample string 1",
    "CAE3": "sample string 2",
    "Activity": "sample string 3",
    "EnumActivityCode": 261020000,
    "ActivityCodeOptionSelected": null,
    "Name": "sample string 4",
    "Email": "sample string 5",
    "CommercialName": "sample string 6",
    "EnumAccountCategoryCode": 1,
    "AccountCategoryCodeOptionSelected": 7,
    "AccountCategoryCode": "sample string 8",
    "VAT": "sample string 9",
    "Telephone": "sample string 10",
    "OtherTelephone": "sample string 11",
    "PrimaryContact": "sample string 12",
    "EnumTypeOfAddress": 1,
    "TypeOfAddressOptionSelected": 13,
    "TypeOfAddress": "sample string 14",
    "Address": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "Country": "sample string 18",
    "PostalBoxOffice": "sample string 19",
    "Website": "sample string 20",
    "EnumIndustryCode": 7,
    "IndustryCodeOptionSelected": 21,
    "IndustryCode": "sample string 22",
    "NumberCardAEP": "sample string 23",
    "Contact": {
      "IntegrationKey": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Telephone": "sample string 4",
      "Email": "sample string 5",
      "JobTitle": "sample string 6",
      "EnumType": 108640000
    }
  },
  {
    "IntegrationKey": "sample string 1",
    "CAE3": "sample string 2",
    "Activity": "sample string 3",
    "EnumActivityCode": 261020000,
    "ActivityCodeOptionSelected": null,
    "Name": "sample string 4",
    "Email": "sample string 5",
    "CommercialName": "sample string 6",
    "EnumAccountCategoryCode": 1,
    "AccountCategoryCodeOptionSelected": 7,
    "AccountCategoryCode": "sample string 8",
    "VAT": "sample string 9",
    "Telephone": "sample string 10",
    "OtherTelephone": "sample string 11",
    "PrimaryContact": "sample string 12",
    "EnumTypeOfAddress": 1,
    "TypeOfAddressOptionSelected": 13,
    "TypeOfAddress": "sample string 14",
    "Address": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "Country": "sample string 18",
    "PostalBoxOffice": "sample string 19",
    "Website": "sample string 20",
    "EnumIndustryCode": 7,
    "IndustryCodeOptionSelected": 21,
    "IndustryCode": "sample string 22",
    "NumberCardAEP": "sample string 23",
    "Contact": {
      "IntegrationKey": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Telephone": "sample string 4",
      "Email": "sample string 5",
      "JobTitle": "sample string 6",
      "EnumType": 108640000
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hydra.Exponor.Dynamics365.WS.Models">
  <Account>
    <AccountCategoryCode>sample string 8</AccountCategoryCode>
    <AccountCategoryCodeOptionSelected>7</AccountCategoryCodeOptionSelected>
    <Activity>sample string 3</Activity>
    <ActivityCodeOptionSelected xmlns:d3p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
    <Address>sample string 15</Address>
    <CAE3>sample string 2</CAE3>
    <City>sample string 17</City>
    <CommercialName>sample string 6</CommercialName>
    <Contact>
      <Email>sample string 5</Email>
      <EnumType>ContactoPreferencial</EnumType>
      <FirstName>sample string 2</FirstName>
      <IntegrationKey>sample string 1</IntegrationKey>
      <JobTitle>sample string 6</JobTitle>
      <LastName>sample string 3</LastName>
      <Telephone>sample string 4</Telephone>
    </Contact>
    <Country>sample string 18</Country>
    <Email>sample string 5</Email>
    <EnumAccountCategoryCode>SocioAEPPlus</EnumAccountCategoryCode>
    <EnumActivityCode>Produtor</EnumActivityCode>
    <EnumIndustryCode>Consultadoria</EnumIndustryCode>
    <EnumTypeOfAddress>FaturarPara</EnumTypeOfAddress>
    <IndustryCode>sample string 22</IndustryCode>
    <IndustryCodeOptionSelected>21</IndustryCodeOptionSelected>
    <IntegrationKey>sample string 1</IntegrationKey>
    <Name>sample string 4</Name>
    <NumberCardAEP>sample string 23</NumberCardAEP>
    <OtherTelephone>sample string 11</OtherTelephone>
    <PostalBoxOffice>sample string 19</PostalBoxOffice>
    <PostalCode>sample string 16</PostalCode>
    <PrimaryContact>sample string 12</PrimaryContact>
    <Telephone>sample string 10</Telephone>
    <TypeOfAddress>sample string 14</TypeOfAddress>
    <TypeOfAddressOptionSelected>13</TypeOfAddressOptionSelected>
    <VAT>sample string 9</VAT>
    <Website>sample string 20</Website>
  </Account>
  <Account>
    <AccountCategoryCode>sample string 8</AccountCategoryCode>
    <AccountCategoryCodeOptionSelected>7</AccountCategoryCodeOptionSelected>
    <Activity>sample string 3</Activity>
    <ActivityCodeOptionSelected xmlns:d3p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
    <Address>sample string 15</Address>
    <CAE3>sample string 2</CAE3>
    <City>sample string 17</City>
    <CommercialName>sample string 6</CommercialName>
    <Contact>
      <Email>sample string 5</Email>
      <EnumType>ContactoPreferencial</EnumType>
      <FirstName>sample string 2</FirstName>
      <IntegrationKey>sample string 1</IntegrationKey>
      <JobTitle>sample string 6</JobTitle>
      <LastName>sample string 3</LastName>
      <Telephone>sample string 4</Telephone>
    </Contact>
    <Country>sample string 18</Country>
    <Email>sample string 5</Email>
    <EnumAccountCategoryCode>SocioAEPPlus</EnumAccountCategoryCode>
    <EnumActivityCode>Produtor</EnumActivityCode>
    <EnumIndustryCode>Consultadoria</EnumIndustryCode>
    <EnumTypeOfAddress>FaturarPara</EnumTypeOfAddress>
    <IndustryCode>sample string 22</IndustryCode>
    <IndustryCodeOptionSelected>21</IndustryCodeOptionSelected>
    <IntegrationKey>sample string 1</IntegrationKey>
    <Name>sample string 4</Name>
    <NumberCardAEP>sample string 23</NumberCardAEP>
    <OtherTelephone>sample string 11</OtherTelephone>
    <PostalBoxOffice>sample string 19</PostalBoxOffice>
    <PostalCode>sample string 16</PostalCode>
    <PrimaryContact>sample string 12</PrimaryContact>
    <Telephone>sample string 10</Telephone>
    <TypeOfAddress>sample string 14</TypeOfAddress>
    <TypeOfAddressOptionSelected>13</TypeOfAddressOptionSelected>
    <VAT>sample string 9</VAT>
    <Website>sample string 20</Website>
  </Account>
</ArrayOfAccount>