ledger_sync 1.4.1 → 1.4.2
Sign up to get free protection for your applications and to get access to all the features.
- 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,302 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en">
|
3
|
-
|
4
|
-
<head>
|
5
|
-
|
6
|
-
<title>LedgerSync - Operations - 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/">Reference</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">
|
189
|
-
<a href=""></a>
|
190
|
-
</li>
|
191
|
-
|
192
|
-
|
193
|
-
</ul>
|
194
|
-
<!-- .guides-toc -->
|
195
|
-
</div>
|
196
|
-
<!-- .guides-toc-wrap -->
|
197
|
-
</div>
|
198
|
-
<!-- .guides-nav-inside -->
|
199
|
-
</nav>
|
200
|
-
<!-- .guides-nav -->
|
201
|
-
<article class="post type-guides">
|
202
|
-
<div class="post-inside">
|
203
|
-
<header class="post-header">
|
204
|
-
<h1 class="post-title line-left">Operations</h1>
|
205
|
-
</header>
|
206
|
-
<!-- .post-header -->
|
207
|
-
<div class="post-content">
|
208
|
-
|
209
|
-
|
210
|
-
<hr />
|
211
|
-
|
212
|
-
<div>Related articles:</div><br />
|
213
|
-
|
214
|
-
<ul class="guides-section-items">
|
215
|
-
|
216
|
-
<li class="guides-section-item"><a href="/reference/architecture/clients/" class="guides-item-link">Clients<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
217
|
-
|
218
|
-
<li class="guides-section-item"><a href="/reference/architecture/resources/" class="guides-item-link">Resources<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
219
|
-
|
220
|
-
<li class="guides-section-item"><a href="/reference/architecture/serialization/" class="guides-item-link">Serialization<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
221
|
-
|
222
|
-
<li class="guides-section-item"><a href="/reference/architecture/operations/" class="guides-item-link">Operations<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
223
|
-
|
224
|
-
<li class="guides-section-item"><a href="/reference/architecture/searchers/" class="guides-item-link">Operations<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
225
|
-
|
226
|
-
<li class="guides-section-item"><a href="/reference/architecture/results/" class="guides-item-link">Results<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
227
|
-
|
228
|
-
</ul>
|
229
|
-
<!-- .guides-section-pages -->
|
230
|
-
|
231
|
-
</div>
|
232
|
-
<!-- .post-content -->
|
233
|
-
</div>
|
234
|
-
<!-- .post-inside -->
|
235
|
-
</article>
|
236
|
-
<!-- .post -->
|
237
|
-
<nav id="page-nav" class="page-nav">
|
238
|
-
<div id="page-nav-inside" class="page-nav-inside sticky">
|
239
|
-
<h2 class="page-nav-title">Jump to Section</h2>
|
240
|
-
</div>
|
241
|
-
<!-- .page-nav-inside -->
|
242
|
-
</nav>
|
243
|
-
<!-- .page-nav -->
|
244
|
-
</div>
|
245
|
-
<!-- .guides-content -->
|
246
|
-
</div>
|
247
|
-
<!-- .inner-->
|
248
|
-
</main><!-- .site-content -->
|
249
|
-
<footer id="colophon" class="site-footer outer">
|
250
|
-
<div class="inner">
|
251
|
-
<div class="site-footer-inside">
|
252
|
-
<p class="site-info">
|
253
|
-
|
254
|
-
<span class="copyright">© Modern Treasury Inc. All rights reserved.</span>
|
255
|
-
<a class="" href="https://www.moderntreasury.com" target="_blank" rel="noopener" >
|
256
|
-
|
257
|
-
Maintained with ❤️ in San Francisco, CA by Modern Treasury
|
258
|
-
|
259
|
-
</a>
|
260
|
-
</p>
|
261
|
-
<!-- .site-info -->
|
262
|
-
|
263
|
-
<div class="social-links">
|
264
|
-
|
265
|
-
<a class="" href="https://www.netlify.com" target="_blank" rel="noopener" >
|
266
|
-
|
267
|
-
<img src="https://www.netlify.com/img/global/badges/netlify-dark.svg" alt="Deploys by Netlify" />
|
268
|
-
|
269
|
-
</a>
|
270
|
-
<a class="button button-icon" href="https://twitter.com/ModernTreasury" target="_blank" rel="noopener" >
|
271
|
-
|
272
|
-
<span class="icon fab fa-twitter" aria-hidden="true"></span><span class="screen-reader-text">Twitter</span>
|
273
|
-
|
274
|
-
</a>
|
275
|
-
<a class="button button-icon" href="https://www.linkedin.com/company/modern-treasury" target="_blank" rel="noopener" >
|
276
|
-
|
277
|
-
<span class="icon fab fa-linkedin" aria-hidden="true"></span><span class="screen-reader-text">LinkedIn</span>
|
278
|
-
|
279
|
-
</a>
|
280
|
-
<a class="button button-icon" href="https://github.com/LedgerSync/ledger_sync" target="_blank" rel="noopener" >
|
281
|
-
|
282
|
-
<span class="icon fab fa-github" aria-hidden="true"></span><span class="screen-reader-text">GitHub</span>
|
283
|
-
|
284
|
-
</a>
|
285
|
-
</div>
|
286
|
-
<!-- .social-links -->
|
287
|
-
|
288
|
-
</div>
|
289
|
-
<!-- .site-footer-inside -->
|
290
|
-
</div>
|
291
|
-
<!-- .inner -->
|
292
|
-
</footer>
|
293
|
-
<!-- .site-footer -->
|
294
|
-
</div><!-- .site -->
|
295
|
-
|
296
|
-
<!-- Scripts -->
|
297
|
-
<script src="/assets/js/plugins.js"></script>
|
298
|
-
<script src="/assets/js/prism.js" data-manual></script>
|
299
|
-
<script src="/assets/js/main.js"></script>
|
300
|
-
</body>
|
301
|
-
|
302
|
-
</html>
|
@@ -1,335 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en">
|
3
|
-
|
4
|
-
<head>
|
5
|
-
|
6
|
-
<title>LedgerSync - Resources - 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/">Reference</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">
|
189
|
-
<a href=""></a>
|
190
|
-
</li>
|
191
|
-
|
192
|
-
|
193
|
-
</ul>
|
194
|
-
<!-- .guides-toc -->
|
195
|
-
</div>
|
196
|
-
<!-- .guides-toc-wrap -->
|
197
|
-
</div>
|
198
|
-
<!-- .guides-nav-inside -->
|
199
|
-
</nav>
|
200
|
-
<!-- .guides-nav -->
|
201
|
-
<article class="post type-guides">
|
202
|
-
<div class="post-inside">
|
203
|
-
<header class="post-header">
|
204
|
-
<h1 class="post-title line-left">Resources</h1>
|
205
|
-
</header>
|
206
|
-
<!-- .post-header -->
|
207
|
-
<div class="post-content">
|
208
|
-
<h2 id="overview">Overview</h2>
|
209
|
-
|
210
|
-
<p>Resources are named ruby objects (e.g. <code class="highlighter-rouge">Customer</code>, <code class="highlighter-rouge">Payment</code>, etc.) with strict attributes (e.g. <code class="highlighter-rouge">name</code>, <code class="highlighter-rouge">amount</code>, etc.). LedgerSync provides resources specific to each ledger. While it is possible to create your own resources (see Customization for more details), this section refers to provided ledger-specific resources.</p>
|
211
|
-
|
212
|
-
<p>The library strives to make each resource and attribute name match the ledger API. This naming convention will help you more readily match ledger documentation to LedgerSync resources.</p>
|
213
|
-
|
214
|
-
<h2 id="how-to-use">How to use</h2>
|
215
|
-
|
216
|
-
<p>Resources are primary used as the inputs and outputs of operations and searchers. A resource is passed to an operation along with a client. Once the operation is successfully performed, a duplicated and updated resource is returned.</p>
|
217
|
-
|
218
|
-
<p>Resources have two layers of validation:</p>
|
219
|
-
|
220
|
-
<ol>
|
221
|
-
<li>The Resource</li>
|
222
|
-
<li>Operations</li>
|
223
|
-
</ol>
|
224
|
-
|
225
|
-
<p>When instantiating a resource, validations are performed. These validations include class checks and, if necessary, value checks (e.g. enums). When performing an operation, validations are performed based on what attributes are required for the operation to be successful. For example, the <code class="highlighter-rouge">ledger_id</code> should be <code class="highlighter-rouge">nil</code> on <code class="highlighter-rouge">create</code>, but it should be present on <code class="highlighter-rouge">update</code>.</p>
|
226
|
-
|
227
|
-
<h2 id="available-resources">Available resources</h2>
|
228
|
-
|
229
|
-
<p>You can see all resources available for a given ledger by calling <code class="highlighter-rouge">resources</code> on the ledger’s <code class="highlighter-rouge">Client</code> like so:</p>
|
230
|
-
|
231
|
-
<p><code class="highlighter-rouge">LedgerSync::Ledgers::QuickBooksOnline::Client.resources</code></p>
|
232
|
-
|
233
|
-
<p>This returns a hash of resource types to classes, where the resource types are unique (e.g. <code class="highlighter-rouge">customer</code>, <code class="highlighter-rouge">vendor</code>, etc.).</p>
|
234
|
-
|
235
|
-
<p>You can see all resources available in LedgerSync by calling <code class="highlighter-rouge">LedgerSync.resources</code>. This returns an array (note: not a hash as multiple ledgers have the same types) of resource classes that have been created inheriting the <code class="highlighter-rouge">LedgerSync::Resource</code> class.</p>
|
236
|
-
|
237
|
-
<h2 id="resource-attributes">Resource Attributes</h2>
|
238
|
-
|
239
|
-
<p>Resources have defined attributes. Attributes are explicitly defined. An error is thrown if an unknown attribute is passed to it. You can retrieve the attributes of a resource by calling <code class="highlighter-rouge">Customer.attributes</code>.</p>
|
240
|
-
|
241
|
-
<p>A subset of these <code class="highlighter-rouge">attributes</code> may be a <code class="highlighter-rouge">reference</code>, which is simply a special type of attribute that references another resource. You can retrieve the references of a resource by calling <code class="highlighter-rouge">Customer.references</code>.</p>
|
242
|
-
|
243
|
-
<hr />
|
244
|
-
|
245
|
-
<div>Related articles:</div><br />
|
246
|
-
|
247
|
-
<ul class="guides-section-items">
|
248
|
-
|
249
|
-
<li class="guides-section-item"><a href="/reference/architecture/clients/" class="guides-item-link">Clients<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
250
|
-
|
251
|
-
<li class="guides-section-item"><a href="/reference/architecture/resources/" class="guides-item-link">Resources<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
252
|
-
|
253
|
-
<li class="guides-section-item"><a href="/reference/architecture/serialization/" class="guides-item-link">Serialization<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
254
|
-
|
255
|
-
<li class="guides-section-item"><a href="/reference/architecture/operations/" class="guides-item-link">Operations<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
256
|
-
|
257
|
-
<li class="guides-section-item"><a href="/reference/architecture/searchers/" class="guides-item-link">Operations<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
258
|
-
|
259
|
-
<li class="guides-section-item"><a href="/reference/architecture/results/" class="guides-item-link">Results<span class="icon-angle-right" aria-hidden="true"></span></a></li>
|
260
|
-
|
261
|
-
</ul>
|
262
|
-
<!-- .guides-section-pages -->
|
263
|
-
|
264
|
-
</div>
|
265
|
-
<!-- .post-content -->
|
266
|
-
</div>
|
267
|
-
<!-- .post-inside -->
|
268
|
-
</article>
|
269
|
-
<!-- .post -->
|
270
|
-
<nav id="page-nav" class="page-nav">
|
271
|
-
<div id="page-nav-inside" class="page-nav-inside sticky">
|
272
|
-
<h2 class="page-nav-title">Jump to Section</h2>
|
273
|
-
</div>
|
274
|
-
<!-- .page-nav-inside -->
|
275
|
-
</nav>
|
276
|
-
<!-- .page-nav -->
|
277
|
-
</div>
|
278
|
-
<!-- .guides-content -->
|
279
|
-
</div>
|
280
|
-
<!-- .inner-->
|
281
|
-
</main><!-- .site-content -->
|
282
|
-
<footer id="colophon" class="site-footer outer">
|
283
|
-
<div class="inner">
|
284
|
-
<div class="site-footer-inside">
|
285
|
-
<p class="site-info">
|
286
|
-
|
287
|
-
<span class="copyright">© Modern Treasury Inc. All rights reserved.</span>
|
288
|
-
<a class="" href="https://www.moderntreasury.com" target="_blank" rel="noopener" >
|
289
|
-
|
290
|
-
Maintained with ❤️ in San Francisco, CA by Modern Treasury
|
291
|
-
|
292
|
-
</a>
|
293
|
-
</p>
|
294
|
-
<!-- .site-info -->
|
295
|
-
|
296
|
-
<div class="social-links">
|
297
|
-
|
298
|
-
<a class="" href="https://www.netlify.com" target="_blank" rel="noopener" >
|
299
|
-
|
300
|
-
<img src="https://www.netlify.com/img/global/badges/netlify-dark.svg" alt="Deploys by Netlify" />
|
301
|
-
|
302
|
-
</a>
|
303
|
-
<a class="button button-icon" href="https://twitter.com/ModernTreasury" target="_blank" rel="noopener" >
|
304
|
-
|
305
|
-
<span class="icon fab fa-twitter" aria-hidden="true"></span><span class="screen-reader-text">Twitter</span>
|
306
|
-
|
307
|
-
</a>
|
308
|
-
<a class="button button-icon" href="https://www.linkedin.com/company/modern-treasury" target="_blank" rel="noopener" >
|
309
|
-
|
310
|
-
<span class="icon fab fa-linkedin" aria-hidden="true"></span><span class="screen-reader-text">LinkedIn</span>
|
311
|
-
|
312
|
-
</a>
|
313
|
-
<a class="button button-icon" href="https://github.com/LedgerSync/ledger_sync" target="_blank" rel="noopener" >
|
314
|
-
|
315
|
-
<span class="icon fab fa-github" aria-hidden="true"></span><span class="screen-reader-text">GitHub</span>
|
316
|
-
|
317
|
-
</a>
|
318
|
-
</div>
|
319
|
-
<!-- .social-links -->
|
320
|
-
|
321
|
-
</div>
|
322
|
-
<!-- .site-footer-inside -->
|
323
|
-
</div>
|
324
|
-
<!-- .inner -->
|
325
|
-
</footer>
|
326
|
-
<!-- .site-footer -->
|
327
|
-
</div><!-- .site -->
|
328
|
-
|
329
|
-
<!-- Scripts -->
|
330
|
-
<script src="/assets/js/plugins.js"></script>
|
331
|
-
<script src="/assets/js/prism.js" data-manual></script>
|
332
|
-
<script src="/assets/js/main.js"></script>
|
333
|
-
</body>
|
334
|
-
|
335
|
-
</html>
|