GET GetCompanies

Obtener todas las compañías perteneciente al ERP.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Compañías pertenecientes al ERP

Collection of Company

Name	Description	Type	Additional information
documentTypeCode	Código de tipo de identificación de la compañia	string	Required String length: inclusive between 0 and 10
documentNumber	Número de documento de la compañía	string	Required String length: inclusive between 0 and 20
documentNumberCheck	Dígito de verificación del documento de la compañía	string	String length: inclusive between 0 and 2
name	Nombre de la compañía	string	Required String length: inclusive between 0 and 500
tradeName	Razón social de la compañía	string	String length: inclusive between 0 and 500
personTypeCode	Código que indica el tipo de persona	integer	Required
regimenTypeCode	Código tipo de regimen	string	Required String length: inclusive between 0 and 10
telephone	Teléfono de la compañía	string	String length: inclusive between 0 and 20
cellPhoneNumber	Móvil de la compañía	string	Optional
sendDocumentsToAcquirer	Este flag indica si se debe generar el pdf	boolean	Optional
sendAttachmentsToAcquirer	Este flag indica si se deben enviar los adjuntos en la notificación al adquiriente	boolean	Optional
tributaryDetail	Código del detalle tributario.	string	Optional
notificationCopyMail	Correo electrónico del comercio al cual generar copia de la notificación de documentos generados	string	String length: inclusive between 0 and 200
receptionMail	Correo electrónico de recepción de documentos del comercio	string	String length: inclusive between 0 and 200
userCredentials	Credenciales del usuario a crear por defecto	UserCredentials	Required
legalRepresentative	Datos del representante legal de la compañía	LegalRepresentative	Required
taxResponsibilities	Responsabilidades fiscales de la compañía	Collection of TaxResponsibility	Optional
economicActivities	Actividades económicas de la compañía	Collection of EconomicActivity	Optional
fiscalLocation	Registros mercantiles de la compañia, esto es opcional sin embargo genera notificación por parte de la DIAN	Location	Required
physicalLocation	Localizaciones fisicas	Collection of Location	Required
merchantRegisters	Registros mercantiles	Collection of MerchantRegister	Optional

Response Formats

application/json, text/json

Sample:

[
  {
    "documentTypeCode": "sample string 1",
    "documentNumber": "sample string 2",
    "documentNumberCheck": "sample string 3",
    "name": "sample string 4",
    "tradeName": "sample string 5",
    "personTypeCode": 6,
    "regimenTypeCode": "sample string 7",
    "telephone": "sample string 8",
    "cellPhoneNumber": "sample string 9",
    "sendDocumentsToAcquirer": true,
    "sendAttachmentsToAcquirer": true,
    "tributaryDetail": "sample string 10",
    "notificationCopyMail": "sample string 11",
    "receptionMail": "sample string 12",
    "userCredentials": {
      "email": "sample string 1",
      "password": "sample string 2"
    },
    "legalRepresentative": {
      "documentTypeCode": 1,
      "documentNumber": "sample string 1",
      "telephone": "sample string 2",
      "fullName": "sample string 3",
      "email": "sample string 4"
    },
    "taxResponsibilities": [
      {
        "code": "sample string 1",
        "name": "sample string 2"
      },
      {
        "code": "sample string 1",
        "name": "sample string 2"
      }
    ],
    "economicActivities": [
      {
        "code": "sample string 1",
        "name": "sample string 2"
      },
      {
        "code": "sample string 1",
        "name": "sample string 2"
      }
    ],
    "fiscalLocation": {
      "countryCode": "sample string 1",
      "state": "sample string 2",
      "city": "sample string 3",
      "postalZone": "sample string 4",
      "address": "sample string 5"
    },
    "physicalLocation": [
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      },
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      }
    ],
    "merchantRegisters": [
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      },
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      }
    ]
  },
  {
    "documentTypeCode": "sample string 1",
    "documentNumber": "sample string 2",
    "documentNumberCheck": "sample string 3",
    "name": "sample string 4",
    "tradeName": "sample string 5",
    "personTypeCode": 6,
    "regimenTypeCode": "sample string 7",
    "telephone": "sample string 8",
    "cellPhoneNumber": "sample string 9",
    "sendDocumentsToAcquirer": true,
    "sendAttachmentsToAcquirer": true,
    "tributaryDetail": "sample string 10",
    "notificationCopyMail": "sample string 11",
    "receptionMail": "sample string 12",
    "userCredentials": {
      "email": "sample string 1",
      "password": "sample string 2"
    },
    "legalRepresentative": {
      "documentTypeCode": 1,
      "documentNumber": "sample string 1",
      "telephone": "sample string 2",
      "fullName": "sample string 3",
      "email": "sample string 4"
    },
    "taxResponsibilities": [
      {
        "code": "sample string 1",
        "name": "sample string 2"
      },
      {
        "code": "sample string 1",
        "name": "sample string 2"
      }
    ],
    "economicActivities": [
      {
        "code": "sample string 1",
        "name": "sample string 2"
      },
      {
        "code": "sample string 1",
        "name": "sample string 2"
      }
    ],
    "fiscalLocation": {
      "countryCode": "sample string 1",
      "state": "sample string 2",
      "city": "sample string 3",
      "postalZone": "sample string 4",
      "address": "sample string 5"
    },
    "physicalLocation": [
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      },
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      }
    ],
    "merchantRegisters": [
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      },
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCompany xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">
  <Company>
    <cellPhoneNumber>sample string 9</cellPhoneNumber>
    <documentNumber>sample string 2</documentNumber>
    <documentNumberCheck>sample string 3</documentNumberCheck>
    <documentTypeCode>sample string 1</documentTypeCode>
    <economicActivities>
      <EconomicActivity>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </EconomicActivity>
      <EconomicActivity>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </EconomicActivity>
    </economicActivities>
    <fiscalLocation>
      <address>sample string 5</address>
      <city>sample string 3</city>
      <countryCode>sample string 1</countryCode>
      <postalZone>sample string 4</postalZone>
      <state>sample string 2</state>
    </fiscalLocation>
    <legalRepresentative>
      <documentNumber>sample string 1</documentNumber>
      <documentTypeCode>1</documentTypeCode>
      <email>sample string 4</email>
      <fullName>sample string 3</fullName>
      <telephone>sample string 2</telephone>
    </legalRepresentative>
    <merchantRegisters>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
    </merchantRegisters>
    <name>sample string 4</name>
    <notificationCopyMail>sample string 11</notificationCopyMail>
    <personTypeCode>6</personTypeCode>
    <physicalLocation>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
    </physicalLocation>
    <receptionMail>sample string 12</receptionMail>
    <regimenTypeCode>sample string 7</regimenTypeCode>
    <sendAttachmentsToAcquirer>true</sendAttachmentsToAcquirer>
    <sendDocumentsToAcquirer>true</sendDocumentsToAcquirer>
    <taxResponsibilities>
      <TaxResponsibility>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </TaxResponsibility>
      <TaxResponsibility>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </TaxResponsibility>
    </taxResponsibilities>
    <telephone>sample string 8</telephone>
    <tradeName>sample string 5</tradeName>
    <tributaryDetail>sample string 10</tributaryDetail>
    <userCredentials>
      <email>sample string 1</email>
      <password>sample string 2</password>
    </userCredentials>
  </Company>
  <Company>
    <cellPhoneNumber>sample string 9</cellPhoneNumber>
    <documentNumber>sample string 2</documentNumber>
    <documentNumberCheck>sample string 3</documentNumberCheck>
    <documentTypeCode>sample string 1</documentTypeCode>
    <economicActivities>
      <EconomicActivity>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </EconomicActivity>
      <EconomicActivity>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </EconomicActivity>
    </economicActivities>
    <fiscalLocation>
      <address>sample string 5</address>
      <city>sample string 3</city>
      <countryCode>sample string 1</countryCode>
      <postalZone>sample string 4</postalZone>
      <state>sample string 2</state>
    </fiscalLocation>
    <legalRepresentative>
      <documentNumber>sample string 1</documentNumber>
      <documentTypeCode>1</documentTypeCode>
      <email>sample string 4</email>
      <fullName>sample string 3</fullName>
      <telephone>sample string 2</telephone>
    </legalRepresentative>
    <merchantRegisters>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
    </merchantRegisters>
    <name>sample string 4</name>
    <notificationCopyMail>sample string 11</notificationCopyMail>
    <personTypeCode>6</personTypeCode>
    <physicalLocation>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
    </physicalLocation>
    <receptionMail>sample string 12</receptionMail>
    <regimenTypeCode>sample string 7</regimenTypeCode>
    <sendAttachmentsToAcquirer>true</sendAttachmentsToAcquirer>
    <sendDocumentsToAcquirer>true</sendDocumentsToAcquirer>
    <taxResponsibilities>
      <TaxResponsibility>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </TaxResponsibility>
      <TaxResponsibility>
        <code>sample string 1</code>
        <name>sample string 2</name>
      </TaxResponsibility>
    </taxResponsibilities>
    <telephone>sample string 8</telephone>
    <tradeName>sample string 5</tradeName>
    <tributaryDetail>sample string 10</tributaryDetail>
    <userCredentials>
      <email>sample string 1</email>
      <password>sample string 2</password>
    </userCredentials>
  </Company>
</ArrayOfCompany>