Class: LockstepSdk::CompanyModel

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ CompanyModel

Initialize the CompanyModel using the provided prototype



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
80
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 31

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.

Returns:

  • (String) —

    Address info



132
133
134
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 132

def address1
  @address1
end

#address2 ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



136
137
138
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 136

def address2
  @address2
end

#address3 ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



140
141
142
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 140

def address3
  @address3
end

#ap_email_address ⇒ Email

Returns AP (Accounts Payable) Email Address.

Returns:

  • (Email) —

    AP (Accounts Payable) Email Address



220
221
222
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 220

def ap_email_address
  @ap_email_address
end

#app_enrollment_id ⇒ Uuid

Returns The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.

Returns:

  • (Uuid) —

    The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.



244
245
246
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 244

def app_enrollment_id
  @app_enrollment_id
end

#ar_email_address ⇒ Email

Returns AR (Accounts Receivable) Email Address.

Returns:

  • (Email) —

    AR (Accounts Receivable) Email Address



224
225
226
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 224

def ar_email_address
  @ar_email_address
end

#attachments ⇒ AttachmentModel

Returns A collection of attachments linked to this record. To retrieve this collection, specify ‘Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



252
253
254
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 252

def attachments
  @attachments
end

#city ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



168
169
170
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 168

def city
  @city
end

#company_classification_code_def_id ⇒ Uuid

Returns Identifier for classification of this company.

Returns:

  • (Uuid) —

    Identifier for classification of this company.



232
233
234
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 232

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.

Returns:

  • (CodeDefinitionModel) —

    Classification code definition for this company. To retrieve this collection, specify ‘Classification` in the “Include” parameter for your query.



272
273
274
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 272

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`.

Returns:

  • (Uuid) —

    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`.



84
85
86
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 84

def company_id
  @company_id
end

#company_logo_url ⇒ String

Returns The URL of this company’s logo, if known.

Returns:

  • (String) —

    The URL of this company’s logo, if known.



124
125
126
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 124

def company_logo_url
  @company_logo_url
end

#company_name ⇒ String

Returns The short name of the company.

Returns:

  • (String) —

    The short name of the company.



88
89
90
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 88

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.

Returns:

  • (String) —

    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.



100
101
102
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 100

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, Vendor, or Third Party. 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. * `Third Party` - This record represents a business entity that is neither a customer nor vendor. * `CustomerVendor` - Both a customer and a vendor.

Returns:

  • (String) —

    This field indicates the type of company. It can be one of a limited number of values: Company, Customer, Group, Vendor, or Third Party. 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. * `Third Party` - This record represents a business entity that is neither a customer nor vendor. * `CustomerVendor` - Both a customer and a vendor.



96
97
98
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 96

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.

Returns:

  • (ContactModel) —

    All contacts attached to this company. To retrieve this collection, specify ‘Contacts` in the “Include” parameter for your query.



256
257
258
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 256

def contacts
  @contacts
end

#corp_city ⇒ String

Returns Corporate Address info.

Returns:

  • (String) —

    Corporate Address info



144
145
146
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 144

def corp_city
  @corp_city
end

#corp_country ⇒ String

Returns Corporate Address info.

Returns:

  • (String) —

    Corporate Address info



156
157
158
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 156

def corp_country
  @corp_country
end

#corp_fax ⇒ String

Returns Corporate fax number.

Returns:

  • (String) —

    Corporate fax number



164
165
166
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 164

def corp_fax
  @corp_fax
end

#corp_phone ⇒ String

Returns Corporate phone number.

Returns:

  • (String) —

    Corporate phone number



160
161
162
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 160

def corp_phone
  @corp_phone
end

#corp_postal_code ⇒ String

Returns Corporate Address info.

Returns:

  • (String) —

    Corporate Address info



152
153
154
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 152

def corp_postal_code
  @corp_postal_code
end

#corp_state ⇒ String

Returns Corporate Address info.

Returns:

  • (String) —

    Corporate Address info



148
149
150
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 148

def corp_state
  @corp_state
end

#country ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



180
181
182
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 180

def country
  @country
end

#created ⇒ Date-time

Returns The date this company was created.

Returns:

  • (Date-time) —

    The date this company was created



192
193
194
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 192

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created this company.

Returns:

  • (Uuid) —

    The ID of the user who created this company



196
197
198
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 196

def created_user_id
  @created_user_id
end

#custom_field_definitions ⇒ CustomFieldDefinitionModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



264
265
266
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 264

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ CustomFieldValueModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



268
269
270
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 268

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).

Returns:



120
121
122
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 120

def default_currency_code
  @default_currency_code
end

#description ⇒ String

Returns Description of the company.

Returns:

  • (String) —

    Description of the company.



236
237
238
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 236

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.

Returns:

  • (String) —

    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.



228
229
230
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 228

def domain_name
  @domain_name
end

#duns_number ⇒ String

Returns Dun & Bradstreet Number.

Returns:

  • (String) —

    Dun & Bradstreet Number



216
217
218
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 216

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.

Returns:

  • (Uuid) —

    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.



108
109
110
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 108

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).

Returns:

  • (String) —

    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).



92
93
94
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 92

def erp_key
  @erp_key
end

#fax_number ⇒ String

Returns Fax number.

Returns:

  • (String) —

    Fax number



188
189
190
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 188

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).

Returns:

  • (Uuid) —

    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).



112
113
114
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 112

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).

Returns:



260
261
262
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 260

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.

Returns:

  • (Boolean) —

    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.



116
117
118
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 116

def is_active
  @is_active
end

#modified ⇒ Date-time

Returns The date this company was last modified.

Returns:

  • (Date-time) —

    The date this company was last modified



200
201
202
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 200

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified this company.

Returns:

  • (Uuid) —

    The ID of the user who last modified this company



204
205
206
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 204

def modified_user_id
  @modified_user_id
end

#modified_user_name ⇒ String

Returns The name of the user who last modified this company.

Returns:

  • (String) —

    The name of the user who last modified this company



208
209
210
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 208

def modified_user_name
  @modified_user_name
end

#notes ⇒ NoteModel

Returns A collection of notes linked to this record. To retrieve this collection, specify ‘Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Company` and the `ObjectKey` set to the `CompanyId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



248
249
250
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 248

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.

Returns:

  • (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. If this value is null, this business entity is a standalone.



104
105
106
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 104

def parent_company_id
  @parent_company_id
end

#phone_number ⇒ String

Returns Phone number.

Returns:

  • (String) —

    Phone number



184
185
186
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 184

def phone_number
  @phone_number
end

#postal_code ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



176
177
178
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 176

def postal_code
  @postal_code
end

#primary_contact_id ⇒ Uuid

Returns The Lockstep ‘ContactId` of the primary contact for this company.

Returns:

  • (Uuid) —

    The Lockstep ‘ContactId` of the primary contact for this company.



128
129
130
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 128

def primary_contact_id
  @primary_contact_id
end

#state_region ⇒ String

Returns Address info.

Returns:

  • (String) —

    Address info



172
173
174
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 172

def state_region
  @state_region
end

#tax_id ⇒ String

Returns Federal Tax ID.

Returns:

  • (String) —

    Federal Tax ID



212
213
214
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 212

def tax_id
  @tax_id
end

#website ⇒ String

Returns Website URL for this company.

Returns:

  • (String) —

    Website URL for this company.



240
241
242
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 240

def website
  @website
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 276

def as_json(options={})
    {
        '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.

Returns:

  • (String) —

    This object converted to a JSON string



331
332
333
 
# File 'lib/lockstep_sdk/models/company_model.rb', line 331

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end