ledger_sync 1.4.1 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +71 -17
- data/docs/.gitignore +4 -0
- data/documentation/build.sh +3 -1
- data/documentation/site/_includes/ledgers/{Stripe_summary.md → stripe_summary.md} +0 -0
- data/ledger_sync.gemspec +4 -0
- data/lib/ledger_sync/serialization/type/deserializer_references_one_type.rb +1 -1
- data/lib/ledger_sync/version.rb +1 -1
- metadata +59 -136
- data/docs/CNAME +0 -1
- data/docs/assets/css/brands.min.css +0 -5
- data/docs/assets/css/fontawesome.min.css +0 -5
- data/docs/assets/css/main.css +0 -1924
- data/docs/assets/css/monokai.css +0 -441
- data/docs/assets/js/main.js +0 -214
- data/docs/assets/js/plugins.js +0 -22
- data/docs/assets/js/prism.js +0 -9
- data/docs/assets/webfonts/fa-brands-400.eot +0 -0
- data/docs/assets/webfonts/fa-brands-400.svg +0 -3452
- data/docs/assets/webfonts/fa-brands-400.ttf +0 -0
- data/docs/assets/webfonts/fa-brands-400.woff +0 -0
- data/docs/assets/webfonts/fa-brands-400.woff2 +0 -0
- data/docs/blog/index.html +0 -282
- data/docs/guides/architecture/clients/index.html +0 -458
- data/docs/guides/architecture/index.html +0 -435
- data/docs/guides/architecture/operations/index.html +0 -465
- data/docs/guides/architecture/resources/index.html +0 -461
- data/docs/guides/architecture/results/index.html +0 -426
- data/docs/guides/architecture/searchers/index.html +0 -446
- data/docs/guides/architecture/serialization/index.html +0 -476
- data/docs/guides/community/index.html +0 -412
- data/docs/guides/contribute/console/index.html +0 -424
- data/docs/guides/contribute/deployment/index.html +0 -434
- data/docs/guides/contribute/documentation/index.html +0 -450
- data/docs/guides/contribute/index.html +0 -434
- data/docs/guides/contribute/qa/index.html +0 -436
- data/docs/guides/contribute/testing/index.html +0 -424
- data/docs/guides/customization/custom_resources/index.html +0 -461
- data/docs/guides/customization/custom_serializers/index.html +0 -460
- data/docs/guides/customization/index.html +0 -431
- data/docs/guides/customization/resource_converters/index.html +0 -491
- data/docs/guides/getting-started/get-help/index.html +0 -427
- data/docs/guides/getting-started/index.html +0 -421
- data/docs/guides/getting-started/installation/index.html +0 -433
- data/docs/guides/getting-started/quick-start/index.html +0 -531
- data/docs/guides/index.html +0 -428
- data/docs/guides/ledgers/index.html +0 -429
- data/docs/guides/ledgers/netsuite/index.html +0 -424
- data/docs/guides/ledgers/netsuite_soap/index.html +0 -424
- data/docs/guides/ledgers/quickbooks_online/index.html +0 -424
- data/docs/guides/ledgers/stripe/index.html +0 -424
- data/docs/guides/modern-treasury/index.html +0 -411
- data/docs/guides/tips_and_more/index.html +0 -471
- data/docs/images/1.jpg +0 -0
- data/docs/images/10.jpg +0 -0
- data/docs/images/2.jpg +0 -0
- data/docs/images/3.jpg +0 -0
- data/docs/images/4.jpg +0 -0
- data/docs/images/5.jpg +0 -0
- data/docs/images/6.jpg +0 -0
- data/docs/images/7.jpg +0 -0
- data/docs/images/8.jpg +0 -0
- data/docs/images/9.jpg +0 -0
- data/docs/images/logo.svg +0 -8
- data/docs/index.html +0 -379
- data/docs/overview/index.html +0 -409
- data/docs/posts/introducing-docs/index.html +0 -270
- data/docs/posts/netsuite-authentication/index.html +0 -624
- data/docs/reference/architecture/clients/index.html +0 -332
- data/docs/reference/architecture/index.html +0 -311
- data/docs/reference/architecture/operations/index.html +0 -302
- data/docs/reference/architecture/resources/index.html +0 -335
- data/docs/reference/architecture/results/index.html +0 -302
- data/docs/reference/architecture/searchers/index.html +0 -302
- data/docs/reference/architecture/serialization/index.html +0 -302
- data/docs/reference/index.html +0 -281
- data/docs/reference/netsuite/authentication/index.html +0 -392
- data/docs/reference/netsuite/authentication/token_based_authentication/index.html +0 -486
- data/docs/reference/netsuite/index.html +0 -388
- data/docs/reference/netsuite/resources/account/index.html +0 -484
- data/docs/reference/netsuite/resources/check/index.html +0 -492
- data/docs/reference/netsuite/resources/check_line_item/index.html +0 -460
- data/docs/reference/netsuite/resources/currency/index.html +0 -476
- data/docs/reference/netsuite/resources/customer/index.html +0 -488
- data/docs/reference/netsuite/resources/customer_deposit/index.html +0 -480
- data/docs/reference/netsuite/resources/department/index.html +0 -484
- data/docs/reference/netsuite/resources/deposit/index.html +0 -468
- data/docs/reference/netsuite/resources/deposit_line_item/index.html +0 -460
- data/docs/reference/netsuite/resources/index.html +0 -436
- data/docs/reference/netsuite/resources/invoice/index.html +0 -468
- data/docs/reference/netsuite/resources/invoice_line_item/index.html +0 -456
- data/docs/reference/netsuite/resources/item/index.html +0 -444
- data/docs/reference/netsuite/resources/journal_entry/index.html +0 -488
- data/docs/reference/netsuite/resources/journal_entry_line_item/index.html +0 -464
- data/docs/reference/netsuite/resources/ledger_class/index.html +0 -484
- data/docs/reference/netsuite/resources/location/index.html +0 -468
- data/docs/reference/netsuite/resources/resource/index.html +0 -440
- data/docs/reference/netsuite/resources/subsidiary/index.html +0 -448
- data/docs/reference/netsuite/resources/vendor/index.html +0 -492
- data/docs/reference/netsuite_soap/index.html +0 -303
- data/docs/reference/netsuite_soap/resources/customer/index.html +0 -364
- data/docs/reference/netsuite_soap/resources/index.html +0 -316
- data/docs/reference/netsuite_soap/resources/resource/index.html +0 -336
- data/docs/reference/netsuite_soap/resources/subsidiary/index.html +0 -356
- data/docs/reference/quickbooks_online/authentication/index.html +0 -442
- data/docs/reference/quickbooks_online/errors/index.html +0 -395
- data/docs/reference/quickbooks_online/index.html +0 -393
- data/docs/reference/quickbooks_online/resources/account/index.html +0 -530
- data/docs/reference/quickbooks_online/resources/bill/index.html +0 -534
- data/docs/reference/quickbooks_online/resources/bill_line_item/index.html +0 -496
- data/docs/reference/quickbooks_online/resources/bill_payment/index.html +0 -550
- data/docs/reference/quickbooks_online/resources/bill_payment_line_item/index.html +0 -488
- data/docs/reference/quickbooks_online/resources/currency/index.html +0 -492
- data/docs/reference/quickbooks_online/resources/customer/index.html +0 -514
- data/docs/reference/quickbooks_online/resources/department/index.html +0 -518
- data/docs/reference/quickbooks_online/resources/deposit/index.html +0 -526
- data/docs/reference/quickbooks_online/resources/deposit_line_item/index.html +0 -500
- data/docs/reference/quickbooks_online/resources/expense/index.html +0 -538
- data/docs/reference/quickbooks_online/resources/expense_line_item/index.html +0 -496
- data/docs/reference/quickbooks_online/resources/index.html +0 -484
- data/docs/reference/quickbooks_online/resources/invoice/index.html +0 -526
- data/docs/reference/quickbooks_online/resources/invoice_sales_line_item/index.html +0 -496
- data/docs/reference/quickbooks_online/resources/item/index.html +0 -484
- data/docs/reference/quickbooks_online/resources/journal_entry/index.html +0 -518
- data/docs/reference/quickbooks_online/resources/journal_entry_line_item/index.html +0 -504
- data/docs/reference/quickbooks_online/resources/ledger_class/index.html +0 -518
- data/docs/reference/quickbooks_online/resources/payment/index.html +0 -538
- data/docs/reference/quickbooks_online/resources/payment_line_item/index.html +0 -488
- data/docs/reference/quickbooks_online/resources/preferences/index.html +0 -526
- data/docs/reference/quickbooks_online/resources/primary_email_addr/index.html +0 -484
- data/docs/reference/quickbooks_online/resources/primary_phone/index.html +0 -484
- data/docs/reference/quickbooks_online/resources/resource/index.html +0 -480
- data/docs/reference/quickbooks_online/resources/subsidiary/index.html +0 -488
- data/docs/reference/quickbooks_online/resources/transfer/index.html +0 -522
- data/docs/reference/quickbooks_online/resources/vendor/index.html +0 -526
- data/docs/reference/quickbooks_online/webhooks/index.html +0 -427
- data/docs/reference/stripe/index.html +0 -293
- data/docs/reference/stripe/resources/customer/index.html +0 -366
- data/docs/reference/stripe/resources/index.html +0 -309
- data/docs/reference/stripe/resources/resource/index.html +0 -330
- data/docs/style-guide/index.html +0 -375
- data/documentation/site/Gemfile +0 -11
- data/documentation/site/Gemfile.lock +0 -69
@@ -1,356 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en">
|
3
|
-
|
4
|
-
<head>
|
5
|
-
|
6
|
-
<title>LedgerSync - subsidiary - LedgerSync</title>
|
7
|
-
<meta charset="utf-8">
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
9
|
-
<meta name="description" content="An open-source library for easily syncing with accounting software, general ledgers, ERPs, and other ledgers." />
|
10
|
-
<link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,700i%26display=swap" rel="stylesheet">
|
11
|
-
<link rel="stylesheet" href="/assets/css/main.css">
|
12
|
-
|
13
|
-
<!-- Global site tag (gtag.js) - Google Analytics -->
|
14
|
-
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-152343827-1"></script>
|
15
|
-
<script>
|
16
|
-
window.dataLayer = window.dataLayer || [];
|
17
|
-
function gtag(){dataLayer.push(arguments);}
|
18
|
-
gtag('js', new Date());
|
19
|
-
|
20
|
-
gtag('config', 'UA-152343827-1');
|
21
|
-
</script>
|
22
|
-
|
23
|
-
</head>
|
24
|
-
|
25
|
-
<body>
|
26
|
-
|
27
|
-
<div id="page" class="site">
|
28
|
-
<header id="masthead" class="site-header outer">
|
29
|
-
<div class="inner">
|
30
|
-
<div class="site-header-inside">
|
31
|
-
<div class="site-branding">
|
32
|
-
|
33
|
-
|
34
|
-
<p class="site-logo"><a href="/"><img src="/images/logo.svg" alt="LedgerSync" /></a></p>
|
35
|
-
|
36
|
-
</div><!-- .site-branding -->
|
37
|
-
|
38
|
-
|
39
|
-
<nav id="main-navigation" class="site-navigation" aria-label="Main Navigation">
|
40
|
-
<div class="site-nav-inside">
|
41
|
-
<button id="menu-close" class="menu-toggle"><span class="screen-reader-text">Open Menu</span><span class="icon-close" aria-hidden="true"></span></button>
|
42
|
-
<ul class="menu">
|
43
|
-
|
44
|
-
<li class="menu-item">
|
45
|
-
|
46
|
-
|
47
|
-
<a class="" href="/" >
|
48
|
-
|
49
|
-
Home
|
50
|
-
|
51
|
-
</a>
|
52
|
-
|
53
|
-
</li>
|
54
|
-
|
55
|
-
<li class="menu-item">
|
56
|
-
|
57
|
-
|
58
|
-
<a class="" href="/guides/" >
|
59
|
-
|
60
|
-
Guides
|
61
|
-
|
62
|
-
</a>
|
63
|
-
|
64
|
-
</li>
|
65
|
-
|
66
|
-
<li class="menu-item has-children">
|
67
|
-
|
68
|
-
|
69
|
-
<a class="" href="/reference" >
|
70
|
-
|
71
|
-
Reference
|
72
|
-
|
73
|
-
</a>
|
74
|
-
|
75
|
-
|
76
|
-
<ul class="submenu">
|
77
|
-
|
78
|
-
<li class="menu-item">
|
79
|
-
|
80
|
-
|
81
|
-
<a class="" href="/reference/netsuite" >
|
82
|
-
|
83
|
-
NetSuite REST
|
84
|
-
|
85
|
-
</a>
|
86
|
-
</li>
|
87
|
-
|
88
|
-
<li class="menu-item">
|
89
|
-
|
90
|
-
|
91
|
-
<a class="" href="/reference/netsuite_soap" >
|
92
|
-
|
93
|
-
NetSuite SOAP
|
94
|
-
|
95
|
-
</a>
|
96
|
-
</li>
|
97
|
-
|
98
|
-
<li class="menu-item">
|
99
|
-
|
100
|
-
|
101
|
-
<a class="" href="/reference/quickbooks_online" >
|
102
|
-
|
103
|
-
QuickBooks Online
|
104
|
-
|
105
|
-
</a>
|
106
|
-
</li>
|
107
|
-
|
108
|
-
<li class="menu-item">
|
109
|
-
|
110
|
-
|
111
|
-
<a class="" href="/reference/stripe" >
|
112
|
-
|
113
|
-
Stripe
|
114
|
-
|
115
|
-
</a>
|
116
|
-
</li>
|
117
|
-
|
118
|
-
</ul>
|
119
|
-
|
120
|
-
|
121
|
-
</li>
|
122
|
-
|
123
|
-
<li class="menu-item">
|
124
|
-
|
125
|
-
|
126
|
-
<a class="" href="/blog" >
|
127
|
-
|
128
|
-
Blog
|
129
|
-
|
130
|
-
</a>
|
131
|
-
|
132
|
-
</li>
|
133
|
-
|
134
|
-
<li class="menu-item">
|
135
|
-
|
136
|
-
|
137
|
-
<a class="" href="/guides/contribute" >
|
138
|
-
|
139
|
-
Contribute
|
140
|
-
|
141
|
-
</a>
|
142
|
-
|
143
|
-
</li>
|
144
|
-
|
145
|
-
<li class="menu-item menu-button">
|
146
|
-
|
147
|
-
|
148
|
-
<a class="button" href="https://github.com/LedgerSync/ledger_sync" >
|
149
|
-
|
150
|
-
GitHub
|
151
|
-
|
152
|
-
</a>
|
153
|
-
|
154
|
-
</li>
|
155
|
-
|
156
|
-
</ul>
|
157
|
-
</div><!-- .site-nav-inside -->
|
158
|
-
</nav><!-- .site-navigation -->
|
159
|
-
<button id="menu-open" class="menu-toggle"><span class="screen-reader-text">Close Menu</span><span class="icon-menu" aria-hidden="true"></span></button>
|
160
|
-
|
161
|
-
</div><!-- .site-header-inside -->
|
162
|
-
</div><!-- .inner -->
|
163
|
-
</header><!-- .site-header -->
|
164
|
-
|
165
|
-
<main id="content" class="site-content">
|
166
|
-
<div class="inner outer">
|
167
|
-
<div class="guides-content">
|
168
|
-
|
169
|
-
<nav id="guides-nav" class="guides-nav">
|
170
|
-
<div id="guides-nav-inside" class="guides-nav-inside sticky">
|
171
|
-
<button id="guides-nav-toggle" class="guides-nav-toggle">Navigate<span class="icon-angle-right" aria-hidden="true"></span></button>
|
172
|
-
<div class="guides-toc-wrap">
|
173
|
-
<ul id="guides-toc" class="guides-toc">
|
174
|
-
|
175
|
-
<li class="toc-item">
|
176
|
-
<a href="/reference/netsuite_soap/">NetSuite SOAP</a>
|
177
|
-
</li>
|
178
|
-
|
179
|
-
|
180
|
-
<li class="toc-item">
|
181
|
-
<a href=""></a>
|
182
|
-
</li>
|
183
|
-
|
184
|
-
<li class="toc-item">
|
185
|
-
<a href=""></a>
|
186
|
-
</li>
|
187
|
-
|
188
|
-
<li class="toc-item has-children active">
|
189
|
-
<a href="/reference/netsuite_soap/resources/">Resources</a>
|
190
|
-
<button class="submenu-toggle"><span class="screen-reader-text">Submenu</span><span class="icon-angle-right" aria-hidden="true"></span></button> <ul class="toc-submenu">
|
191
|
-
|
192
|
-
<li class="toc-item">
|
193
|
-
<a href="/reference/netsuite_soap/resources/customer/">customer</a>
|
194
|
-
</li>
|
195
|
-
|
196
|
-
<li class="toc-item">
|
197
|
-
<a href="/reference/netsuite_soap/resources/resource/">resource</a>
|
198
|
-
</li>
|
199
|
-
|
200
|
-
<li class="toc-item current">
|
201
|
-
<a href="/reference/netsuite_soap/resources/subsidiary/">subsidiary</a>
|
202
|
-
</li>
|
203
|
-
|
204
|
-
</ul>
|
205
|
-
|
206
|
-
</li>
|
207
|
-
|
208
|
-
|
209
|
-
</ul>
|
210
|
-
<!-- .guides-toc -->
|
211
|
-
</div>
|
212
|
-
<!-- .guides-toc-wrap -->
|
213
|
-
</div>
|
214
|
-
<!-- .guides-nav-inside -->
|
215
|
-
</nav>
|
216
|
-
<!-- .guides-nav -->
|
217
|
-
<article class="post type-guides">
|
218
|
-
<div class="post-inside">
|
219
|
-
<header class="post-header">
|
220
|
-
<h1 class="post-title line-left">subsidiary</h1>
|
221
|
-
</header>
|
222
|
-
<!-- .post-header -->
|
223
|
-
<div class="post-content">
|
224
|
-
<h2 id="ledgersyncledgersnetsuitesoapsubsidiary">LedgerSync::Ledgers::NetSuiteSOAP::Subsidiary</h2>
|
225
|
-
|
226
|
-
<h2 id="attributes">Attributes</h2>
|
227
|
-
|
228
|
-
<table>
|
229
|
-
<thead>
|
230
|
-
<tr>
|
231
|
-
<th>Name</th>
|
232
|
-
<th>Type</th>
|
233
|
-
</tr>
|
234
|
-
</thead>
|
235
|
-
<tbody>
|
236
|
-
<tr>
|
237
|
-
<td>external_id</td>
|
238
|
-
<td>LedgerSync::Type::ID</td>
|
239
|
-
</tr>
|
240
|
-
<tr>
|
241
|
-
<td>ledger_id</td>
|
242
|
-
<td>LedgerSync::Type::ID</td>
|
243
|
-
</tr>
|
244
|
-
<tr>
|
245
|
-
<td>name</td>
|
246
|
-
<td>LedgerSync::Type::String</td>
|
247
|
-
</tr>
|
248
|
-
<tr>
|
249
|
-
<td>state</td>
|
250
|
-
<td>LedgerSync::Type::String</td>
|
251
|
-
</tr>
|
252
|
-
</tbody>
|
253
|
-
</table>
|
254
|
-
|
255
|
-
<h2 id="operations">Operations</h2>
|
256
|
-
|
257
|
-
<h3 id="ledgersyncledgersnetsuitesoapsubsidiaryoperationsfind">LedgerSync::Ledgers::NetSuiteSOAP::Subsidiary::Operations::Find</h3>
|
258
|
-
|
259
|
-
<h4 id="resource-validations">Resource Validations</h4>
|
260
|
-
|
261
|
-
<p>| Name | Type |
|
262
|
-
| —- | —- |</p>
|
263
|
-
<h3 id="ledgersyncledgersnetsuitesoapsubsidiaryoperationscreate">LedgerSync::Ledgers::NetSuiteSOAP::Subsidiary::Operations::Create</h3>
|
264
|
-
|
265
|
-
<h4 id="resource-validations-1">Resource Validations</h4>
|
266
|
-
|
267
|
-
<p>| Name | Type |
|
268
|
-
| —- | —- |</p>
|
269
|
-
|
270
|
-
<hr />
|
271
|
-
|
272
|
-
<div>Related articles:</div><br />
|
273
|
-
|
274
|
-
<ul class="guides-section-items">
|
275
|
-
|
276
|
-
<li class="guides-section-item"><a href="/reference/netsuite_soap/resources/customer/" class="guides-item-link">customer<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
277
|
-
|
278
|
-
<li class="guides-section-item"><a href="/reference/netsuite_soap/resources/resource/" class="guides-item-link">resource<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
279
|
-
|
280
|
-
<li class="guides-section-item"><a href="/reference/netsuite_soap/resources/subsidiary/" class="guides-item-link">subsidiary<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
281
|
-
|
282
|
-
</ul>
|
283
|
-
<!-- .guides-section-pages -->
|
284
|
-
|
285
|
-
</div>
|
286
|
-
<!-- .post-content -->
|
287
|
-
</div>
|
288
|
-
<!-- .post-inside -->
|
289
|
-
</article>
|
290
|
-
<!-- .post -->
|
291
|
-
<nav id="page-nav" class="page-nav">
|
292
|
-
<div id="page-nav-inside" class="page-nav-inside sticky">
|
293
|
-
<h2 class="page-nav-title">Jump to Section</h2>
|
294
|
-
</div>
|
295
|
-
<!-- .page-nav-inside -->
|
296
|
-
</nav>
|
297
|
-
<!-- .page-nav -->
|
298
|
-
</div>
|
299
|
-
<!-- .guides-content -->
|
300
|
-
</div>
|
301
|
-
<!-- .inner-->
|
302
|
-
</main><!-- .site-content -->
|
303
|
-
<footer id="colophon" class="site-footer outer">
|
304
|
-
<div class="inner">
|
305
|
-
<div class="site-footer-inside">
|
306
|
-
<p class="site-info">
|
307
|
-
|
308
|
-
<span class="copyright">© Modern Treasury Inc. All rights reserved.</span>
|
309
|
-
<a class="" href="https://www.moderntreasury.com" target="_blank" rel="noopener" >
|
310
|
-
|
311
|
-
Maintained with ❤️ in San Francisco, CA by Modern Treasury
|
312
|
-
|
313
|
-
</a>
|
314
|
-
</p>
|
315
|
-
<!-- .site-info -->
|
316
|
-
|
317
|
-
<div class="social-links">
|
318
|
-
|
319
|
-
<a class="" href="https://www.netlify.com" target="_blank" rel="noopener" >
|
320
|
-
|
321
|
-
<img src="https://www.netlify.com/img/global/badges/netlify-dark.svg" alt="Deploys by Netlify" />
|
322
|
-
|
323
|
-
</a>
|
324
|
-
<a class="button button-icon" href="https://twitter.com/ModernTreasury" target="_blank" rel="noopener" >
|
325
|
-
|
326
|
-
<span class="icon fab fa-twitter" aria-hidden="true"></span><span class="screen-reader-text">Twitter</span>
|
327
|
-
|
328
|
-
</a>
|
329
|
-
<a class="button button-icon" href="https://www.linkedin.com/company/modern-treasury" target="_blank" rel="noopener" >
|
330
|
-
|
331
|
-
<span class="icon fab fa-linkedin" aria-hidden="true"></span><span class="screen-reader-text">LinkedIn</span>
|
332
|
-
|
333
|
-
</a>
|
334
|
-
<a class="button button-icon" href="https://github.com/LedgerSync/ledger_sync" target="_blank" rel="noopener" >
|
335
|
-
|
336
|
-
<span class="icon fab fa-github" aria-hidden="true"></span><span class="screen-reader-text">GitHub</span>
|
337
|
-
|
338
|
-
</a>
|
339
|
-
</div>
|
340
|
-
<!-- .social-links -->
|
341
|
-
|
342
|
-
</div>
|
343
|
-
<!-- .site-footer-inside -->
|
344
|
-
</div>
|
345
|
-
<!-- .inner -->
|
346
|
-
</footer>
|
347
|
-
<!-- .site-footer -->
|
348
|
-
</div><!-- .site -->
|
349
|
-
|
350
|
-
<!-- Scripts -->
|
351
|
-
<script src="/assets/js/plugins.js"></script>
|
352
|
-
<script src="/assets/js/prism.js" data-manual></script>
|
353
|
-
<script src="/assets/js/main.js"></script>
|
354
|
-
</body>
|
355
|
-
|
356
|
-
</html>
|
@@ -1,442 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en">
|
3
|
-
|
4
|
-
<head>
|
5
|
-
|
6
|
-
<title>LedgerSync - Authentication - LedgerSync</title>
|
7
|
-
<meta charset="utf-8">
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
9
|
-
<meta name="description" content="An open-source library for easily syncing with accounting software, general ledgers, ERPs, and other ledgers." />
|
10
|
-
<link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,700i%26display=swap" rel="stylesheet">
|
11
|
-
<link rel="stylesheet" href="/assets/css/main.css">
|
12
|
-
|
13
|
-
<!-- Global site tag (gtag.js) - Google Analytics -->
|
14
|
-
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-152343827-1"></script>
|
15
|
-
<script>
|
16
|
-
window.dataLayer = window.dataLayer || [];
|
17
|
-
function gtag(){dataLayer.push(arguments);}
|
18
|
-
gtag('js', new Date());
|
19
|
-
|
20
|
-
gtag('config', 'UA-152343827-1');
|
21
|
-
</script>
|
22
|
-
|
23
|
-
</head>
|
24
|
-
|
25
|
-
<body>
|
26
|
-
|
27
|
-
<div id="page" class="site">
|
28
|
-
<header id="masthead" class="site-header outer">
|
29
|
-
<div class="inner">
|
30
|
-
<div class="site-header-inside">
|
31
|
-
<div class="site-branding">
|
32
|
-
|
33
|
-
|
34
|
-
<p class="site-logo"><a href="/"><img src="/images/logo.svg" alt="LedgerSync" /></a></p>
|
35
|
-
|
36
|
-
</div><!-- .site-branding -->
|
37
|
-
|
38
|
-
|
39
|
-
<nav id="main-navigation" class="site-navigation" aria-label="Main Navigation">
|
40
|
-
<div class="site-nav-inside">
|
41
|
-
<button id="menu-close" class="menu-toggle"><span class="screen-reader-text">Open Menu</span><span class="icon-close" aria-hidden="true"></span></button>
|
42
|
-
<ul class="menu">
|
43
|
-
|
44
|
-
<li class="menu-item">
|
45
|
-
|
46
|
-
|
47
|
-
<a class="" href="/" >
|
48
|
-
|
49
|
-
Home
|
50
|
-
|
51
|
-
</a>
|
52
|
-
|
53
|
-
</li>
|
54
|
-
|
55
|
-
<li class="menu-item">
|
56
|
-
|
57
|
-
|
58
|
-
<a class="" href="/guides/" >
|
59
|
-
|
60
|
-
Guides
|
61
|
-
|
62
|
-
</a>
|
63
|
-
|
64
|
-
</li>
|
65
|
-
|
66
|
-
<li class="menu-item has-children">
|
67
|
-
|
68
|
-
|
69
|
-
<a class="" href="/reference" >
|
70
|
-
|
71
|
-
Reference
|
72
|
-
|
73
|
-
</a>
|
74
|
-
|
75
|
-
|
76
|
-
<ul class="submenu">
|
77
|
-
|
78
|
-
<li class="menu-item">
|
79
|
-
|
80
|
-
|
81
|
-
<a class="" href="/reference/netsuite" >
|
82
|
-
|
83
|
-
NetSuite REST
|
84
|
-
|
85
|
-
</a>
|
86
|
-
</li>
|
87
|
-
|
88
|
-
<li class="menu-item">
|
89
|
-
|
90
|
-
|
91
|
-
<a class="" href="/reference/netsuite_soap" >
|
92
|
-
|
93
|
-
NetSuite SOAP
|
94
|
-
|
95
|
-
</a>
|
96
|
-
</li>
|
97
|
-
|
98
|
-
<li class="menu-item">
|
99
|
-
|
100
|
-
|
101
|
-
<a class="" href="/reference/quickbooks_online" >
|
102
|
-
|
103
|
-
QuickBooks Online
|
104
|
-
|
105
|
-
</a>
|
106
|
-
</li>
|
107
|
-
|
108
|
-
<li class="menu-item">
|
109
|
-
|
110
|
-
|
111
|
-
<a class="" href="/reference/stripe" >
|
112
|
-
|
113
|
-
Stripe
|
114
|
-
|
115
|
-
</a>
|
116
|
-
</li>
|
117
|
-
|
118
|
-
</ul>
|
119
|
-
|
120
|
-
|
121
|
-
</li>
|
122
|
-
|
123
|
-
<li class="menu-item">
|
124
|
-
|
125
|
-
|
126
|
-
<a class="" href="/blog" >
|
127
|
-
|
128
|
-
Blog
|
129
|
-
|
130
|
-
</a>
|
131
|
-
|
132
|
-
</li>
|
133
|
-
|
134
|
-
<li class="menu-item">
|
135
|
-
|
136
|
-
|
137
|
-
<a class="" href="/guides/contribute" >
|
138
|
-
|
139
|
-
Contribute
|
140
|
-
|
141
|
-
</a>
|
142
|
-
|
143
|
-
</li>
|
144
|
-
|
145
|
-
<li class="menu-item menu-button">
|
146
|
-
|
147
|
-
|
148
|
-
<a class="button" href="https://github.com/LedgerSync/ledger_sync" >
|
149
|
-
|
150
|
-
GitHub
|
151
|
-
|
152
|
-
</a>
|
153
|
-
|
154
|
-
</li>
|
155
|
-
|
156
|
-
</ul>
|
157
|
-
</div><!-- .site-nav-inside -->
|
158
|
-
</nav><!-- .site-navigation -->
|
159
|
-
<button id="menu-open" class="menu-toggle"><span class="screen-reader-text">Close Menu</span><span class="icon-menu" aria-hidden="true"></span></button>
|
160
|
-
|
161
|
-
</div><!-- .site-header-inside -->
|
162
|
-
</div><!-- .inner -->
|
163
|
-
</header><!-- .site-header -->
|
164
|
-
|
165
|
-
<main id="content" class="site-content">
|
166
|
-
<div class="inner outer">
|
167
|
-
<div class="guides-content">
|
168
|
-
|
169
|
-
<nav id="guides-nav" class="guides-nav">
|
170
|
-
<div id="guides-nav-inside" class="guides-nav-inside sticky">
|
171
|
-
<button id="guides-nav-toggle" class="guides-nav-toggle">Navigate<span class="icon-angle-right" aria-hidden="true"></span></button>
|
172
|
-
<div class="guides-toc-wrap">
|
173
|
-
<ul id="guides-toc" class="guides-toc">
|
174
|
-
|
175
|
-
<li class="toc-item">
|
176
|
-
<a href="/reference/quickbooks_online/">QuickBooks Online</a>
|
177
|
-
</li>
|
178
|
-
|
179
|
-
|
180
|
-
<li class="toc-item current active">
|
181
|
-
<a href="/reference/quickbooks_online/authentication/">Authentication</a>
|
182
|
-
</li>
|
183
|
-
|
184
|
-
<li class="toc-item">
|
185
|
-
<a href=""></a>
|
186
|
-
</li>
|
187
|
-
|
188
|
-
<li class="toc-item has-children">
|
189
|
-
<a href="/reference/quickbooks_online/resources/">Resources</a>
|
190
|
-
<button class="submenu-toggle"><span class="screen-reader-text">Submenu</span><span class="icon-angle-right" aria-hidden="true"></span></button> <ul class="toc-submenu">
|
191
|
-
|
192
|
-
<li class="toc-item">
|
193
|
-
<a href="/reference/quickbooks_online/resources/account/">account</a>
|
194
|
-
</li>
|
195
|
-
|
196
|
-
<li class="toc-item">
|
197
|
-
<a href="/reference/quickbooks_online/resources/bill/">bill</a>
|
198
|
-
</li>
|
199
|
-
|
200
|
-
<li class="toc-item">
|
201
|
-
<a href="/reference/quickbooks_online/resources/bill_line_item/">bill_line_item</a>
|
202
|
-
</li>
|
203
|
-
|
204
|
-
<li class="toc-item">
|
205
|
-
<a href="/reference/quickbooks_online/resources/bill_payment/">bill_payment</a>
|
206
|
-
</li>
|
207
|
-
|
208
|
-
<li class="toc-item">
|
209
|
-
<a href="/reference/quickbooks_online/resources/bill_payment_line_item/">bill_payment_line_item</a>
|
210
|
-
</li>
|
211
|
-
|
212
|
-
<li class="toc-item">
|
213
|
-
<a href="/reference/quickbooks_online/resources/currency/">currency</a>
|
214
|
-
</li>
|
215
|
-
|
216
|
-
<li class="toc-item">
|
217
|
-
<a href="/reference/quickbooks_online/resources/customer/">customer</a>
|
218
|
-
</li>
|
219
|
-
|
220
|
-
<li class="toc-item">
|
221
|
-
<a href="/reference/quickbooks_online/resources/department/">department</a>
|
222
|
-
</li>
|
223
|
-
|
224
|
-
<li class="toc-item">
|
225
|
-
<a href="/reference/quickbooks_online/resources/deposit/">deposit</a>
|
226
|
-
</li>
|
227
|
-
|
228
|
-
<li class="toc-item">
|
229
|
-
<a href="/reference/quickbooks_online/resources/deposit_line_item/">deposit_line_item</a>
|
230
|
-
</li>
|
231
|
-
|
232
|
-
<li class="toc-item">
|
233
|
-
<a href="/reference/quickbooks_online/resources/expense/">expense</a>
|
234
|
-
</li>
|
235
|
-
|
236
|
-
<li class="toc-item">
|
237
|
-
<a href="/reference/quickbooks_online/resources/expense_line_item/">expense_line_item</a>
|
238
|
-
</li>
|
239
|
-
|
240
|
-
<li class="toc-item">
|
241
|
-
<a href="/reference/quickbooks_online/resources/invoice/">invoice</a>
|
242
|
-
</li>
|
243
|
-
|
244
|
-
<li class="toc-item">
|
245
|
-
<a href="/reference/quickbooks_online/resources/invoice_sales_line_item/">invoice_sales_line_item</a>
|
246
|
-
</li>
|
247
|
-
|
248
|
-
<li class="toc-item">
|
249
|
-
<a href="/reference/quickbooks_online/resources/item/">item</a>
|
250
|
-
</li>
|
251
|
-
|
252
|
-
<li class="toc-item">
|
253
|
-
<a href="/reference/quickbooks_online/resources/journal_entry/">journal_entry</a>
|
254
|
-
</li>
|
255
|
-
|
256
|
-
<li class="toc-item">
|
257
|
-
<a href="/reference/quickbooks_online/resources/journal_entry_line_item/">journal_entry_line_item</a>
|
258
|
-
</li>
|
259
|
-
|
260
|
-
<li class="toc-item">
|
261
|
-
<a href="/reference/quickbooks_online/resources/ledger_class/">ledger_class</a>
|
262
|
-
</li>
|
263
|
-
|
264
|
-
<li class="toc-item">
|
265
|
-
<a href="/reference/quickbooks_online/resources/payment/">payment</a>
|
266
|
-
</li>
|
267
|
-
|
268
|
-
<li class="toc-item">
|
269
|
-
<a href="/reference/quickbooks_online/resources/payment_line_item/">payment_line_item</a>
|
270
|
-
</li>
|
271
|
-
|
272
|
-
<li class="toc-item">
|
273
|
-
<a href="/reference/quickbooks_online/resources/preferences/">preferences</a>
|
274
|
-
</li>
|
275
|
-
|
276
|
-
<li class="toc-item">
|
277
|
-
<a href="/reference/quickbooks_online/resources/primary_email_addr/">primary_email_addr</a>
|
278
|
-
</li>
|
279
|
-
|
280
|
-
<li class="toc-item">
|
281
|
-
<a href="/reference/quickbooks_online/resources/primary_phone/">primary_phone</a>
|
282
|
-
</li>
|
283
|
-
|
284
|
-
<li class="toc-item">
|
285
|
-
<a href="/reference/quickbooks_online/resources/resource/">resource</a>
|
286
|
-
</li>
|
287
|
-
|
288
|
-
<li class="toc-item">
|
289
|
-
<a href="/reference/quickbooks_online/resources/subsidiary/">subsidiary</a>
|
290
|
-
</li>
|
291
|
-
|
292
|
-
<li class="toc-item">
|
293
|
-
<a href="/reference/quickbooks_online/resources/transfer/">transfer</a>
|
294
|
-
</li>
|
295
|
-
|
296
|
-
<li class="toc-item">
|
297
|
-
<a href="/reference/quickbooks_online/resources/vendor/">vendor</a>
|
298
|
-
</li>
|
299
|
-
|
300
|
-
</ul>
|
301
|
-
|
302
|
-
</li>
|
303
|
-
|
304
|
-
|
305
|
-
</ul>
|
306
|
-
<!-- .guides-toc -->
|
307
|
-
</div>
|
308
|
-
<!-- .guides-toc-wrap -->
|
309
|
-
</div>
|
310
|
-
<!-- .guides-nav-inside -->
|
311
|
-
</nav>
|
312
|
-
<!-- .guides-nav -->
|
313
|
-
<article class="post type-guides">
|
314
|
-
<div class="post-inside">
|
315
|
-
<header class="post-header">
|
316
|
-
<h1 class="post-title line-left">Authentication</h1>
|
317
|
-
</header>
|
318
|
-
<!-- .post-header -->
|
319
|
-
<div class="post-content">
|
320
|
-
<h3 id="oauth">OAuth</h3>
|
321
|
-
|
322
|
-
<p>QuickBooks Online utilizes OAuth 2.0, which requires frequent refreshing of the access token. The client will handle this automatically, attempting a single token refresh on any single request authentication failure. Depending on how you use the library, every client has implements a class method <code class="highlighter-rouge">ledger_attributes_to_save</code>, which is an array of attributes that may change as the client is used. You can also call the instance method <code class="highlighter-rouge">ledger_attributes_to_save</code> which will be a hash of these values. It is a good practice to always store these attributes if you are saving access tokens in your database.</p>
|
323
|
-
|
324
|
-
<h4 id="retrieve-access-token">Retrieve Access Token</h4>
|
325
|
-
|
326
|
-
<p>The library contains a lightweight script that is helpful in retrieving and refreshing access tokens. To use, do the following:</p>
|
327
|
-
|
328
|
-
<ol>
|
329
|
-
<li>Create a <code class="highlighter-rouge">.env</code> file in the library root.</li>
|
330
|
-
<li>Add values for <code class="highlighter-rouge">QUICKBOOKS_ONLINE_CLIENT_ID</code> and <code class="highlighter-rouge">QUICKBOOKS_ONLINE_CLIENT_SECRET</code> (you can copy <code class="highlighter-rouge">.env.template</code>).</li>
|
331
|
-
<li>Ensure your developer application in <a href="https://developer.intuit.com">the QuickBooks Online developer portal</a> contains this redirect URI: <code class="highlighter-rouge">http://localhost:5678</code> (note: no trailing slash and port configurable with <code class="highlighter-rouge">PORT</code> environment variable)</li>
|
332
|
-
<li>Run <code class="highlighter-rouge">ruby bin/quickbooks_online_oauth_server.rb</code> from the library root (note: it must run from the root in order to update <code class="highlighter-rouge">.env</code>).</li>
|
333
|
-
<li>Visit the URL output in the terminal.</li>
|
334
|
-
<li>Upon redirect back to your <code class="highlighter-rouge">localhost</code>, the new values will be printed to the console and saved back to your <code class="highlighter-rouge">.env</code></li>
|
335
|
-
</ol>
|
336
|
-
|
337
|
-
<h4 id="ledger-helper-methods">Ledger Helper Methods</h4>
|
338
|
-
|
339
|
-
<p>The client also implements some helper methods for getting tokens. For example, you can set up an client using the following:</p>
|
340
|
-
|
341
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Retrieve the following values from Intuit app settings</span>
|
342
|
-
<span class="n">client_id</span> <span class="o">=</span> <span class="s1">'ID'</span>
|
343
|
-
<span class="n">client_secret</span> <span class="o">=</span> <span class="s1">'SECRET'</span>
|
344
|
-
<span class="n">redirect_uri</span> <span class="o">=</span> <span class="s1">'http://localhost:3000'</span>
|
345
|
-
|
346
|
-
<span class="n">oauth_client</span> <span class="o">=</span> <span class="no">LedgerSync</span><span class="o">::</span><span class="no">Ledgers</span><span class="o">::</span><span class="no">QuickBooksOnline</span><span class="o">::</span><span class="no">OAuthClientHelper</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span>
|
347
|
-
<span class="ss">client_id: </span><span class="n">client_id</span><span class="p">,</span>
|
348
|
-
<span class="ss">client_secret: </span><span class="n">client_secret</span>
|
349
|
-
<span class="p">)</span>
|
350
|
-
|
351
|
-
<span class="nb">puts</span> <span class="n">oauth_client</span><span class="p">.</span><span class="nf">authorization_url</span><span class="p">(</span><span class="ss">redirect_uri: </span><span class="n">redirect_uri</span><span class="p">)</span>
|
352
|
-
|
353
|
-
<span class="c1"># Visit on the output URL and authorize a company.</span>
|
354
|
-
<span class="c1"># You will be redirected back to the redirect_uri.</span>
|
355
|
-
<span class="c1"># Copy the full url from your browser:</span>
|
356
|
-
|
357
|
-
<span class="n">uri</span> <span class="o">=</span> <span class="s1">'https://localhost:3000/?code=FOO&state=BAR&realm_id=BAZ'</span>
|
358
|
-
|
359
|
-
<span class="n">client</span> <span class="o">=</span> <span class="no">LedgerSync</span><span class="o">::</span><span class="no">Ledgers</span><span class="o">::</span><span class="no">QuickBooksOnline</span><span class="o">::</span><span class="no">Client</span><span class="p">.</span><span class="nf">new_from_oauth_client_uri</span><span class="p">(</span>
|
360
|
-
<span class="ss">oauth_client: </span><span class="n">oauth_client</span><span class="p">,</span>
|
361
|
-
<span class="ss">uri: </span><span class="n">uri</span>
|
362
|
-
<span class="p">)</span>
|
363
|
-
|
364
|
-
<span class="c1"># You can test that the auth works:</span>
|
365
|
-
|
366
|
-
<span class="n">client</span><span class="p">.</span><span class="nf">refresh!</span>
|
367
|
-
</code></pre></div></div>
|
368
|
-
|
369
|
-
<p><strong>Note: If you have a <code class="highlighter-rouge">.env</code> file storing your secrets, the client will automatically update the variables and record previous values whenever values change</strong></p>
|
370
|
-
|
371
|
-
</div>
|
372
|
-
<!-- .post-content -->
|
373
|
-
</div>
|
374
|
-
<!-- .post-inside -->
|
375
|
-
</article>
|
376
|
-
<!-- .post -->
|
377
|
-
<nav id="page-nav" class="page-nav">
|
378
|
-
<div id="page-nav-inside" class="page-nav-inside sticky">
|
379
|
-
<h2 class="page-nav-title">Jump to Section</h2>
|
380
|
-
</div>
|
381
|
-
<!-- .page-nav-inside -->
|
382
|
-
</nav>
|
383
|
-
<!-- .page-nav -->
|
384
|
-
</div>
|
385
|
-
<!-- .guides-content -->
|
386
|
-
</div>
|
387
|
-
<!-- .inner-->
|
388
|
-
</main><!-- .site-content -->
|
389
|
-
<footer id="colophon" class="site-footer outer">
|
390
|
-
<div class="inner">
|
391
|
-
<div class="site-footer-inside">
|
392
|
-
<p class="site-info">
|
393
|
-
|
394
|
-
<span class="copyright">© Modern Treasury Inc. All rights reserved.</span>
|
395
|
-
<a class="" href="https://www.moderntreasury.com" target="_blank" rel="noopener" >
|
396
|
-
|
397
|
-
Maintained with ❤️ in San Francisco, CA by Modern Treasury
|
398
|
-
|
399
|
-
</a>
|
400
|
-
</p>
|
401
|
-
<!-- .site-info -->
|
402
|
-
|
403
|
-
<div class="social-links">
|
404
|
-
|
405
|
-
<a class="" href="https://www.netlify.com" target="_blank" rel="noopener" >
|
406
|
-
|
407
|
-
<img src="https://www.netlify.com/img/global/badges/netlify-dark.svg" alt="Deploys by Netlify" />
|
408
|
-
|
409
|
-
</a>
|
410
|
-
<a class="button button-icon" href="https://twitter.com/ModernTreasury" target="_blank" rel="noopener" >
|
411
|
-
|
412
|
-
<span class="icon fab fa-twitter" aria-hidden="true"></span><span class="screen-reader-text">Twitter</span>
|
413
|
-
|
414
|
-
</a>
|
415
|
-
<a class="button button-icon" href="https://www.linkedin.com/company/modern-treasury" target="_blank" rel="noopener" >
|
416
|
-
|
417
|
-
<span class="icon fab fa-linkedin" aria-hidden="true"></span><span class="screen-reader-text">LinkedIn</span>
|
418
|
-
|
419
|
-
</a>
|
420
|
-
<a class="button button-icon" href="https://github.com/LedgerSync/ledger_sync" target="_blank" rel="noopener" >
|
421
|
-
|
422
|
-
<span class="icon fab fa-github" aria-hidden="true"></span><span class="screen-reader-text">GitHub</span>
|
423
|
-
|
424
|
-
</a>
|
425
|
-
</div>
|
426
|
-
<!-- .social-links -->
|
427
|
-
|
428
|
-
</div>
|
429
|
-
<!-- .site-footer-inside -->
|
430
|
-
</div>
|
431
|
-
<!-- .inner -->
|
432
|
-
</footer>
|
433
|
-
<!-- .site-footer -->
|
434
|
-
</div><!-- .site -->
|
435
|
-
|
436
|
-
<!-- Scripts -->
|
437
|
-
<script src="/assets/js/plugins.js"></script>
|
438
|
-
<script src="/assets/js/prism.js" data-manual></script>
|
439
|
-
<script src="/assets/js/main.js"></script>
|
440
|
-
</body>
|
441
|
-
|
442
|
-
</html>
|