ApexERPHost

GetCompanyBranchesByStatus

The following routes are available for this service:
GET	/Crm/Company/Branch/GetCompanyBranchesByStatus/{StatusId}
GET	/Crm/Company/Branch/GetCompanyBranchesByStatus

**GetCompanyBranchesByStatus** Parameters:
Name	Parameter	Data Type	Required
StatusId	path	int	No
WithBankAccounts	query	bool	No
WithBranchAccounts	query	bool	No
OnlyHeadBranches	query	bool	No
OnlyAllowed	query	bool?	No

**GetCompanyBranchesByStatusResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Result	form	List<CompanyBranch>	No

**CompanyBranch** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CompanyId	form	int	No
ParentId	form	int?	No
Name	form	string	No
NameEn	form	string	No
AddressId	form	int?	No
Spend	form	bool	No
Address	form	Address	No
Code	form	string	No
BranchNum	form	int?	No
GroupId	form	int?	No
Phone	form	string	No
Note	form	string	No
Company	form	Company	No
CustomerParameters	form	CustomerParams	No
BranchProdSpendListType	form	int?	No
SupplierParams	form	SupplierParams	No
BankAccounts	form	List<CompanyBankAccount>	No
BranchAccounts	form	List<CompanyBranchAccount>	No

**Address** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CityId	form	string	No
BlockId	form	int	No
PostalCode	form	string	No
FullAddress	form	string	No
Location	form	GPSLocation	No

**GPSLocation** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	form	double	No
Longitude	form	double	No

**Company** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
Name	form	string	No
NameEn	form	string	No
IsOwn	form	bool	No
IsPartner	form	bool	No
IsCustomer	form	bool	No
IsSupplier	form	bool	No
AddressId	form	int	No
Phone	form	string	No
Fax	form	string	No
Email	form	string	No
Web	form	string	No
Note	form	string	No
Spend	form	bool	No
Address	form	Address	No
VatType	form	int	No

**CustomerParams** Parameters:
Name	Parameter	Data Type	Required
BranchId	form	int	No
CustomerType	form	int?	No
ProductType	form	int?	No
CustomerCategory	form	int?	No
CreditDays	form	int?	No
CreditLimit	form	double?	No
OverdueLimit	form	double?	No

**SupplierParams** Parameters:
Name	Parameter	Data Type	Required
BranchId	form	int	No
ProdSupplyDays	form	int?	No
MinOrderAmmount	form	decimal?	No
OrderGenIntervalDays	form	int?	No
Importer	form	bool	No
MinOrderQuantity	form	decimal?	No
AutoOrder	form	bool	No

**CompanyBankAccount** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
BranchId	form	int	No
BankId	form	string	No
Account	form	string	No
Note	form	string	No
IsDefault	form	bool	No
IntermediaryBankId	form	string	No
IntermediaryAccount	form	string	No
CurrencyId	form	string	No

**CompanyBranchAccount** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
BranchId	form	int?	No
AccType	form	int	No
Account	form	string	No

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

HTTP + JSV

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

GET /Crm/Company/Branch/GetCompanyBranchesByStatus/{StatusId} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			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
				}
			]
		}
	]
}