Skip to content

Commit b2fa507

Browse files
authored
Merge pull request #234 from XeroAPI/reports_and_budgets_build
Add budgets endpoints, and fix the reports endpoints to be more accurate
2 parents 4370852 + f6663a9 commit b2fa507

33 files changed

+58207
-880
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.DS_Store
1+
.DS_Store
2+
.build_notes.md

doc/accounting/Api/AccountingApi.md

Lines changed: 222 additions & 108 deletions
Large diffs are not rendered by default.

doc/accounting/Model/Budget.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Budget
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**budget_id** | **string** | Xero identifier | [optional]
7+
**type** | **string** | Type of Budget. OVERALL or TRACKING | [optional]
8+
**description** | **string** | The Budget description | [optional]
9+
**updated_date_utc** | **string** | UTC timestamp of last update to budget | [optional]
10+
**budget_lines** | [**\XeroAPI\XeroPHP\Models\Accounting\BudgetLines**](BudgetLines.md) | | [optional]
11+
**tracking** | [**\XeroAPI\XeroPHP\Models\Accounting\TrackingCategory**](TrackingCategory.md) | | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# BudgetLines
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**period** | **string** | Period the amount applies to (e.g. “2019-08”) | [optional]
7+
**amount** | **int** | LineItem Quantity | [optional]
8+
**unit_amount** | **int** | Budgeted amount | [optional]
9+
**notes** | **string** | Any footnotes associated with this balance | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

doc/accounting/Model/Budgets.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Budgets
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**budgets** | [**\XeroAPI\XeroPHP\Models\Accounting\Budget[]**](Budget.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

doc/accounting/Model/LineItem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**unit_amount** | **double** | LineItem Unit Amount | [optional]
1010
**item_code** | **string** | See Items | [optional]
1111
**account_code** | **string** | See Accounts | [optional]
12+
**account_id** | **string** | The associated account ID related to this line item | [optional]
1213
**tax_type** | **string** | The tax type from TaxRates | [optional]
1314
**tax_amount** | **double** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional]
1415
**line_amount** | **double** | If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional]

doc/accounting/Model/Report.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**report_id** | **string** | See Prepayment Types | [optional]
76
**report_name** | **string** | See Prepayment Types | [optional]
87
**report_type** | **string** | See Prepayment Types | [optional]
98
**report_title** | **string** | See Prepayment Types | [optional]

doc/accounting/Model/ReportWithRow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**report_id** | **string** | Report id | [optional]
6+
**report_id** | **string** | ID of the Report | [optional]
77
**report_name** | **string** | Name of the report | [optional]
88
**report_title** | **string** | Title of the report | [optional]
99
**report_type** | **string** | The type of report (BalanceSheet,ProfitLoss, etc) | [optional]

doc/assets/Api/AssetApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ $apiInstance = new XeroAPI\XeroPHP\Api\AssetApi(
144144
$config
145145
);
146146
$xero_tenant_id = YOUR_XERO_TENANT_ID; // string | Xero identifier for Tenant
147-
$id = 4f7bcdcb-5ec1-4258-9558-19f662fccdfe; // string | fixed asset id for single object
147+
$id = 00000000-0000-0000-0000-000000000000; // string | fixed asset id for single object
148148

149149
try {
150150
$result = $apiInstance->getAssetById($xero_tenant_id, $id);

doc/payrolluk/Api/PayrollUkApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1977,9 +1977,9 @@ $apiInstance = new XeroAPI\XeroPHP\Api\PayrollUkApi(
19771977
$config
19781978
);
19791979
$xero_tenant_id = 'xero_tenant_id_example'; // string | Xero identifier for Tenant
1980-
$employee_id = 4ff1e5cc-9835-40d5-bb18-09fdb118db9c; // string | Employee id for single object
1980+
$employee_id = 00000000-0000-0000-0000-000000000000; // string | Employee id for single object
19811981
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter by start date
1982-
$end_date = Johnson; // \DateTime | Filter by end date
1982+
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter by end date
19831983

19841984
try {
19851985
$result = $apiInstance->getEmployeeLeavePeriods($xero_tenant_id, $employee_id, $start_date, $end_date);

0 commit comments

Comments
 (0)