Skip to content

Commit bcdbf1e

Browse files
RettBehrensRettBehrens
committed
regenerated docs with latest changes to spec
1 parent 502eae1 commit bcdbf1e

File tree

5 files changed

+306
-306
lines changed

5 files changed

+306
-306
lines changed

‎docs/v1/accounting/index.html‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9657,7 +9657,7 @@ <h3>Usage and SDK Samples</h3>
96579657
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
96589658
credit_note_id = '00000000-0000-0000-0000-000000000000'
96599659
file_name = 'xero-dev.jpg'
9660-
include_online = 'true'
9660+
include_online = 'True'
96619661

96629662
path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
96639663
open_file = open(path_to_upload, 'rb')
@@ -10844,7 +10844,7 @@ <h3>Usage and SDK Samples</h3>
1084410844
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
1084510845
invoice_id = '00000000-0000-0000-0000-000000000000'
1084610846
file_name = 'xero-dev.jpg'
10847-
include_online = 'true'
10847+
include_online = 'True'
1084810848

1084910849
path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
1085010850
open_file = open(path_to_upload, 'rb')
@@ -22382,8 +22382,8 @@ <h3>Usage and SDK Samples</h3>
2238222382
where = 'ContactStatus==&quot;ACTIVE&quot;'
2238322383
order = 'Name ASC'
2238422384
ids = [&quot;00000000-0000-0000-0000-000000000000&quot;]
22385-
include_archived = 'true'
22386-
summary_only = 'true'
22385+
include_archived = 'True'
22386+
summary_only = 'True'
2238722387
search_term = 'searchTerm=Joe Bloggs'
2238822388

2238922389
try:
@@ -25630,9 +25630,9 @@ <h3>Usage and SDK Samples</h3>
2563025630
invoice_numbers = [&quot;INV-001&quot;, &quot;INV-002&quot;]
2563125631
contact_ids = [&quot;00000000-0000-0000-0000-000000000000&quot;]
2563225632
statuses = [&quot;DRAFT&quot;, &quot;SUBMITTED&quot;]
25633-
include_archived = 'true'
25634-
created_by_my_app = 'false'
25635-
summary_only = 'true'
25633+
include_archived = 'True'
25634+
created_by_my_app = 'False'
25635+
summary_only = 'True'
2563625636

2563725637
try:
2563825638
api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp, summary_only)
@@ -26582,7 +26582,7 @@ <h3>Usage and SDK Samples</h3>
2658226582
api_instance = AccountingApi(api_client)
2658326583
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
2658426584
if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
26585-
payments_only = 'true'
26585+
payments_only = 'True'
2658626586

2658726587
try:
2658826588
api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, payments_only)
@@ -34633,8 +34633,8 @@ <h3>Usage and SDK Samples</h3>
3463334633
timeframe = 'MONTH'
3463434634
tracking_option_id_1 = '00000000-0000-0000-0000-000000000000'
3463534635
tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
34636-
standard_layout = 'true'
34637-
payments_only = 'false'
34636+
standard_layout = 'True'
34637+
payments_only = 'False'
3463834638

3463934639
try:
3464034640
api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date, periods, timeframe, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only)
@@ -35430,8 +35430,8 @@ <h3>Usage and SDK Samples</h3>
3543035430
tracking_category_id_2 = '00000000-0000-0000-0000-000000000000'
3543135431
tracking_option_id = '00000000-0000-0000-0000-000000000000'
3543235432
tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
35433-
standard_layout = 'true'
35434-
payments_only = 'false'
35433+
standard_layout = 'True'
35434+
payments_only = 'False'
3543535435

3543635436
try:
3543735437
api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, timeframe, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only)
@@ -35859,7 +35859,7 @@ <h3>Usage and SDK Samples</h3>
3585935859
api_instance = AccountingApi(api_client)
3586035860
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
3586135861
date = dateutil.parser.parse("2019-10-31")
35862-
payments_only = 'true'
35862+
payments_only = 'True'
3586335863

3586435864
try:
3586535865
api_response = api_instance.get_report_trial_balance(xero_tenant_id, date, payments_only)
@@ -36257,7 +36257,7 @@ <h3>Usage and SDK Samples</h3>
3625736257
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
3625836258
where = 'Status=="ACTIVE"'
3625936259
order = 'Name ASC'
36260-
include_archived = 'true'
36260+
include_archived = 'True'
3626136261

3626236262
try:
3626336263
api_response = api_instance.get_tracking_categories(xero_tenant_id, where, order, include_archived)

‎docs/v1/assets/index.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1459,15 +1459,15 @@ <h3>Usage and SDK Samples</h3>
14591459

14601460
def accounting_create_asset():
14611461
api_instance = AssetApi(api_client)
1462-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1462+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
14631463

14641464
asset = Asset(
14651465
asset_name = "Other Computer",
14661466
asset_number = "FA-00210",
14671467
status = "Draft")
14681468

14691469
try:
1470-
api_response = api_instance.create_asset(xeroTenantId, asset)
1470+
api_response = api_instance.create_asset(xero_tenant_id, asset)
14711471
print(api_response)
14721472
except AccountingBadRequestException as e:
14731473
print("Exception when calling AssetApi->createAsset: %s\n" % e)</code></pre>
@@ -1591,7 +1591,7 @@ <h3>Usage and SDK Samples</h3>
15911591

15921592
def accounting_create_asset_type():
15931593
api_instance = AssetApi(api_client)
1594-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1594+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
15951595

15961596
bookDepreciationSetting = BookDepreciationSetting(
15971597
depreciation_method = "DiminishingValue100",
@@ -1607,7 +1607,7 @@ <h3>Usage and SDK Samples</h3>
16071607
bookDepreciationSetting = book_depreciation_setting)
16081608

16091609
try:
1610-
api_response = api_instance.create_asset_type(xeroTenantId, assetType)
1610+
api_response = api_instance.create_asset_type(xero_tenant_id, assetType)
16111611
print(api_response)
16121612
except AccountingBadRequestException as e:
16131613
print("Exception when calling AssetApi->createAssetType: %s\n" % e)</code></pre>
@@ -1728,11 +1728,11 @@ <h3>Usage and SDK Samples</h3>
17281728

17291729
def accounting_get_asset_by_id():
17301730
api_instance = AssetApi(api_client)
1731-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1731+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
17321732
id = '00000000-0000-0000-0000-000000000000'
17331733

17341734
try:
1735-
api_response = api_instance.get_asset_by_id(xeroTenantId, id)
1735+
api_response = api_instance.get_asset_by_id(xero_tenant_id, id)
17361736
print(api_response)
17371737
except AccountingBadRequestException as e:
17381738
print("Exception when calling AssetApi->getAssetById: %s\n" % e)</code></pre>
@@ -1857,10 +1857,10 @@ <h3>Usage and SDK Samples</h3>
18571857

18581858
def accounting_get_asset_settings():
18591859
api_instance = AssetApi(api_client)
1860-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1860+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
18611861

18621862
try:
1863-
api_response = api_instance.get_asset_settings(xeroTenantId)
1863+
api_response = api_instance.get_asset_settings(xero_tenant_id)
18641864
print(api_response)
18651865
except AccountingBadRequestException as e:
18661866
print("Exception when calling AssetApi->getAssetSettings: %s\n" % e)</code></pre>
@@ -1952,10 +1952,10 @@ <h3>Usage and SDK Samples</h3>
19521952

19531953
def accounting_get_asset_types():
19541954
api_instance = AssetApi(api_client)
1955-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1955+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
19561956

19571957
try:
1958-
api_response = api_instance.get_asset_types(xeroTenantId)
1958+
api_response = api_instance.get_asset_types(xero_tenant_id)
19591959
print(api_response)
19601960
except AccountingBadRequestException as e:
19611961
print("Exception when calling AssetApi->getAssetTypes: %s\n" % e)</code></pre>
@@ -2047,13 +2047,13 @@ <h3>Usage and SDK Samples</h3>
20472047

20482048
def accounting_get_assets():
20492049
api_instance = AssetApi(api_client)
2050-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
2051-
orderBy = 'AssetName'
2052-
sortDirection = 'ASC'
2053-
filterBy = 'Company Car'
2050+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
2051+
order_by = 'AssetName'
2052+
sort_direction = 'ASC'
2053+
filter_by = 'Company Car'
20542054

20552055
try:
2056-
api_response = api_instance.get_assets(xeroTenantId, status, page, pageSize, orderBy, sortDirection, filterBy)
2056+
api_response = api_instance.get_assets(xero_tenant_id, status, page, page_size, order_by, sort_direction, filter_by)
20572057
print(api_response)
20582058
except AccountingBadRequestException as e:
20592059
print("Exception when calling AssetApi->getAssets: %s\n" % e)</code></pre>

‎docs/v1/finance/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3308,7 +3308,7 @@ <h3>Usage and SDK Samples</h3>
33083308
bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
33093309
from_date = '2020-07-01'
33103310
to_date = '2021-06-30'
3311-
summary_only = 'true'
3311+
summary_only = 'True'
33123312

33133313
try:
33143314
api_response = api_instance.get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only)
@@ -3950,7 +3950,7 @@ <h3>Usage and SDK Samples</h3>
39503950
api_instance = FinanceApi(api_client)
39513951
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
39523952
contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
3953-
include_manual_journals = 'true'
3953+
include_manual_journals = 'True'
39543954
start_date = '2020-09-15'
39553955
end_date = '2020-09-15'
39563956

@@ -4146,7 +4146,7 @@ <h3>Usage and SDK Samples</h3>
41464146
api_instance = FinanceApi(api_client)
41474147
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
41484148
contact_ids = [["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"]]
4149-
include_manual_journals = 'true'
4149+
include_manual_journals = 'True'
41504150
start_date = '2020-09-15'
41514151
end_date = '2020-09-15'
41524152

0 commit comments

Comments
 (0)