Class: LockstepSdk::CompanyModel
- Inherits:
-
Object
- Object
- LockstepSdk::CompanyModel
- Defined in:
- lib/lockstep_sdk/models/company_model.rb
Overview
A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
See [Vendors, Customers, and Companies](developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
Instance Attribute Summary collapse
-
#address1 ⇒ String
Address info.
-
#address2 ⇒ String
Address info.
-
#address3 ⇒ String
Address info.
-
#ap_email_address ⇒ Email
AP (Accounts Payable) Email Address.
-
#app_enrollment_id ⇒ Uuid
The AppEnrollmentId of the application that imported this company record.
-
#ar_email_address ⇒ Email
AR (Accounts Receivable) Email Address.
-
#attachments ⇒ AttachmentModel
All attachments attached to this company.
-
#city ⇒ String
Address info.
-
#company_classification_code_def_id ⇒ Uuid
Identifier for classification of this company.
-
#company_classification_code_definition ⇒ CodeDefinitionModel
Classification code definition for this company.
-
#company_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#company_logo_url ⇒ String
The URL of this company's logo, if known.
-
#company_name ⇒ String
The short name of the company.
-
#company_status ⇒ String
The status of the company.
-
#company_type ⇒ String
This field indicates the type of company.
-
#contacts ⇒ ContactModel
All contacts attached to this company.
-
#corp_city ⇒ String
Corporate Address info.
-
#corp_country ⇒ String
Corporate Address info.
-
#corp_fax ⇒ String
Corporate fax number.
-
#corp_phone ⇒ String
Corporate phone number.
-
#corp_postal_code ⇒ String
Corporate Address info.
-
#corp_state ⇒ String
Corporate Address info.
-
#country ⇒ String
Address info.
-
#created ⇒ Date-time
The date this company was created.
-
#created_user_id ⇒ Uuid
The ID of the user who created this company.
-
#custom_field_definitions ⇒ CustomFieldDefinitionModel
All definitions attached to this company.
-
#custom_field_values ⇒ CustomFieldValueModel
All values attached to this company.
-
#default_currency_code ⇒ String
The default currency code used by this business entity.
-
#description ⇒ String
Description of the company.
-
#domain_name ⇒ String
For companies that use a custom domain name for their email system, this is the domain name used by this company.
-
#duns_number ⇒ String
Dun & Bradstreet Number.
-
#enterprise_id ⇒ Uuid
For convenience, this field indicates the top-level parent company.
-
#erp_key ⇒ String
The unique ID of this record as it was known in its originating financial system.
-
#fax_number ⇒ String
Fax number.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#invoices ⇒ Object
All invoices attached to this company.
-
#is_active ⇒ Boolean
This flag indicates whether the company is currently active.
-
#modified ⇒ Date-time
The date this company was last modified.
-
#modified_user_id ⇒ Uuid
The ID of the user who last modified this company.
-
#modified_user_name ⇒ String
The name of the user who last modified this company.
-
#notes ⇒ NoteModel
All notes attached to this company.
-
#parent_company_id ⇒ Uuid
If this business entity is part of an organization, this value is non-null and it is set to the `CompanyId` value of the parent company of this business entity.
-
#phone_number ⇒ String
Phone number.
-
#postal_code ⇒ String
Address info.
-
#primary_contact_id ⇒ Uuid
The Lockstep `ContactId` of the primary contact for this company.
-
#state_region ⇒ String
Address info.
-
#tax_id ⇒ String
Federal Tax ID.
-
#website ⇒ String
Website URL for this company.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ CompanyModel
constructor
Initialize the CompanyModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ CompanyModel
Initialize the CompanyModel using the provided prototype
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 30 def initialize(params = {}) @company_id = params.dig(:company_id) @company_name = params.dig(:company_name) @erp_key = params.dig(:erp_key) @company_type = params.dig(:company_type) @company_status = params.dig(:company_status) @parent_company_id = params.dig(:parent_company_id) @enterprise_id = params.dig(:enterprise_id) @group_key = params.dig(:group_key) @is_active = params.dig(:is_active) @default_currency_code = params.dig(:default_currency_code) @company_logo_url = params.dig(:company_logo_url) @primary_contact_id = params.dig(:primary_contact_id) @address1 = params.dig(:address1) @address2 = params.dig(:address2) @address3 = params.dig(:address3) @corp_city = params.dig(:corp_city) @corp_state = params.dig(:corp_state) @corp_postal_code = params.dig(:corp_postal_code) @corp_country = params.dig(:corp_country) @corp_phone = params.dig(:corp_phone) @corp_fax = params.dig(:corp_fax) @city = params.dig(:city) @state_region = params.dig(:state_region) @postal_code = params.dig(:postal_code) @country = params.dig(:country) @phone_number = params.dig(:phone_number) @fax_number = params.dig(:fax_number) @created = params.dig(:created) @created_user_id = params.dig(:created_user_id) @modified = params.dig(:modified) @modified_user_id = params.dig(:modified_user_id) @modified_user_name = params.dig(:modified_user_name) @tax_id = params.dig(:tax_id) @duns_number = params.dig(:duns_number) @ap_email_address = params.dig(:ap_email_address) @ar_email_address = params.dig(:ar_email_address) @domain_name = params.dig(:domain_name) @company_classification_code_def_id = params.dig(:company_classification_code_def_id) @description = params.dig(:description) @website = params.dig(:website) @app_enrollment_id = params.dig(:app_enrollment_id) @notes = params.dig(:notes) @attachments = params.dig(:attachments) @contacts = params.dig(:contacts) @invoices = params.dig(:invoices) @custom_field_definitions = params.dig(:custom_field_definitions) @custom_field_values = params.dig(:custom_field_values) @company_classification_code_definition = params.dig(:company_classification_code_definition) end |
Instance Attribute Details
#address1 ⇒ String
Returns Address info.
106 107 108 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 106 def address1 @address1 end |
#address2 ⇒ String
Returns Address info.
108 109 110 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 108 def address2 @address2 end |
#address3 ⇒ String
Returns Address info.
110 111 112 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 110 def address3 @address3 end |
#ap_email_address ⇒ Email
Returns AP (Accounts Payable) Email Address.
150 151 152 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 150 def ap_email_address @ap_email_address end |
#app_enrollment_id ⇒ Uuid
Returns The AppEnrollmentId of the application that imported this company record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record.
162 163 164 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 162 def app_enrollment_id @app_enrollment_id end |
#ar_email_address ⇒ Email
Returns AR (Accounts Receivable) Email Address.
152 153 154 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 152 def ar_email_address @ar_email_address end |
#attachments ⇒ AttachmentModel
Returns All attachments attached to this company. To retrieve this collection, specify `Attachments` in the “Include” parameter for your query.
166 167 168 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 166 def @attachments end |
#city ⇒ String
Returns Address info.
124 125 126 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 124 def city @city end |
#company_classification_code_def_id ⇒ Uuid
Returns Identifier for classification of this company.
156 157 158 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 156 def company_classification_code_def_id @company_classification_code_def_id end |
#company_classification_code_definition ⇒ CodeDefinitionModel
Returns Classification code definition for this company. To retrieve this collection, specify `Classification` in the “Include” parameter for your query.
176 177 178 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 176 def company_classification_code_definition @company_classification_code_definition end |
#company_id ⇒ Uuid
Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
82 83 84 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 82 def company_id @company_id end |
#company_logo_url ⇒ String
Returns The URL of this company's logo, if known.
102 103 104 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 102 def company_logo_url @company_logo_url end |
#company_name ⇒ String
Returns The short name of the company.
84 85 86 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 84 def company_name @company_name end |
#company_status ⇒ String
Returns The status of the company. Companies can be either `Active` or `Inactive`. When matched to a Lockstep corporate profile, this value will change to reflect that this record will be kept in sync with that company's identity.
90 91 92 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 90 def company_status @company_status end |
#company_type ⇒ String
Returns This field indicates the type of company. It can be one of a limited number of values: Company, Customer, Group, or Vendor. A company that represents both a customer and a vendor is identified as a CustomerVendor. * `Company` - This record represents a company that is part of the organization of the account holder. * `Customer` - This record represents a business entity that purchases things from the account holder. * `Group` - Only one record of type `GROUP` exists in each account. Contains your account profile. * `Vendor` - This record represents a business entity that sells things to the account holder. * `CustomerVendor` - Both a customer and a vendor.
88 89 90 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 88 def company_type @company_type end |
#contacts ⇒ ContactModel
Returns All contacts attached to this company. To retrieve this collection, specify `Contacts` in the “Include” parameter for your query.
168 169 170 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 168 def contacts @contacts end |
#corp_city ⇒ String
Returns Corporate Address info.
112 113 114 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 112 def corp_city @corp_city end |
#corp_country ⇒ String
Returns Corporate Address info.
118 119 120 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 118 def corp_country @corp_country end |
#corp_fax ⇒ String
Returns Corporate fax number.
122 123 124 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 122 def corp_fax @corp_fax end |
#corp_phone ⇒ String
Returns Corporate phone number.
120 121 122 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 120 def corp_phone @corp_phone end |
#corp_postal_code ⇒ String
Returns Corporate Address info.
116 117 118 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 116 def corp_postal_code @corp_postal_code end |
#corp_state ⇒ String
Returns Corporate Address info.
114 115 116 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 114 def corp_state @corp_state end |
#country ⇒ String
Returns Address info.
130 131 132 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 130 def country @country end |
#created ⇒ Date-time
Returns The date this company was created.
136 137 138 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 136 def created @created end |
#created_user_id ⇒ Uuid
Returns The ID of the user who created this company.
138 139 140 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 138 def created_user_id @created_user_id end |
#custom_field_definitions ⇒ CustomFieldDefinitionModel
Returns All definitions attached to this company. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.
172 173 174 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 172 def custom_field_definitions @custom_field_definitions end |
#custom_field_values ⇒ CustomFieldValueModel
Returns All values attached to this company. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.
174 175 176 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 174 def custom_field_values @custom_field_values end |
#default_currency_code ⇒ String
Returns The default currency code used by this business entity. This value can be overridden for invoices in a different currency code. For a list of defined currency codes, see [Query Currencies](developer.lockstep.io/reference/get_api-v1-definitions-currencies).
100 101 102 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 100 def default_currency_code @default_currency_code end |
#description ⇒ String
Returns Description of the company.
158 159 160 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 158 def description @description end |
#domain_name ⇒ String
Returns For companies that use a custom domain name for their email system, this is the domain name used by this company. If this value is known, new emails that come in from this domain will be connected to this company.
154 155 156 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 154 def domain_name @domain_name end |
#duns_number ⇒ String
Returns Dun & Bradstreet Number.
148 149 150 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 148 def duns_number @duns_number end |
#enterprise_id ⇒ Uuid
Returns For convenience, this field indicates the top-level parent company. This can be used to jump directly to the top parent in complex organizational hierarchies.
94 95 96 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 94 def enterprise_id @enterprise_id end |
#erp_key ⇒ String
Returns The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](developer.lockstep.io/docs/identity-columns).
86 87 88 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 86 def erp_key @erp_key end |
#fax_number ⇒ String
Returns Fax number.
134 135 136 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 134 def fax_number @fax_number end |
#group_key ⇒ Uuid
Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).
96 97 98 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 96 def group_key @group_key end |
#invoices ⇒ Object
Returns All invoices attached to this company. To retrieve this collection, specify `Invoices` in the “Include” parameter for your query. For more information on Invoices, see [InvoiceModel](developer.lockstep.io/reference/get_api-v1-invoices-id).
170 171 172 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 170 def invoices @invoices end |
#is_active ⇒ Boolean
Returns This flag indicates whether the company is currently active. An inactive company should be hidden from the user interface but will still be available for querying.
98 99 100 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 98 def is_active @is_active end |
#modified ⇒ Date-time
Returns The date this company was last modified.
140 141 142 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 140 def modified @modified end |
#modified_user_id ⇒ Uuid
Returns The ID of the user who last modified this company.
142 143 144 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 142 def modified_user_id @modified_user_id end |
#modified_user_name ⇒ String
Returns The name of the user who last modified this company.
144 145 146 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 144 def modified_user_name @modified_user_name end |
#notes ⇒ NoteModel
Returns All notes attached to this company. To retrieve this collection, specify `Notes` in the “Include” parameter for your query.
164 165 166 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 164 def notes @notes end |
#parent_company_id ⇒ Uuid
Returns If this business entity is part of an organization, this value is non-null and it is set to the `CompanyId` value of the parent company of this business entity. If this value is null, this business entity is a standalone.
92 93 94 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 92 def parent_company_id @parent_company_id end |
#phone_number ⇒ String
Returns Phone number.
132 133 134 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 132 def phone_number @phone_number end |
#postal_code ⇒ String
Returns Address info.
128 129 130 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 128 def postal_code @postal_code end |
#primary_contact_id ⇒ Uuid
Returns The Lockstep `ContactId` of the primary contact for this company.
104 105 106 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 104 def primary_contact_id @primary_contact_id end |
#state_region ⇒ String
Returns Address info.
126 127 128 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 126 def state_region @state_region end |
#tax_id ⇒ String
Returns Federal Tax ID.
146 147 148 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 146 def tax_id @tax_id end |
#website ⇒ String
Returns Website URL for this company.
160 161 162 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 160 def website @website end |
Instance Method Details
#as_json(options = {}) ⇒ object
Returns This object as a JSON key-value structure.
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 179 def as_json(={}) { 'companyId' => @company_id, 'companyName' => @company_name, 'erpKey' => @erp_key, 'companyType' => @company_type, 'companyStatus' => @company_status, 'parentCompanyId' => @parent_company_id, 'enterpriseId' => @enterprise_id, 'groupKey' => @group_key, 'isActive' => @is_active, 'defaultCurrencyCode' => @default_currency_code, 'companyLogoUrl' => @company_logo_url, 'primaryContactId' => @primary_contact_id, 'address1' => @address1, 'address2' => @address2, 'address3' => @address3, 'corpCity' => @corp_city, 'corpState' => @corp_state, 'corpPostalCode' => @corp_postal_code, 'corpCountry' => @corp_country, 'corpPhone' => @corp_phone, 'corpFax' => @corp_fax, 'city' => @city, 'stateRegion' => @state_region, 'postalCode' => @postal_code, 'country' => @country, 'phoneNumber' => @phone_number, 'faxNumber' => @fax_number, 'created' => @created, 'createdUserId' => @created_user_id, 'modified' => @modified, 'modifiedUserId' => @modified_user_id, 'modifiedUserName' => @modified_user_name, 'taxId' => @tax_id, 'dunsNumber' => @duns_number, 'apEmailAddress' => @ap_email_address, 'arEmailAddress' => @ar_email_address, 'domainName' => @domain_name, 'companyClassificationCodeDefId' => @company_classification_code_def_id, 'description' => @description, 'website' => @website, 'appEnrollmentId' => @app_enrollment_id, 'notes' => @notes, 'attachments' => @attachments, 'contacts' => @contacts, 'invoices' => @invoices, 'customFieldDefinitions' => @custom_field_definitions, 'customFieldValues' => @custom_field_values, 'companyClassificationCodeDefinition' => @company_classification_code_definition, } end |
#to_json(*options) ⇒ String
Returns This object converted to a JSON string.
233 234 235 |
# File 'lib/lockstep_sdk/models/company_model.rb', line 233 def to_json(*) "[#{as_json(*).to_json(*)}]" end |