Class: LockstepSdk::AccountingProfileRequest
- Inherits:
-
Object
- Object
- LockstepSdk::AccountingProfileRequest
- Defined in:
- lib/lockstep_sdk/models/accounting_profile_request.rb
Overview
An Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
Instance Attribute Summary collapse
-
#accounting_profile_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#address1 ⇒ String
The first line of the address.
-
#address2 ⇒ String
The second line of the address.
-
#address3 ⇒ String
The third line of the address.
-
#attachments ⇒ AttachmentModel
A collection of attachments linked to this record.
-
#city ⇒ String
The city of the address.
-
#company_id ⇒ Uuid
The ID of the company profile to which this accounting profile belongs.
-
#country ⇒ String
The two character country code of the address.
-
#created ⇒ Date-time
The date on which this record was created.
-
#created_user_id ⇒ Uuid
The ID of the user who created this accounting profile.
-
#custom_field_definitions ⇒ CustomFieldDefinitionModel
A collection of custom fields linked to this record.
-
#custom_field_values ⇒ CustomFieldValueModel
A collection of custom fields linked to this record.
-
#email_address ⇒ Email
The email address associated with the accounting profile.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#modified ⇒ Date-time
The date on which this record was last modified.
-
#modified_user_id ⇒ Uuid
The ID of the user who last modified this accounting profile.
-
#name ⇒ String
The name of the accounting profile.
-
#notes ⇒ NoteModel
A collection of notes linked to this record.
-
#phone ⇒ String
The phone number associated with the accounting profile.
-
#postal_code ⇒ String
The postal/zip code of the address.
-
#primary_contact_id ⇒ Uuid
The ID of the primary contact that is linked to this profile.
-
#region ⇒ String
The state/region of the address.
-
#type ⇒ String
The type of the accounting profile.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ AccountingProfileRequest
constructor
Initialize the AccountingProfileRequest using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ AccountingProfileRequest
Initialize the AccountingProfileRequest using the provided prototype
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 29 def initialize(params = {}) @accounting_profile_id = params.dig(:accounting_profile_id) @company_id = params.dig(:company_id) @group_key = params.dig(:group_key) @name = params.dig(:name) @type = params.dig(:type) @email_address = params.dig(:email_address) @phone = params.dig(:phone) @address1 = params.dig(:address1) @address2 = params.dig(:address2) @address3 = params.dig(:address3) @city = params.dig(:city) @region = params.dig(:region) @postal_code = params.dig(:postal_code) @country = params.dig(:country) @created = params.dig(:created) @created_user_id = params.dig(:created_user_id) @modified = params.dig(:modified) @modified_user_id = params.dig(:modified_user_id) @notes = params.dig(:notes) = params.dig(:attachments) @custom_field_definitions = params.dig(:custom_field_definitions) @custom_field_values = params.dig(:custom_field_values) @primary_contact_id = params.dig(:primary_contact_id) end |
Instance Attribute Details
#accounting_profile_id ⇒ Uuid
57 58 59 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 57 def accounting_profile_id @accounting_profile_id end |
#address1 ⇒ String
85 86 87 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 85 def address1 @address1 end |
#address2 ⇒ String
89 90 91 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 89 def address2 @address2 end |
#address3 ⇒ String
93 94 95 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 93 def address3 @address3 end |
#attachments ⇒ AttachmentModel
133 134 135 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 133 def end |
#city ⇒ String
97 98 99 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 97 def city @city end |
#company_id ⇒ Uuid
61 62 63 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 61 def company_id @company_id end |
#country ⇒ String
109 110 111 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 109 def country @country end |
#created ⇒ Date-time
113 114 115 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 113 def created @created end |
#created_user_id ⇒ Uuid
117 118 119 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 117 def created_user_id @created_user_id end |
#custom_field_definitions ⇒ CustomFieldDefinitionModel
137 138 139 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 137 def custom_field_definitions @custom_field_definitions end |
#custom_field_values ⇒ CustomFieldValueModel
141 142 143 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 141 def custom_field_values @custom_field_values end |
#email_address ⇒ Email
77 78 79 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 77 def email_address @email_address end |
#group_key ⇒ Uuid
65 66 67 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 65 def group_key @group_key end |
#modified ⇒ Date-time
121 122 123 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 121 def modified @modified end |
#modified_user_id ⇒ Uuid
125 126 127 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 125 def modified_user_id @modified_user_id end |
#name ⇒ String
69 70 71 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 69 def name @name end |
#notes ⇒ NoteModel
129 130 131 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 129 def notes @notes end |
#phone ⇒ String
81 82 83 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 81 def phone @phone end |
#postal_code ⇒ String
105 106 107 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 105 def postal_code @postal_code end |
#primary_contact_id ⇒ Uuid
145 146 147 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 145 def primary_contact_id @primary_contact_id end |
#region ⇒ String
101 102 103 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 101 def region @region end |
#type ⇒ String
73 74 75 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 73 def type @type end |
Instance Method Details
#as_json(options = {}) ⇒ object
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 149 def as_json(={}) { 'accountingProfileId' => @accounting_profile_id, 'companyId' => @company_id, 'groupKey' => @group_key, 'name' => @name, 'type' => @type, 'emailAddress' => @email_address, 'phone' => @phone, 'address1' => @address1, 'address2' => @address2, 'address3' => @address3, 'city' => @city, 'region' => @region, 'postalCode' => @postal_code, 'country' => @country, 'created' => @created, 'createdUserId' => @created_user_id, 'modified' => @modified, 'modifiedUserId' => @modified_user_id, 'notes' => @notes, 'attachments' => , 'customFieldDefinitions' => @custom_field_definitions, 'customFieldValues' => @custom_field_values, 'primaryContactId' => @primary_contact_id, } end |
#to_json(*options) ⇒ String
179 180 181 |
# File 'lib/lockstep_sdk/models/accounting_profile_request.rb', line 179 def to_json(*) "[#{as_json(*options).to_json(*options)}]" end |