Skip to content

Commit f6663a9

Browse files
committed
add all new docs, and add summary only and budgets, and report changes to the accounting api
1 parent 2b71b3e commit f6663a9

File tree

17 files changed

+99079
-31
lines changed

17 files changed

+99079
-31
lines changed

doc/accounting/Api/AccountingApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6726,7 +6726,7 @@ Name | Type | Description | Notes
67266726
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
67276727

67286728
# **getInvoices**
6729-
> \XeroAPI\XeroPHP\Models\Accounting\Invoices getInvoices($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp)
6729+
> \XeroAPI\XeroPHP\Models\Accounting\Invoices getInvoices($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only)
67306730

67316731
Retrieves sales invoices or purchase bills
67326732

@@ -6755,11 +6755,11 @@ $statuses = "DRAFT", "SUBMITTED"; // string[] | Filter by a
67556755
$page = 1; // int | e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
67566756
$include_archived = True; // bool | e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response
67576757
$created_by_my_app = false; // bool | When set to true you'll only retrieve Invoices created by your app
6758-
$summary_only = true; // bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
67596758
$unitdp = 4; // int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
6759+
$summary_only = true; // bool | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
67606760

67616761
try {
6762-
$result = $apiInstance->getInvoices($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp);
6762+
$result = $apiInstance->getInvoices($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only);
67636763
print_r($result);
67646764
} catch (Exception $e) {
67656765
echo 'Exception when calling AccountingApi->getInvoices: ', $e->getMessage(), PHP_EOL;
@@ -6782,8 +6782,8 @@ Name | Type | Description | Notes
67826782
**page** | **int**| e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice | [optional]
67836783
**include_archived** | **bool**| e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response | [optional]
67846784
**created_by_my_app** | **bool**| When set to true you'll only retrieve Invoices created by your app | [optional]
6785-
**summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to false]
67866785
**unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
6786+
**summary_only** | **bool**| Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to false]
67876787

67886788
### Return type
67896789

docs/v2/accounting/index.html

Lines changed: 44047 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/assets/index.html

Lines changed: 3960 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/files/index.html

Lines changed: 5326 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/payroll_au/index.html

Lines changed: 9358 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/payroll_nz/index.html

Lines changed: 15443 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/payroll_uk/index.html

Lines changed: 15335 additions & 0 deletions
Large diffs are not rendered by default.

docs/v2/projects/index.html

Lines changed: 5579 additions & 0 deletions
Large diffs are not rendered by default.

lib/Api/AccountingApi.php

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1616
*
17-
* OpenAPI spec version: 2.13.1
17+
* OpenAPI spec version: 2.13.2
1818
* Contact: api@xero.com
1919
* Generated by: https://openapi-generator.tech
2020
* OpenAPI Generator version: 4.3.1
@@ -31832,15 +31832,15 @@ protected function getInvoiceRemindersRequest($xero_tenant_id)
3183231832
* @param int $page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
3183331833
* @param bool $include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
3183431834
* @param bool $created_by_my_app When set to true you'll only retrieve Invoices created by your app (optional)
31835-
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3183631835
* @param int $unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
31836+
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3183731837
* @throws \XeroAPI\XeroPHP\ApiException on non-2xx response
3183831838
* @throws \InvalidArgumentException
3183931839
* @return \XeroAPI\XeroPHP\Models\Accounting\Invoices
3184031840
*/
31841-
public function getInvoices($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $summary_only = false, $unitdp = null)
31841+
public function getInvoices($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $unitdp = null, $summary_only = false)
3184231842
{
31843-
list($response) = $this->getInvoicesWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp);
31843+
list($response) = $this->getInvoicesWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only);
3184431844
return $response;
3184531845
}
3184631846
/**
@@ -31857,15 +31857,15 @@ public function getInvoices($xero_tenant_id, $if_modified_since = null, $where =
3185731857
* @param int $page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
3185831858
* @param bool $include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
3185931859
* @param bool $created_by_my_app When set to true you'll only retrieve Invoices created by your app (optional)
31860-
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3186131860
* @param int $unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
31861+
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3186231862
* @throws \XeroAPI\XeroPHP\ApiException on non-2xx response
3186331863
* @throws \InvalidArgumentException
3186431864
* @return array of \XeroAPI\XeroPHP\Models\Accounting\Invoices, HTTP status code, HTTP response headers (array of strings)
3186531865
*/
31866-
public function getInvoicesWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $summary_only = false, $unitdp = null)
31866+
public function getInvoicesWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $unitdp = null, $summary_only = false)
3186731867
{
31868-
$request = $this->getInvoicesRequest($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp);
31868+
$request = $this->getInvoicesRequest($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only);
3186931869
try {
3187031870
$options = $this->createHttpClientOption();
3187131871
try {
@@ -31945,14 +31945,14 @@ public function getInvoicesWithHttpInfo($xero_tenant_id, $if_modified_since = nu
3194531945
* @param int $page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
3194631946
* @param bool $include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
3194731947
* @param bool $created_by_my_app When set to true you'll only retrieve Invoices created by your app (optional)
31948-
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3194931948
* @param int $unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
31949+
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3195031950
* @throws \InvalidArgumentException
3195131951
* @return \GuzzleHttp\Promise\PromiseInterface
3195231952
*/
31953-
public function getInvoicesAsync($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $summary_only = false, $unitdp = null)
31953+
public function getInvoicesAsync($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $unitdp = null, $summary_only = false)
3195431954
{
31955-
return $this->getInvoicesAsyncWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp)
31955+
return $this->getInvoicesAsyncWithHttpInfo($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only)
3195631956
->then(
3195731957
function ($response) {
3195831958
return $response[0];
@@ -31973,14 +31973,14 @@ function ($response) {
3197331973
* @param int $page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
3197431974
* @param bool $include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
3197531975
* @param bool $created_by_my_app When set to true you'll only retrieve Invoices created by your app (optional)
31976-
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3197731976
* @param int $unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
31977+
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3197831978
* @throws \InvalidArgumentException
3197931979
* @return \GuzzleHttp\Promise\PromiseInterface */
31980-
public function getInvoicesAsyncWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $summary_only = false, $unitdp = null)
31980+
public function getInvoicesAsyncWithHttpInfo($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $unitdp = null, $summary_only = false)
3198131981
{
3198231982
$returnType = '\XeroAPI\XeroPHP\Models\Accounting\Invoices';
31983-
$request = $this->getInvoicesRequest($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $summary_only, $unitdp);
31983+
$request = $this->getInvoicesRequest($xero_tenant_id, $if_modified_since, $where, $order, $i_ds, $invoice_numbers, $contact_i_ds, $statuses, $page, $include_archived, $created_by_my_app, $unitdp, $summary_only);
3198431984
return $this->client
3198531985
->sendAsync($request, $this->createHttpClientOption())
3198631986
->then(
@@ -32027,11 +32027,11 @@ function ($exception) {
3202732027
* @param int $page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice (optional)
3202832028
* @param bool $include_archived e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response (optional)
3202932029
* @param bool $created_by_my_app When set to true you'll only retrieve Invoices created by your app (optional)
32030-
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3203132030
* @param int $unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional)
32031+
* @param bool $summary_only Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. (optional, default to false)
3203232032
* @throws \InvalidArgumentException
3203332033
* @return \GuzzleHttp\Psr7\Request */
32034-
protected function getInvoicesRequest($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $summary_only = false, $unitdp = null)
32034+
protected function getInvoicesRequest($xero_tenant_id, $if_modified_since = null, $where = null, $order = null, $i_ds = null, $invoice_numbers = null, $contact_i_ds = null, $statuses = null, $page = null, $include_archived = null, $created_by_my_app = null, $unitdp = null, $summary_only = false)
3203532035
{
3203632036
// verify the required parameter 'xero_tenant_id' is set
3203732037
if ($xero_tenant_id === null || (is_array($xero_tenant_id) && count($xero_tenant_id) === 0)) {
@@ -32094,13 +32094,13 @@ protected function getInvoicesRequest($xero_tenant_id, $if_modified_since = null
3209432094
$queryParams['createdByMyApp'] = $created_by_my_app ? 'true' : 'false';
3209532095
}
3209632096
// query params
32097-
if ($summary_only !== null) {
32098-
$queryParams['summaryOnly'] = $summary_only ? 'true' : 'false';
32099-
}
32100-
// query params
3210132097
if ($unitdp !== null) {
3210232098
$queryParams['unitdp'] = AccountingObjectSerializer::toQueryValue($unitdp);
3210332099
}
32100+
// query params
32101+
if ($summary_only !== null) {
32102+
$queryParams['summaryOnly'] = $summary_only ? 'true' : 'false';
32103+
}
3210432104
// header params
3210532105
if ($xero_tenant_id !== null) {
3210632106
$headerParams['xero-tenant-id'] = AccountingObjectSerializer::toHeaderValue($xero_tenant_id);

lib/Api/AssetApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
1616
*
17-
* OpenAPI spec version: 2.13.1
17+
* OpenAPI spec version: 2.13.2
1818
* Contact: api@xero.com
1919
* Generated by: https://openapi-generator.tech
2020
* OpenAPI Generator version: 4.3.1

0 commit comments

Comments
 (0)