Skip to main content
All CollectionsAPI
Branch Fields
Branch Fields

Meaning and usage of individual fields in Branch API

Peter Virly avatar
Written by Peter Virly
Updated over 3 years ago

SN

FIELD NAME

DESCRIPTION

1

id*

Unique ID

2

name

Unique name identifies the Branch

3

street

Street address

4

city

City

5

state

State (see table for reference )

6

country

2 Letter Country Code (see table for reference)

7

zipcode

zipcode

8

tin

Tax identification number

9

site_type*

Blank if regular branch, "head_office" if branch is head office

10

subscription_type*

0 - Free, 1 - Trial, 2 - Premium

11

utc_created_at*

Created date and time

12

utc_updated_at*

Last updated date and time

13

status*

D if deleted, otherwise NULL

Note:

  1. Fields mark with * are read only.

  2. Fields returned may not be in above order.

Did this answer your question?