ApexERPHost

<back to all web services

GetCompanyBranchWithCompany

Requires Authentication
The following routes are available for this service:
GET/Crm/Company/BranchWithCompany
GetCompanyBranchWithCompany Parameters:
NameParameterData TypeRequiredDescription
BranchIdqueryintNo
GetCompanyBranchWithCompanyResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformCompanyBranchNo
CompanyBranch Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformintNo
ParentIdformint?No
NameformstringNo
NameEnformstringNo
AddressIdformint?No
SpendformboolNo
AddressformAddressNo
CodeformstringNo
BranchNumformint?No
GroupIdformint?No
PhoneformstringNo
NoteformstringNo
CompanyformCompanyNo
CustomerParametersformCustomerParamsNo
BranchProdSpendListTypeformint?No
SupplierParamsformSupplierParamsNo
BankAccountsformList<CompanyBankAccount>No
BranchAccountsformList<CompanyBranchAccount>No
Address Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CityIdformstringNo
BlockIdformintNo
PostalCodeformstringNo
FullAddressformstringNo
LocationformGPSLocationNo
GPSLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
Company Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
NameEnformstringNo
IsOwnformboolNo
IsPartnerformboolNo
IsCustomerformboolNo
IsSupplierformboolNo
AddressIdformintNo
PhoneformstringNo
FaxformstringNo
EmailformstringNo
WebformstringNo
NoteformstringNo
SpendformboolNo
AddressformAddressNo
VatTypeformintNo
CustomerParams Parameters:
NameParameterData TypeRequiredDescription
BranchIdformintNo
CustomerTypeformint?No
ProductTypeformint?No
CustomerCategoryformint?No
CreditDaysformint?No
CreditLimitformdouble?No
OverdueLimitformdouble?No
SupplierParams Parameters:
NameParameterData TypeRequiredDescription
BranchIdformintNo
ProdSupplyDaysformint?No
MinOrderAmmountformdecimal?No
OrderGenIntervalDaysformint?No
ImporterformboolNo
MinOrderQuantityformdecimal?No
AutoOrderformboolNo
CompanyBankAccount Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BranchIdformintNo
BankIdformstringNo
AccountformstringNo
NoteformstringNo
IsDefaultformboolNo
IntermediaryBankIdformstringNo
IntermediaryAccountformstringNo
CurrencyIdformstringNo
CompanyBranchAccount Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BranchIdformint?No
AccTypeformintNo
AccountformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Crm/Company/BranchWithCompany HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCompanyBranchWithCompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <Id>0</Id>
    <CompanyId>0</CompanyId>
    <ParentId>0</ParentId>
    <Name>String</Name>
    <NameEn>String</NameEn>
    <AddressId>0</AddressId>
    <Spend>false</Spend>
    <Address>
      <Id>0</Id>
      <CityId>String</CityId>
      <BlockId>0</BlockId>
      <PostalCode>String</PostalCode>
      <FullAddress>String</FullAddress>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
      </Location>
    </Address>
    <Code>String</Code>
    <BranchNum>0</BranchNum>
    <GroupId>0</GroupId>
    <Phone>String</Phone>
    <Note>String</Note>
    <Company>
      <Id>0</Id>
      <Code>String</Code>
      <Name>String</Name>
      <NameEn>String</NameEn>
      <IsOwn>false</IsOwn>
      <IsPartner>false</IsPartner>
      <IsCustomer>false</IsCustomer>
      <IsSupplier>false</IsSupplier>
      <AddressId>0</AddressId>
      <Phone>String</Phone>
      <Fax>String</Fax>
      <Email>String</Email>
      <Web>String</Web>
      <Note>String</Note>
      <Spend>false</Spend>
      <Address>
        <Id>0</Id>
        <CityId>String</CityId>
        <BlockId>0</BlockId>
        <PostalCode>String</PostalCode>
        <FullAddress>String</FullAddress>
        <Location xmlns:d5p1="http://schemas.datacontract.org/2004/07/Apex.Services.Common">
          <d5p1:Latitude>0</d5p1:Latitude>
          <d5p1:Longitude>0</d5p1:Longitude>
        </Location>
      </Address>
      <VatType>0</VatType>
    </Company>
    <CustomerParameters>
      <BranchId>0</BranchId>
      <CustomerType>0</CustomerType>
      <ProductType>0</ProductType>
      <CustomerCategory>0</CustomerCategory>
      <CreditDays>0</CreditDays>
      <CreditLimit>0</CreditLimit>
      <OverdueLimit>0</OverdueLimit>
    </CustomerParameters>
    <BranchProdSpendListType>0</BranchProdSpendListType>
    <SupplierParams>
      <BranchId>0</BranchId>
      <ProdSupplyDays>0</ProdSupplyDays>
      <MinOrderAmmount>0</MinOrderAmmount>
      <OrderGenIntervalDays>0</OrderGenIntervalDays>
      <Importer>false</Importer>
      <MinOrderQuantity>0</MinOrderQuantity>
      <AutoOrder>false</AutoOrder>
    </SupplierParams>
    <BankAccounts>
      <CompanyBankAccount>
        <Id>0</Id>
        <BranchId>0</BranchId>
        <BankId>String</BankId>
        <Account>String</Account>
        <Note>String</Note>
        <IsDefault>false</IsDefault>
        <IntermediaryBankId>String</IntermediaryBankId>
        <IntermediaryAccount>String</IntermediaryAccount>
        <CurrencyId>String</CurrencyId>
      </CompanyBankAccount>
    </BankAccounts>
    <BranchAccounts>
      <CompanyBranchAccount>
        <Id>0</Id>
        <BranchId>0</BranchId>
        <AccType>0</AccType>
        <Account>String</Account>
      </CompanyBranchAccount>
    </BranchAccounts>
  </Result>
</GetCompanyBranchWithCompanyResponse>