Skip to content

Commit 1bad0d5

Browse files
authored
Merge pull request #429 from XeroAPI/openapi-spec-2.2.4
Openapi spec 2.2.4
2 parents ab8a9c5 + a5b76b9 commit 1bad0d5

File tree

338 files changed

+640
-1073
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

338 files changed

+640
-1073
lines changed

docs/v4/accounting/index.html

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5973,7 +5973,7 @@ <h1>Accounting API</h1>
59735973
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
59745974
<div class="app-desc">Version: 1.0.0</div>
59755975
<!--
5976-
<div class="app-desc">Version: 2.2.2</div>
5976+
<div class="app-desc">Version: 2.2.4</div>
59775977
<hr>
59785978
<div id="app-description" class="app-desc">
59795979
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -15034,7 +15034,7 @@ <h3>Usage and SDK Samples</h3>
1503415034

1503515035
<div class="tab-content">
1503615036
<div class="tab-pane active" id="examples-Accounting-createCreditNoteAllocation-0-curl">
15037-
<pre class="prettyprint"><code class="language-bsh">curl -X "https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations"</code></pre>
15037+
<pre class="prettyprint"><code class="language-bsh">curl -X "https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations?summarizeErrors=true"</code></pre>
1503815038
</div>
1503915039
<div class="tab-pane" id="examples-Accounting-createCreditNoteAllocation-0-java">
1504015040
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
@@ -15058,8 +15058,9 @@ <h3>Usage and SDK Samples</h3>
1505815058
String xeroTenantId = YOUR_XERO_TENANT_ID; // String | Xero identifier for Tenant
1505915059
UUID creditNoteID = 00000000-0000-0000-000-000000000000; // UUID | Unique identifier for a Credit Note
1506015060
Allocations allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] }; // Allocations |
15061+
Boolean summarizeErrors = true; // Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors
1506115062
try {
15062-
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations);
15063+
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, summarizeErrors);
1506315064
System.out.println(result);
1506415065
} catch (ApiException e) {
1506515066
System.err.println("Exception when calling AccountingApi#createCreditNoteAllocation");
@@ -15079,8 +15080,9 @@ <h3>Usage and SDK Samples</h3>
1507915080
String xeroTenantId = YOUR_XERO_TENANT_ID; // String | Xero identifier for Tenant
1508015081
UUID creditNoteID = 00000000-0000-0000-000-000000000000; // UUID | Unique identifier for a Credit Note
1508115082
Allocations allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] }; // Allocations |
15083+
Boolean summarizeErrors = true; // Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors
1508215084
try {
15083-
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations);
15085+
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, summarizeErrors);
1508415086
System.out.println(result);
1508515087
} catch (ApiException e) {
1508615088
System.err.println("Exception when calling AccountingApi#createCreditNoteAllocation");
@@ -15102,13 +15104,15 @@ <h3>Usage and SDK Samples</h3>
1510215104
String *xeroTenantId = YOUR_XERO_TENANT_ID; // Xero identifier for Tenant (default to null)
1510315105
UUID *creditNoteID = 00000000-0000-0000-000-000000000000; // Unique identifier for a Credit Note (default to null)
1510415106
Allocations *allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] }; //
15107+
Boolean *summarizeErrors = true; // If false return 200 OK and mix of successfully created obejcts and any with validation errors (optional) (default to false)
1510515108

1510615109
AccountingApi *apiInstance = [[AccountingApi alloc] init];
1510715110

1510815111
// Allows you to create Allocation on CreditNote
1510915112
[apiInstance createCreditNoteAllocationWith:xeroTenantId
1511015113
creditNoteID:creditNoteID
1511115114
allocations:allocations
15115+
summarizeErrors:summarizeErrors
1511215116
completionHandler: ^(Allocations output, NSError* error) {
1511315117
if (output) {
1511415118
NSLog(@"%@", output);
@@ -15134,8 +15138,10 @@ <h3>Usage and SDK Samples</h3>
1513415138
const xeroTenantId = "YOUR_XERO_TENANT_ID"; // {String} Xero identifier for Tenant
1513515139
const creditNoteID = "00000000-0000-0000-000-000000000000"; // {UUID} Unique identifier for a Credit Note
1513615140
const allocations:Allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] }; // {Allocations}
15141+
const summarizeErrors = true; // {Boolean} If false return 200 OK and mix of successfully created obejcts and any with validation errors
15142+
1513715143
try {
15138-
const response: any = await xero.accountingApi.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations);
15144+
const response: any = await xero.accountingApi.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, summarizeErrors);
1513915145
console.log(response.body || response.response.statusCode)
1514015146
} catch (err) {
1514115147
console.log(`There was an ERROR! \n Status Code: ${err.response.statusCode}.`);
@@ -15158,7 +15164,7 @@ <h3>Usage and SDK Samples</h3>
1515815164
console.log('API called successfully. Returned data: ' + data);
1515915165
}
1516015166
};
15161-
api.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, callback);
15167+
api.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, opts, callback);
1516215168
--></code></pre>
1516315169
</div>
1516415170

@@ -15186,11 +15192,12 @@ <h3>Usage and SDK Samples</h3>
1518615192
var xeroTenantId = YOUR_XERO_TENANT_ID; // String | Xero identifier for Tenant (default to null)
1518715193
var creditNoteID = new UUID(); // UUID | Unique identifier for a Credit Note (default to null)
1518815194
var allocations = new Allocations(); // Allocations |
15195+
var summarizeErrors = true; // Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors (optional) (default to false)
1518915196

1519015197
try
1519115198
{
1519215199
// Allows you to create Allocation on CreditNote
15193-
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations);
15200+
Allocations result = apiInstance.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, summarizeErrors);
1519415201
Debug.WriteLine(result);
1519515202
}
1519615203
catch (Exception e)
@@ -15238,9 +15245,10 @@ <h3>Usage and SDK Samples</h3>
1523815245
my $xeroTenantId = YOUR_XERO_TENANT_ID; # String | Xero identifier for Tenant
1523915246
my $creditNoteID = 00000000-0000-0000-000-000000000000; # UUID | Unique identifier for a Credit Note
1524015247
my $allocations = ::Object::Allocations->new(); # Allocations |
15248+
my $summarizeErrors = true; # Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors
1524115249

1524215250
eval {
15243-
my $result = $api_instance->createCreditNoteAllocation(xeroTenantId => $xeroTenantId, creditNoteID => $creditNoteID, allocations => $allocations);
15251+
my $result = $api_instance->createCreditNoteAllocation(xeroTenantId => $xeroTenantId, creditNoteID => $creditNoteID, allocations => $allocations, summarizeErrors => $summarizeErrors);
1524415252
print Dumper($result);
1524515253
};
1524615254
if ($@) {
@@ -15263,10 +15271,11 @@ <h3>Usage and SDK Samples</h3>
1526315271
xeroTenantId = YOUR_XERO_TENANT_ID # String | Xero identifier for Tenant (default to null)
1526415272
creditNoteID = 00000000-0000-0000-000-000000000000 # UUID | Unique identifier for a Credit Note (default to null)
1526515273
allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] } # Allocations |
15274+
summarizeErrors = true # Boolean | If false return 200 OK and mix of successfully created obejcts and any with validation errors (optional) (default to false)
1526615275

1526715276
try:
1526815277
# Allows you to create Allocation on CreditNote
15269-
api_response = api_instance.create_credit_note_allocation(xeroTenantId, creditNoteID, allocations)
15278+
api_response = api_instance.create_credit_note_allocation(xeroTenantId, creditNoteID, allocations, summarizeErrors=summarizeErrors)
1527015279
pprint(api_response)
1527115280
except ApiException as e:
1527215281
print("Exception when calling AccountingApi->createCreditNoteAllocation: %s\n" % e)</code></pre>
@@ -15279,9 +15288,10 @@ <h3>Usage and SDK Samples</h3>
1527915288
let xeroTenantId = YOUR_XERO_TENANT_ID; // String
1528015289
let creditNoteID = 00000000-0000-0000-000-000000000000; // UUID
1528115290
let allocations = { allocations:[ { amount:1.0, date:"2019-03-05", invoice:{ invoiceID:"c45720a1-ade3-4a38-a064-d15489be6841", lineItems:[], type: Invoice.TypeEnum.ACCPAY, contact:{} } } ] }; // Allocations
15291+
let summarizeErrors = true; // Boolean
1528215292

1528315293
let mut context = AccountingApi::Context::default();
15284-
let result = client.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, &context).wait();
15294+
let result = client.createCreditNoteAllocation(xeroTenantId, creditNoteID, allocations, summarizeErrors, &context).wait();
1528515295
println!("{:?}", result);
1528615296

1528715297
}
@@ -15415,6 +15425,33 @@ <h2>Parameters</h2>
1541515425
</table>
1541615426

1541715427

15428+
<div class="methodsubtabletitle">Query parameters</div>
15429+
<table id="methodsubtable">
15430+
<tr>
15431+
<th width="150px">Name</th>
15432+
<th>Description</th>
15433+
</tr>
15434+
<tr><td style="width:150px;">summarizeErrors</td>
15435+
<td>
15436+
15437+
15438+
<div id="d2e199_createCreditNoteAllocation_summarizeErrors">
15439+
<div class="json-schema-view">
15440+
<div class="primitive">
15441+
<span class="type">
15442+
Boolean
15443+
</span>
15444+
15445+
<div class="inner description marked">
15446+
If false return 200 OK and mix of successfully created obejcts and any with validation errors
15447+
</div>
15448+
</div>
15449+
</div>
15450+
</div>
15451+
</td>
15452+
</tr>
15453+
15454+
</table>
1541815455
<!--
1541915456
<h2>Responses</h2>
1542015457
<h3 id="examples-Accounting-createCreditNoteAllocation-title-200"></h3>

docs/v4/assets/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1299,7 +1299,7 @@ <h1>Xero Assets API</h1>
12991299
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
13001300
<div class="app-desc">Version: 1.0.0</div>
13011301
<!--
1302-
<div class="app-desc">Version: 2.2.1</div>
1302+
<div class="app-desc">Version: 2.2.4</div>
13031303
<hr>
13041304
<div id="app-description" class="app-desc">
13051305
This is the Xero Assets API

docs/v4/bankfeeds/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1185,7 +1185,7 @@ <h1>Bank Feeds API</h1>
11851185
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
11861186
<div class="app-desc">Version: 1.0.0</div>
11871187
<!--
1188-
<div class="app-desc">Version: 2.2.2</div>
1188+
<div class="app-desc">Version: 2.2.4</div>
11891189
<hr>
11901190
<div id="app-description" class="app-desc">
11911191
This specifing endpoints Xero Bank feeds API

docs/v4/payroll-au/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3165,7 +3165,7 @@ <h1>Xero Payroll AU</h1>
31653165
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
31663166
<div class="app-desc">Version: 1.0.0</div>
31673167
<!--
3168-
<div class="app-desc">Version: 2.2.2</div>
3168+
<div class="app-desc">Version: 2.2.4</div>
31693169
<hr>
31703170
<div id="app-description" class="app-desc">
31713171
This is the Xero Payroll API for orgs in Australia region.

docs/v4/payroll-uk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3600,7 +3600,7 @@ <h1>Xero Payroll UK</h1>
36003600
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
36013601
<div class="app-desc">Version: 1.0.0</div>
36023602
<!--
3603-
<div class="app-desc">Version: 2.2.2</div>
3603+
<div class="app-desc">Version: 2.2.4</div>
36043604
<hr>
36053605
<div id="app-description" class="app-desc">
36063606
This is the Xero Payroll API for orgs in the UK region.

docs/v4/projects/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1410,7 +1410,7 @@ <h1>Xero Projects API</h1>
14101410
<h2 id="welcome-to-apidoc">API and SDK Documentation</h2>
14111411
<div class="app-desc">Version: 1.0.0</div>
14121412
<!--
1413-
<div class="app-desc">Version: 2.2.2</div>
1413+
<div class="app-desc">Version: 2.2.4</div>
14141414
<hr>
14151415
<div id="app-description" class="app-desc">
14161416
This is the Xero Projects API

0 commit comments

Comments
 (0)