ApexERPHost

<back to all web services

GetECommerceCompanyInfo

Requires Authentication
The following routes are available for this service:
GET/eCommerce/CompanyInfo
GetECommerceCompanyInfo Parameters:
NameParameterData TypeRequiredDescription
RsCodequerystringNo
IncludeListsquerybool?No
GetECommerceCompanyInfoResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CompanyInfoformCompanyNo
ClientIdformint?No
BranchIdformint?No
ClientBranchesformList<CompanyBranch>No
ECommerceBranchesformList<CompanyBranch>No
Company Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
NameEnformstringNo
IsOwnformboolNo
IsPartnerformboolNo
IsCustomerformboolNo
IsSupplierformboolNo
AddressIdformintNo
PhoneformstringNo
FaxformstringNo
EmailformstringNo
WebformstringNo
NoteformstringNo
SpendformboolNo
AddressformAddressNo
VatTypeformintNo
Address Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CityIdformstringNo
BlockIdformintNo
PostalCodeformstringNo
FullAddressformstringNo
LocationformGPSLocationNo
GPSLocation Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
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
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 .csv suffix or ?format=csv

HTTP + CSV

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

GET /eCommerce/CompanyInfo HTTP/1.1 
Host: 10.10.0.107 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"CompanyInfo":{"Id":0,"Code":"String","Name":"String","NameEn":"String","IsOwn":false,"IsPartner":false,"IsCustomer":false,"IsSupplier":false,"AddressId":0,"Phone":"String","Fax":"String","Email":"String","Web":"String","Note":"String","Spend":false,"Address":{"Id":0,"CityId":"String","BlockId":0,"PostalCode":"String","FullAddress":"String","Location":{"Latitude":0,"Longitude":0}},"VatType":0},"ClientId":0,"BranchId":0,"ClientBranches":[{"Id":0,"CompanyId":0,"ParentId":0,"Name":"String","NameEn":"String","AddressId":0,"Spend":false,"Address":{"Id":0,"CityId":"String","BlockId":0,"PostalCode":"String","FullAddress":"String","Location":{"Latitude":0,"Longitude":0}},"Code":"String","BranchNum":0,"GroupId":0,"Phone":"String","Note":"String","Company":{"Id":0,"Code":"String","Name":"String","NameEn":"String","IsOwn":false,"IsPartner":false,"IsCustomer":false,"IsSupplier":false,"AddressId":0,"Phone":"String","Fax":"String","Email":"String","Web":"String","Note":"String","Spend":false,"Address":{"Id":0,"CityId":"String","BlockId":0,"PostalCode":"String","FullAddress":"String","Location":{"Latitude":0,"Longitude":0}},"VatType":0},"CustomerParameters":{"BranchId":0,"CustomerType":0,"ProductType":0,"CustomerCategory":0,"CreditDays":0,"CreditLimit":0,"OverdueLimit":0},"BranchProdSpendListType":0,"SupplierParams":{"BranchId":0,"ProdSupplyDays":0,"MinOrderAmmount":0,"OrderGenIntervalDays":0,"Importer":false,"MinOrderQuantity":0,"AutoOrder":false},"BankAccounts":[{"Id":0,"BranchId":0,"BankId":"String","Account":"String","Note":"String","IsDefault":false,"IntermediaryBankId":"String","IntermediaryAccount":"String","CurrencyId":"String"}],"BranchAccounts":[{"Id":0,"BranchId":0,"AccType":0,"Account":"String"}]}],"ECommerceBranches":[{"Id":0,"CompanyId":0,"ParentId":0,"Name":"String","NameEn":"String","AddressId":0,"Spend":false,"Address":{"Id":0,"CityId":"String","BlockId":0,"PostalCode":"String","FullAddress":"String","Location":{"Latitude":0,"Longitude":0}},"Code":"String","BranchNum":0,"GroupId":0,"Phone":"String","Note":"String","Company":{"Id":0,"Code":"String","Name":"String","NameEn":"String","IsOwn":false,"IsPartner":false,"IsCustomer":false,"IsSupplier":false,"AddressId":0,"Phone":"String","Fax":"String","Email":"String","Web":"String","Note":"String","Spend":false,"Address":{"Id":0,"CityId":"String","BlockId":0,"PostalCode":"String","FullAddress":"String","Location":{"Latitude":0,"Longitude":0}},"VatType":0},"CustomerParameters":{"BranchId":0,"CustomerType":0,"ProductType":0,"CustomerCategory":0,"CreditDays":0,"CreditLimit":0,"OverdueLimit":0},"BranchProdSpendListType":0,"SupplierParams":{"BranchId":0,"ProdSupplyDays":0,"MinOrderAmmount":0,"OrderGenIntervalDays":0,"Importer":false,"MinOrderQuantity":0,"AutoOrder":false},"BankAccounts":[{"Id":0,"BranchId":0,"BankId":"String","Account":"String","Note":"String","IsDefault":false,"IntermediaryBankId":"String","IntermediaryAccount":"String","CurrencyId":"String"}],"BranchAccounts":[{"Id":0,"BranchId":0,"AccType":0,"Account":"String"}]}]}