You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Sample apps can get you started quickly with simple auth flows to advanced usage
46
46
| --- | --- | --- |
47
47
| [`xero-ruby-oauth2-starter`](https://github.com/XeroAPI/Xero-ruby-oauth2-starter) | A Sinatra application showing the basic getting started code to work with the sdk | <imgsrc="https://i.imgur.com/9H4F98M.png"alt="drawing"width="300"/>
48
48
| [`xero-ruby-oauth2-app`](https://github.com/XeroAPI/Xero-ruby-oauth2-app) | Complete rails app with +95% of api set examples, complex filters, pagination, and user/token management in postgres | <imgsrc="https://i.imgur.com/XsAp9Ww.png"alt="drawing"width="500"/>
49
-
| [`xero-ruby-custom-connections-starter`](https://github.com/XeroAPI/xero-ruby-custom-connections-starter) | A getting started Sinatra app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/guides/oauth2/custom-connections) for building M2M integrations to a single org | <imgsrc="https://i.imgur.com/YEkScui.png"alt="drawing"width="300"/>
49
+
| [`xero-ruby-custom-connections-starter`](https://github.com/XeroAPI/xero-ruby-custom-connections-starter) | A getting started Sinatra app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/oauth2/custom-connections) for building M2M integrations to a single org | <imgsrc="https://i.imgur.com/YEkScui.png"alt="drawing"width="300"/>
50
50
| [`xero-ruby-sso-form`](https://github.com/XeroAPI/xero-ruby-sso-form) | A basic Sinatra app showing how to implement SSU to Lead | <imgsrc="https://i.imgur.com/Nf95GVd.png"alt="drawing"width="300"/>
summary_only: false, # Boolean | 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.
7512
7515
7513
-
search_term: 'Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7516
+
search_term: 'Joe Bloggs', # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7517
+
7518
+
page_size: 100 # Integer | Number of records to retrieve per page
7514
7519
}
7515
7520
7516
7521
begin
@@ -7536,10 +7541,11 @@ Name | Type | Description | Notes
7536
7541
**include_archived** | **Boolean**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional]
7537
7542
**summary_only** | **Boolean**| 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]
7538
7543
**search_term** | **String**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional]
7544
+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
7539
7545
7540
7546
### Return type
7541
7547
7542
-
[**Contacts**](Contacts.md)
7548
+
[**GetContactsResponse**](GetContactsResponse.md)
7543
7549
7544
7550
### Authorization
7545
7551
@@ -7950,7 +7956,7 @@ Name | Type | Description | Notes
page: 1, # Integer | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
7991
7997
7992
-
unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
7998
+
unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
7999
+
8000
+
page_size: 100 # Integer | Number of records to retrieve per page
7993
8001
}
7994
8002
7995
8003
begin
@@ -8012,10 +8020,11 @@ Name | Type | Description | Notes
8012
8020
**order** | **String**| Order by an any element | [optional]
8013
8021
**page** | **Integer**| e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | [optional]
8014
8022
**unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
8023
+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
8951
8960
8952
-
summary_only: false # Boolean | 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.
8961
+
summary_only: false, # Boolean | 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.
8962
+
8963
+
page_size: 100 # Integer | Number of records to retrieve per page
8953
8964
}
8954
8965
8955
8966
begin
@@ -8979,10 +8990,11 @@ Name | Type | Description | Notes
8979
8990
**created_by_my_app** | **Boolean**| When set to true you'll only retrieve Invoices created by your app | [optional]
8980
8991
**unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
8981
8992
**summary_only** | **Boolean**| 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]
8993
+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
8982
8994
8983
8995
### Return type
8984
8996
8985
-
[**Invoices**](Invoices.md)
8997
+
[**GetInvoicesResponse**](GetInvoicesResponse.md)
8986
8998
8987
8999
### Authorization
8988
9000
@@ -9816,7 +9828,7 @@ Name | Type | Description | Notes
order: 'Date ASC', # String | Order by an any element
9855
9867
9856
-
page: 1 # Integer | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
9868
+
page: 1, # Integer | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
9869
+
9870
+
page_size: 100 # Integer | Number of records to retrieve per page
9857
9871
}
9858
9872
9859
9873
begin
@@ -9875,10 +9889,11 @@ Name | Type | Description | Notes
9875
9889
**where** | **String**| Filter by an any element | [optional]
9876
9890
**order** | **String**| Order by an any element | [optional]
9877
9891
**page** | **Integer**| e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment | [optional]
9892
+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
order: 'PurchaseOrderNumber ASC', # String | Order by an any element
11387
11405
11388
-
page: 1 # Integer | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
11406
+
page: 1, # Integer | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
11407
+
11408
+
page_size: 100 # Integer | Number of records to retrieve per page
11389
11409
}
11390
11410
11391
11411
begin
@@ -11409,10 +11429,11 @@ Name | Type | Description | Notes
11409
11429
**date_to** | **String**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional]
11410
11430
**order** | **String**| Order by an any element | [optional]
11411
11431
**page** | **Integer**| To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. | [optional]
11432
+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
0 commit comments