List Business Establishments

Retrieve a list of business establishments from SmartHR.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to return your results: First 100 Records: Returns the first 100 matching records. Stream Records: Passes all matching user records from your parent flow to a helper flow. Adds a Streaming input section to the card where you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Field	Definition	Type	Required
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. This field appears when Stream Records is selected from the Result Set field. The input field on the Helper Card in the streaming helper flow must reference the key Record (type object) to obtain streamed records. To obtain state input values, reference the key State (type object) of the Record object.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the Record Limit field is set to 0, no records are returned. When the Record Limit field is set to greater than 0, records greater than 0 and up to the maximum number of records specified are returned. When the Record Limit field is empty, null or not selected, all records are streamed. Default value is 500000. Valid range is from 0 to 500000. This field appears when Stream Records is selected from the Result Set option.	Number	TRUE

Output

Field	Definition	Type
Result
Business Establishments		List of Objects
Business Establishment ID	Unique identifier for the business establishment.	Text
Health Insurance Type	Types of health insurance associations.	Text
Health Insurance Association Name	Name of health insurance association.	Text
Health Insurance Office Arrangement Symbol	Health insurance office arrangement symbol.	Text
Admin Name	Administrator Name.	Text
Social Insurance Registration Name	Social insurance registration name.	Text
Social Security Representative ID	Unique identifier for the social security representative.	Text
Social Insurance Registration Address	Social insurance registration address. Country Number (Text) - ISO 3166 numeric value for country Zip Code (Text) Prefecture (Text) - Administrative jurisdiction of Japan City (Text) - City name Street (Text) - Street name Building (Text) - Building name Literal Yomi (Text) - Phonetic name	Object
Social Insurance Telephone	Social insurance registration telephone number.	Text
Social Insurance Office Arrangement Symbol	Social insurance office arrangement symbol.	Text
Social Insurance Office Number	Social insurance office number.	Text
Labor Insurance Registration Name	Labor insurance registration name.	Text
Labor Insurance Representative ID	Unique identifier for the social insurance representative.	Text
Labor Insurance Registration Address	Labor insurance registration address. Country Number (Text) - ISO 3166 numeric value for country Zip Code (Text) Prefecture (Text) - Administrative jurisdiction of Japan City (Text) - City name Street (Text) - Street name Building (Text) - Building name Literal Yomi (Text) - Phonetic name	Object
Labor Insurance Telephone	Labor insurance registration telephone number.	Text
Labor Insurance Number	Labor insurance registration number.	Text
Employment Insurance Office Number	Employment insurance office number.	Text
Labor and Social Security Attorney	Labor and social security attorney. ID (Text) - unique identifier First Name (Text) - first name Last Name (Text) - family name First Name Yomi (Text) - phonetic first name Last Name Yomi (Text) - phonetic family name Title (Text)- title Prefectural Association (Text) - administrative jurisdiction of Japan Agent Distinction (Text) - agent type Telephone Number (Text) - telephone number Address (Object) - address	Object
Jurisdiction Tax Office	Jurisdiction tax office.	Text
Salary Payer Address	Salary payer address. Country Number (Text) - ISO 3166 numeric value for country Zip Code (Text) Prefecture (Text) - Administrative jurisdiction of Japan City (Text) - City name Street (Text) - Street name Building (Text) - Building name Literal Yomi (Text) - Phonetic name	Object
Created At	Date created.	Date & Time
Updated At	Last updated.	Date & Time
Result
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Records from the Result Set option.	Number

List Business Establishments

Options

Input

Output

Related topics