Parameters

Query parameters

+ + + + + + + + + +

Name	Description
summarizeErrors	+ + + + + + + Boolean + + + +If false return 200 OK and mix of successfully created objects and any with validation errors + + + + +

createTrackingCategory

Create tracking categories

createTaxRates

Creates one or more tax rates

@@ -15884,17 +17129,17 @@

createTrackingCategory

/TrackingCategories

/TaxRates

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -15908,18 +17153,181 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_tracking_category():
+def accounting_create_tax_rates():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
 
-    trackingCategory = TrackingCategory(
-        name = "Foobar")
+    tax_component = TaxComponent(
+        name = "State Tax",
+        rate = 2.25)
+    
+    taxComponent = []    
+    tax_components.append(tax_component)
+
+    tax_rate = TaxRate(
+        name = "CA State Tax",
+        taxComponents = taxComponents,
+
+    taxRates = TaxRates( 
+        tax_rates = [tax_rate])
     
     try:
-        api_response = api_instance.create_tracking_category(xero_tenant_id, trackingCategory)
+        api_response = api_instance.create_tax_rates(xero_tenant_id, taxRates, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->createTrackingCategory: %s\n" % e)

+ print("Exception when calling AccountingApi->createTaxRates: %s\n" % e) +

Scopes

+ + + + + + + +

accounting.settings

Grant read-write access to organisation and account settings

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
taxRates *	+ + + + TaxRates + + + TaxRates array with TaxRate object in body of request + + + + Required + + + +

createTrackingCategory

Create tracking categories

+
+

/TrackingCategories

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_tracking_category():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
+
+    trackingCategory = TrackingCategory(
+        name = "Foobar")
+    
+    try:
+        api_response = api_instance.create_tracking_category(xero_tenant_id, trackingCategory, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->createTrackingCategory: %s\n" % e)

Scopes

@@ -15959,6 +17367,26 @@

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Parameters

deleteContactGroupContact

Deletes a specific contact from a contact group using a unique contact Id

deleteBatchPayment

Updates a specific batch payment for invoices and credit notes

@@ -16302,17 +17751,17 @@

deleteContactGroupContact

/ContactGroups/{ContactGroupID}/Contacts/{ContactID}

/BatchPayments

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16326,50 +17775,51 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_contact_group_contact():
+def accounting_delete_batch_payment():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    contact_group_id = '00000000-0000-0000-0000-000000000000'
-    contact_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    batchPaymentDelete = BatchPaymentDelete(
+        status = "DELETED")
+        batch_payment_id = "00000000-0000-0000-0000-000000000000")
     
     try:
-        api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
+        api_response = api_instance.delete_batch_payment(xero_tenant_id, batchPaymentDelete, idempotency_key)
+        print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteContactGroupContact: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteBatchPayment: %s\n" % e)

Scopes

- - + +

accounting.contacts

Grant read-write access to contacts and contact groups

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

Header parameters

- + - +

Name	Description
ContactGroupID*
xero-tenant-id*	- + - UUID + String - - (uuid) - -Unique identifier for a Contact Group +Xero identifier for Tenant @@ -16380,71 +17830,71 @@ Parameters
ContactID*
Idempotency-Key	- + - UUID + String - - (uuid) - -Unique identifier for a Contact +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - Required -

Header parameters

Body parameters

- - + + - - +

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - +
batchPaymentDelete *	+ + + + BatchPaymentDelete + + + + + + Required + -

deleteContactGroupContacts

Deletes all contacts from a specific contact group

deleteBatchPaymentByUrlParam

Updates a specific batch payment for invoices and credit notes

@@ -16452,17 +17902,17 @@

deleteContactGroupContacts

/ContactGroups/{ContactGroupID}/Contacts

/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16476,23 +17926,25 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_contact_group_contacts():
+def accounting_delete_batch_payment_by_url_param():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    contact_group_id = '00000000-0000-0000-0000-000000000000'
+    batch_payment_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
     
     try:
-        api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
+        api_response = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batchPaymentDeleteByUrlParam, idempotency_key)
+        print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteContactGroupContacts: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteBatchPaymentByUrlParam: %s\n" % e)

Scopes

- - + +

accounting.contacts

Grant read-write access to contacts and contact groups

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

@@ -16503,11 +17955,11 @@

Parameters

Name Description - ContactGroupID* + BatchPaymentID* -

@@ -16518,7 +17970,7 @@

Parameters

-Unique identifier for a Contact Group +Unique identifier for BatchPayment

@@ -16540,7 +17992,7 @@

Parameters

@@ -16559,15 +18011,71 @@

Parameters

+ Idempotency-Key + + + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

+ + + + +

Body parameters

+ + + + + + + +

Name	Description
batchPaymentDeleteByUrlParam *	+ + + + BatchPaymentDeleteByUrlParam + + + + + + + Required + + +

deleteItem

Deletes a specific item

deleteContactGroupContact

Deletes a specific contact from a contact group using a unique contact Id

@@ -16575,17 +18083,17 @@

deleteItem

/Items/{ItemID}

/ContactGroups/{ContactGroupID}/Contacts/{ContactID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16599,23 +18107,24 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_item():
+def accounting_delete_contact_group_contact():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    item_id = '00000000-0000-0000-0000-000000000000'
+    contact_group_id = '00000000-0000-0000-0000-000000000000'
+    contact_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_instance.delete_item(xero_tenant_id, item_id)
+        api_instance.delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteItem: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteContactGroupContact: %s\n" % e)

Scopes

- - + +

accounting.settings

Grant read-write access to organisation and account settings

accounting.contacts

Grant read-write access to contacts and contact groups

@@ -16626,11 +18135,11 @@

Parameters

Name Description - ItemID* + ContactGroupID* -

@@ -16641,7 +18150,33 @@

Parameters

-Unique identifier for an Item +Unique identifier for a Contact Group +

+ Required +

+ + + + ContactID* + + + +

+ + UUID + + + (uuid) + + +

+Unique identifier for a Contact

@@ -16663,7 +18198,7 @@

Parameters

@@ -16686,11 +18221,11 @@

Parameters

deleteLinkedTransaction

Deletes a specific linked transactions (billable expenses)

deleteContactGroupContacts

Deletes all contacts from a specific contact group

@@ -16698,17 +18233,17 @@

deleteLinkedTransaction

/LinkedTransactions/{LinkedTransactionID}

/ContactGroups/{ContactGroupID}/Contacts

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16722,23 +18257,23 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_linked_transaction():
+def accounting_delete_contact_group_contacts():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    linked_transaction_id = '00000000-0000-0000-0000-000000000000'
+    contact_group_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id)
+        api_instance.delete_contact_group_contacts(xero_tenant_id, contact_group_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteLinkedTransaction: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteContactGroupContacts: %s\n" % e)

Scopes

- - + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

accounting.contacts

Grant read-write access to contacts and contact groups

@@ -16749,11 +18284,11 @@

Parameters

Name Description - LinkedTransactionID* + ContactGroupID* -

@@ -16764,7 +18299,7 @@

Parameters

-Unique identifier for a LinkedTransaction +Unique identifier for a Contact Group

@@ -16786,7 +18321,7 @@

Parameters

@@ -16809,11 +18344,11 @@

Parameters

deletePayment

Updates a specific payment for invoices and credit notes

deleteCreditNoteAllocations

Deletes an Allocation from a Credit Note

@@ -16821,17 +18356,17 @@

deletePayment

/Payments/{PaymentID}

/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -16845,19 +18380,17 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_payment():
+def accounting_delete_credit_note_allocations():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    payment_id = '00000000-0000-0000-0000-000000000000'
-
-    paymentDelete = PaymentDelete(
-        status = "DELETED")
+    credit_note_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.delete_payment(xero_tenant_id, payment_id, paymentDelete)
+        api_response = api_instance.delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deletePayment: %s\n" % e)

Parameters

Body parameters

- - - - - - - -

Name	Description
paymentDelete *	- - - - PaymentDelete - - - - - - - Required - - - -

deleteTrackingCategory

Deletes a specific tracking category

deleteItem

Deletes a specific item

@@ -16984,17 +18507,17 @@

deleteTrackingCategory

/TrackingCategories/{TrackingCategoryID}

/Items/{ItemID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17008,16 +18531,15 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_tracking_category():
+def accounting_delete_item():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    item_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id)
-        print(api_response)
+        api_instance.delete_item(xero_tenant_id, item_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteTrackingCategory: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteItem: %s\n" % e)

Scopes

@@ -17036,11 +18558,11 @@

Parameters

Name Description - TrackingCategoryID* + ItemID* -

@@ -17051,7 +18573,7 @@

Parameters

-Unique identifier for a TrackingCategory +Unique identifier for an Item

@@ -17073,7 +18595,7 @@

Parameters

@@ -17096,11 +18618,11 @@

Parameters

deleteTrackingOptions

Deletes a specific option for a specific tracking category

deleteLinkedTransaction

Deletes a specific linked transactions (billable expenses)

@@ -17108,17 +18630,17 @@

deleteTrackingOptions

/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

/LinkedTransactions/{LinkedTransactionID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -17132,25 +18654,23 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_tracking_options():
+def accounting_delete_linked_transaction():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    tracking_category_id = '00000000-0000-0000-0000-000000000000'
-    tracking_option_id = '00000000-0000-0000-0000-000000000000'
+    linked_transaction_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id)
-        print(api_response)
+        api_instance.delete_linked_transaction(xero_tenant_id, linked_transaction_id)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->deleteTrackingOptions: %s\n" % e)

+ print("Exception when calling AccountingApi->deleteLinkedTransaction: %s\n" % e)

Scopes

- - + +

accounting.settings

Grant read-write access to organisation and account settings

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

@@ -17161,37 +18681,11 @@

Parameters

Name Description - TrackingCategoryID* - - - -

- - UUID - - - (uuid) - - -

-Unique identifier for a TrackingCategory -

- Required -

- - - - TrackingOptionID* + LinkedTransactionID* -

@@ -17202,7 +18696,7 @@

Parameters

-Unique identifier for a Tracking Option +Unique identifier for a LinkedTransaction

@@ -17224,7 +18718,768 @@

Parameters

+ + String + + +

+Xero identifier for Tenant +

+ Required +

+ + + + +

deleteOverpaymentAllocations

Deletes an Allocation from an overpayment

+
+

/Overpayments/{OverpaymentID}/Allocations/{AllocationID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_overpayment_allocations():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    overpayment_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteOverpaymentAllocations: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
OverpaymentID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a Overpayment + + + + Required + + + +
AllocationID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for Allocation object + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

deletePayment

Updates a specific payment for invoices and credit notes

+
+

/Payments/{PaymentID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_payment():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    payment_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    paymentDelete = PaymentDelete(
+        status = "DELETED")
+    
+    try:
+        api_response = api_instance.delete_payment(xero_tenant_id, payment_id, paymentDelete, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deletePayment: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
PaymentID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a Payment + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
paymentDelete *	+ + + + PaymentDelete + + + + + + + Required + + + +

deletePrepaymentAllocations

Deletes an Allocation from a Prepayment

+
+

/Prepayments/{PrepaymentID}/Allocations/{AllocationID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_prepayment_allocations():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    prepayment_id = '00000000-0000-0000-0000-000000000000'
+    allocation_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deletePrepaymentAllocations: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
PrepaymentID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a PrePayment + + + + Required + + + +
AllocationID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for Allocation object + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

deleteTrackingCategory

Deletes a specific tracking category

+
+

/TrackingCategories/{TrackingCategoryID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_tracking_category():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_tracking_category(xero_tenant_id, tracking_category_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteTrackingCategory: %s\n" % e)

Scopes

+ + + + + + + +

accounting.settings

Grant read-write access to organisation and account settings

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TrackingCategoryID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a TrackingCategory + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

deleteTrackingOptions

Deletes a specific option for a specific tracking category

+
+

/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_tracking_options():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    tracking_category_id = '00000000-0000-0000-0000-000000000000'
+    tracking_option_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteTrackingOptions: %s\n" % e)

Scopes

+ + + + + + + +

accounting.settings

Grant read-write access to organisation and account settings

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
TrackingCategoryID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a TrackingCategory + + + + Required + + + +
TrackingOptionID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a Tracking Option + + + + Required + + + +

Header parameters

+ + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + @@ -17287,11 +19542,12 @@ Usage and SDK Samples api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' invoice_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' requestEmpty = RequestEmpty() try: - api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty) + api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty, idempotency_key) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->emailInvoice: %s\n" % e) @@ -17366,6 +19622,26 @@ Parameters
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Name

Description

xero-tenant-id*

+ + +

@@ -17287,11 +19542,12 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' invoice_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' requestEmpty = RequestEmpty() try: - api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty) + api_instance.email_invoice(xero_tenant_id, invoice_id, requestEmpty, idempotency_key) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->emailInvoice: %s\n" % e)

@@ -17366,6 +19622,26 @@

Parameters

Idempotency-Key

+ + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

@@ -19476,11 +21752,191 @@

Parameters

getBankTransferAttachmentById

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

+
+

/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_bank_transfer_attachment_by_id():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    attachment_id = '00000000-0000-0000-0000-000000000000'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getBankTransferAttachmentById: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

accounting.attachments	Grant read-write access to attachments
accounting.attachments.read	Grant read-only access to attachments

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
BankTransferID*	+ + + + + + + UUID + + + (uuid) + + + +Xero generated unique identifier for a bank transfer + + + + Required + + + +
AttachmentID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for Attachment object + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
contentType*	+ + + + + + + String + + + +The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf + + + + Required + + + +

getBankTransferAttachmentById

Retrieves a specific attachment from a specific bank transfer using a unique attachment ID

getBankTransferAttachments

Retrieves attachments from a specific bank transfer

@@ -19488,17 +21944,17 @@

getBankTransferAttachmentById

/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}

/BankTransfers/{BankTransferID}/Attachments

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19512,18 +21968,16 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_attachment_by_id():
+def accounting_get_bank_transfer_attachments():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-    attachment_id = '00000000-0000-0000-0000-000000000000'
-    content_type = 'image/jpg'
     
     try:
-        api_response = api_instance.get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type)
+        api_response = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferAttachmentById: %s\n" % e)

-The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf -

- Required -

getBankTransferAttachments

Retrieves attachments from a specific bank transfer

getBankTransferHistory

Retrieves history from a specific bank transfer using a unique bank transfer Id

@@ -19668,17 +22073,17 @@

getBankTransferAttachments

/BankTransfers/{BankTransferID}/Attachments

/BankTransfers/{BankTransferID}/History

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19692,29 +22097,29 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_attachments():
+def accounting_get_bank_transfer_history():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
     bank_transfer_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id)
+        api_response = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferAttachments: %s\n" % e)

+ print("Exception when calling AccountingApi->getBankTransferHistory: %s\n" % e)

Scopes

- - + + - - + +

accounting.attachments	Grant read-write access to attachments	accounting.transactions	Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.attachments.read	Grant read-only access to attachments	accounting.transactions.read	Grant read-only access to invoices

@@ -19729,7 +22134,7 @@

Parameters

@@ -19762,7 +22167,7 @@

Parameters

@@ -19785,11 +22190,11 @@

Parameters

getBankTransferHistory

Retrieves history from a specific bank transfer using a unique bank transfer Id

getBankTransfers

Retrieves all bank transfers

@@ -19797,17 +22202,17 @@

getBankTransferHistory

/BankTransfers/{BankTransferID}/History

/BankTransfers

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19821,16 +22226,18 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfer_history():
+def accounting_get_bank_transfers():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'HasAttachments==true'
+    order = 'Amount ASC'
     
     try:
-        api_response = api_instance.get_bank_transfer_history(xero_tenant_id, bank_transfer_id)
+        api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransferHistory: %s\n" % e)

+ print("Exception when calling AccountingApi->getBankTransfers: %s\n" % e)

Scopes

@@ -19848,28 +22255,25 @@

Scopes

Parameters

Path parameters

Header parameters

- + + + + +

Name	Description
BankTransferID*
xero-tenant-id*	- + - UUID + String - - (uuid) - -Xero generated unique identifier for a bank transfer +Xero identifier for Tenant @@ -19878,20 +22282,43 @@ Parameters
If-Modified-Since	+ + + + + + + Date + + + (date-time) + + + +Only records created or modified since this timestamp will be returned + + + + +

Header parameters

Query parameters

- + + + + + @@ -19914,11 +22358,11 @@

Parameters

getBankTransfers

Retrieves all bank transfers

getBatchPayment

Retrieves a specific batch payment using a unique batch payment Id

@@ -19926,17 +22370,17 @@

getBankTransfers

/BankTransfers

/BatchPayments/{BatchPaymentID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -19950,18 +22394,16 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_bank_transfers():
+def accounting_get_batch_payment():
     api_instance = AccountingApi(api_client)
     xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
-    where = 'HasAttachments==true'
-    order = 'Amount ASC'
+    batch_payment_id = '00000000-0000-0000-0000-000000000000'
     
     try:
-        api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order)
+        api_response = api_instance.get_batch_payment(xero_tenant_id, batch_payment_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getBankTransfers: %s\n" % e)

+ print("Exception when calling AccountingApi->getBatchPayment: %s\n" % e)

Scopes

@@ -19979,25 +22421,28 @@

Scopes

Name	Description
xero-tenant-id*
where	- + @@ -19899,12 +22326,29 @@ Parameters -Xero identifier for Tenant +Filter by an any element + + + + +
order	+ + + + + + + String + + + +Order by an any element - - Required -

Parameters

Header parameters

Path parameters

- + - - - -

Name	Description
xero-tenant-id*
BatchPaymentID*	- + - String + UUID + + (uuid) + -Xero identifier for Tenant +Unique identifier for BatchPayment @@ -20006,63 +22451,20 @@ Parameters
If-Modified-Since	- - - - - - - Date - - - (date-time) - - - -Only records created or modified since this timestamp will be returned - - - - -

Query parameters

Header parameters

- - - - - + @@ -22392,7 +24797,7 @@

Usage and SDK Samples

ids = ["00000000-0000-0000-0000-000000000000"] include_archived = 'True' summary_only = 'True' - search_term = 'searchTerm=Joe Bloggs' + search_term = 'Joe Bloggs' try: api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since, where, order, ids, page, include_archived, summary_only, search_term) @@ -26544,6 +28949,126 @@

Parameters

+ + +

Name	Description
where	- - - - - - - String - - - -Filter by an any element - - - - -
order
xero-tenant-id*	- + @@ -20070,9 +22472,12 @@ Parameters -Order by an any element +Xero identifier for Tenant + + Required +

getJournalByNumber

Retrieves a specific journal using a unique journal number.

+
+

/Journals/{JournalNumber}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_journal_by_number():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    
+    try:
+        api_response = api_instance.get_journal_by_number(xero_tenant_id, journal_number)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getJournalByNumber: %s\n" % e)

Scopes

+ + + + + + + +

accounting.journals.read

Grant read-only access to journals

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
JournalNumber*	+ + + + + + + Integer + + + +Number of a Journal + + + + Required + + + +

Header parameters

+ + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

@@ -30023,18 +32548,271 @@

Parameters

- -

Header parameters

- - - - - - +

Name	Description
xero-tenant-id*

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getPurchaseOrderAsPdf

Retrieves specific purchase order as PDF files using a unique purchase order Id

+
+

/PurchaseOrders/{PurchaseOrderID}/pdf

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_purchase_order_as_pdf():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    purchase_order_id = '00000000-0000-0000-0000-000000000000'
+    
+    try:
+        api_response = api_instance.get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getPurchaseOrderAsPdf: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

accounting.transactions	Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read	Grant read-only access to invoices

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
PurchaseOrderID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for an Purchase Order + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getPurchaseOrderAttachmentByFileName

Retrieves a specific attachment for a specific purchase order by filename

+
+

/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_purchase_order_attachment_by_file_name():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    purchase_order_id = '00000000-0000-0000-0000-000000000000'
+    file_name = 'xero-dev.jpg'
+    content_type = 'image/jpg'
+    
+    try:
+        api_response = api_instance.get_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getPurchaseOrderAttachmentByFileName: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

accounting.attachments	Grant read-write access to attachments
accounting.attachments.read	Grant read-only access to attachments

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
PurchaseOrderID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for an Purchase Order + + + + Required + + + +
FileName*	- + @@ -30042,7 +32820,7 @@ Parameters -Xero identifier for Tenant +Name of the attachment @@ -30054,94 +32832,25 @@ Parameters

getPurchaseOrderAsPdf

Retrieves specific purchase order as PDF files using a unique purchase order Id

-
-

/PurchaseOrders/{PurchaseOrderID}/pdf

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_purchase_order_as_pdf():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    purchase_order_id = '00000000-0000-0000-0000-000000000000'
-    
-    try:
-        api_response = api_instance.get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getPurchaseOrderAsPdf: %s\n" % e)

Scopes

- - - - - - - - - - - - -

accounting.transactions	Grant read-write access to bank transactions, credit notes, invoices, repeating invoices
accounting.transactions.read	Grant read-only access to invoices

Parameters

Path parameters

Header parameters

- + -

Name	Description
PurchaseOrderID*
xero-tenant-id*	- + - UUID + String - - (uuid) - -Unique identifier for an Purchase Order +Xero identifier for Tenant @@ -30152,18 +32861,11 @@ Parameters

Header parameters

- - - - - - + - - -

Name	Description
xero-tenant-id*
contentType*	- + @@ -30171,7 +32873,7 @@ Parameters -Xero identifier for Tenant +The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf @@ -30974,183 +33676,6 @@ Parameters

getPurchaseOrder≠AttachmentByFileName

Retrieves a specific attachment for a specific purchase order by filename

-
-

/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_purchase_order≠attachment_by_file_name():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    purchase_order_id = '00000000-0000-0000-0000-000000000000'
-    file_name = 'xero-dev.jpg'
-    content_type = 'image/jpg'
-    
-    try:
-        api_response = api_instance.get_purchase_order≠attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, content_type)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getPurchaseOrder≠AttachmentByFileName: %s\n" % e)

Scopes

- - - - - - - - - - - - -

accounting.attachments	Grant read-write access to attachments
accounting.attachments.read	Grant read-only access to attachments

Parameters

Path parameters

- - - - - - - - - - - - - -

Name	Description
PurchaseOrderID*	- - - - - - - UUID - - - (uuid) - - - -Unique identifier for an Purchase Order - - - - Required - - - -
FileName*	- - - - - - - String - - - -Name of the attachment - - - - Required - - - -

Header parameters

- - - - - - - - - - -

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
contentType*	- - - - - - - String - - - -The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf - - - - Required - - - -

@@ -36854,6 +39379,7 @@

Usage and SDK Samples

def accounting_post_setup(): api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' account = Account( code = "123", @@ -36875,7 +39401,7 @@

Usage and SDK Samples

conversion_balances = conversion_balances) try: - api_response = api_instance.post_setup(xero_tenant_id, setup) + api_response = api_instance.post_setup(xero_tenant_id, setup, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->postSetup: %s\n" % e) @@ -36918,6 +39444,26 @@

Parameters

+ + + Idempotency-Key + + + +

+ + String + + +

bank_transactions = [bank_transaction]) try: - api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bankTransactions, unitdp) + api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bankTransactions, idempotency_key, unitdp) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateBankTransaction: %s\n" % e) @@ -37464,6 +40053,26 @@

Parameters

+ + + Idempotency-Key + + + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

+ @@ -37574,13 +40183,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' bank_transaction_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + api_response = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateBankTransactionAttachmentByFileName: %s\n" % e) @@ -37662,7 +40272,217 @@

Parameters

+ + String + + +

+Xero identifier for Tenant +

+ Required +

+ + + + Idempotency-Key + + + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

+ + + + +

Body parameters

+ + + + + + + +

Name	Description
body *	+ + + + byte[] + + + Byte array of file in body of request + + + + Required + + + +

updateBankTransferAttachmentByFileName

+
+

/BankTransfers/{BankTransferID}/Attachments/{FileName}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_bank_transfer_attachment_by_file_name():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    file_name = 'xero-dev.jpg'
+    idempotency_key = 'KEY_VALUE'
+    
+    path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
+    open_file = open(path_to_upload, 'rb')
+        body = open_file.read()
+    
+    try:
+        api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateBankTransferAttachmentByFileName: %s\n" % e)

Scopes

+ + + + + + + +

accounting.attachments

Grant read-write access to attachments

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
BankTransferID*	+ + + + + + + UUID + + + (uuid) + + + +Xero generated unique identifier for a bank transfer + + + + Required + + + +
FileName*	+ + + + + + + String + + + +Name of the attachment + + + + Required + + + +

Header parameters

+ + + + + + + -

Name	Description
xero-tenant-id*	+ + + @@ -37681,147 +40501,11 @@ Parameters

Body parameters

- - - - - - - -

Name	Description
body *	- - - - byte[] - - - Byte array of file in body of request - - - - Required - - - -

updateBankTransferAttachmentByFileName

-
-

/BankTransfers/{BankTransferID}/Attachments/{FileName}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_bank_transfer_attachment_by_file_name():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
-    file_name = 'xero-dev.jpg'
-    
-    path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
-    open_file = open(path_to_upload, 'rb')
-        body = open_file.read()
-    
-    try:
-        api_response = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->updateBankTransferAttachmentByFileName: %s\n" % e)

Scopes

- - - - - - - -

accounting.attachments

Grant read-write access to attachments

Parameters

Path parameters

- - - - - - - - - - + - - -

Name	Description
BankTransferID*	- - - - - - - UUID - - - (uuid) - - - -Xero generated unique identifier for a bank transfer - - - - Required - - - -
FileName*
Idempotency-Key	- + @@ -37829,42 +40513,9 @@ Parameters -Name of the attachment +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - Required - - - -

Header parameters

+ + + Idempotency-Key + + + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

+ @@ -38308,6 +41001,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' contact_group_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' contact_group = ContactGroup( name = "Vendor") @@ -38316,7 +41010,7 @@

Usage and SDK Samples

contact_groups = [contact_group]) try: - api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contactGroups) + api_response = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contactGroups, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateContactGroup: %s\n" % e) @@ -38392,6 +41086,26 @@

Parameters

Header parameters

Name	Description
xero-tenant-id*

Header parameters

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

Name	Description
manualJournals *	+ + + + ManualJournals + + + + + + + Required + + + +

updateManualJournalAttachmentByFileName

Updates a specific attachment from a specific manual journal by file name

+
+

/ManualJournals/{ManualJournalID}/Attachments/{FileName}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_manual_journal_attachment_by_file_name():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    manual_journal_id = '00000000-0000-0000-0000-000000000000'
+    file_name = 'xero-dev.jpg'
+    idempotency_key = 'KEY_VALUE'
+    
+    path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
+    open_file = open(path_to_upload, 'rb')
+        body = open_file.read()
+    
+    try:
+        api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateManualJournalAttachmentByFileName: %s\n" % e)

Scopes

+ + + + + + + +

accounting.attachments

Grant read-write access to attachments

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
ManualJournalID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a ManualJournal + + + + Required + + + +
FileName*	- + @@ -39890,7 +42931,7 @@ Parameters -Xero identifier for Tenant +Name of the attachment @@ -39902,145 +42943,17 @@ Parameters

Body parameters

- - - - - - - -

Name	Description
manualJournals *	- - - - ManualJournals - - - - - - - Required - - - -

updateManualJournalAttachmentByFileName

Updates a specific attachment from a specific manual journal by file name

-
-

/ManualJournals/{ManualJournalID}/Attachments/{FileName}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_manual_journal_attachment_by_file_name():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    manual_journal_id = '00000000-0000-0000-0000-000000000000'
-    file_name = 'xero-dev.jpg'
-    
-    path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
-    open_file = open(path_to_upload, 'rb')
-        body = open_file.read()
-    
-    try:
-        api_response = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->updateManualJournalAttachmentByFileName: %s\n" % e)

Scopes

- - - - - - - -

accounting.attachments

Grant read-write access to attachments

Parameters

Path parameters

Header parameters

- - - - - + -

Name	Description
ManualJournalID*	- - - - - - - UUID - - - (uuid) - - - -Unique identifier for a ManualJournal - - - - Required - - - -
FileName*
xero-tenant-id*	- + @@ -40048,7 +42961,7 @@ Parameters -Name of the attachment +Xero identifier for Tenant @@ -40059,18 +42972,11 @@ Parameters

Header parameters

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_or_create_repeating_invoices():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    idempotency_key = 'KEY_VALUE'
+    summarize_errors = 'True'
+    
+    try:
+        api_response = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeatingInvoices, idempotency_key, summarize_errors)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateOrCreateRepeatingInvoices: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
repeatingInvoices *	+ + + + RepeatingInvoices + + + RepeatingInvoices with an array of repeating invoice objects in body of request + + + + Required + + + +

Query parameters

+ + + + + + +

Name	Description
summarizeErrors	+ + + + + + + Boolean + + + +If false return 200 OK and mix of successfully created objects and any with validation errors + + + + +

@@ -41806,6 +45074,7 @@

Usage and SDK Samples

api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' purchase_order_id = '00000000-0000-0000-0000-000000000000' + idempotency_key = 'KEY_VALUE' purchase_order = PurchaseOrder( attentionTo = "Peter Parker") @@ -41814,7 +45083,7 @@

Usage and SDK Samples

purchase_orders = [purchase_order]) try: - api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchaseOrders) + api_response = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchaseOrders, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updatePurchaseOrder: %s\n" % e) @@ -41890,6 +45159,26 @@

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_repeating_invoice():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    repeating_invoice_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeatingInvoices, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->updateRepeatingInvoice: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
RepeatingInvoiceID*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for a Repeating Invoice + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
repeatingInvoices *	+ + + + RepeatingInvoices + + + + + + + Required + + +

@@ -42911,13 +46486,14 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' repeating_invoice_id = '00000000-0000-0000-0000-000000000000' file_name = 'xero-dev.jpg' + idempotency_key = 'KEY_VALUE' path_to_upload = Path(__file__).resolve().parent.joinpath(fileName) open_file = open(path_to_upload, 'rb') body = open_file.read() try: - api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + api_response = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateRepeatingInvoiceAttachmentByFileName: %s\n" % e) @@ -43016,6 +46592,26 @@

Update and existing metered usage belonging to this subscription and subscription item

+
+

/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_put_usage_records():
+    api_instance = AppStoreApi(api_client)
+    subscription_id = '00000000-0000-0000-0000-000000000000'
+    subscription_item_id = '00000000-0000-0000-0000-000000000000'
+    usage_record_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, updateUsageRecord, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AppStoreApi->putUsageRecords: %s\n" % e)

Scopes

+ + + + + + + +

marketplace.billing

Grant read-only access to fixed assets

Parameters

Path parameters

+ + + + + + + + + + + + + + + + + +

Name	Description
subscriptionId*	+ + + + + + + UUID + + + (uuid) + + + +Unique identifier for Subscription object + + + + Required + + + +
subscriptionItemId*	+ + + + + + + UUID + + + (uuid) + + + +The unique identifier of the subscriptionItem + + + + Required + + + +
usageRecordId*	+ + + + + + + UUID + + + (uuid) + + + +The unique identifier of the usage record + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
updateUsageRecord *	+ + + + UpdateUsageRecord + + + Contains the quantity for the usage record to update + + + + Required + + + +

diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index 19a305a5..f4393e09 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1469,6 +1469,7 @@

Usage and SDK Samples

def accounting_create_asset(): api_instance = AssetApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' + idempotency_key = 'KEY_VALUE' asset = Asset( asset_name = "Other Computer", @@ -1476,7 +1477,7 @@

Usage and SDK Samples

status = "Draft") try: - api_response = api_instance.create_asset(xero_tenant_id, asset) + api_response = api_instance.create_asset(xero_tenant_id, asset, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AssetApi->createAsset: %s\n" % e) @@ -1519,6 +1520,26 @@

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

getAssociationsByObject
+ getAssociationsCount +
getFile

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

getAssociationsByObject

By passing in the appropriate options,

By passing in the appropriate options, you can retrieve an association

/Associations/{ObjectId}

Usage and SDK Samples

Parameters

Query parameters

Name	Description
pagesize	+ + + + + + + Integer + + + +pass an optional page size value + + + + +
page	+ + + + + + + Integer + + + +number of records to skip for pagination + + + + +
sort	+ + + + + + + String + + + +values to sort by + + + + +
direction	+ + + + + + + String + + + +direction to sort by + + + + +

getAssociationsCount

Retrieves a count of associations for a list of objects.

By passing in the appropriate options, you can retrieve the association count for objects

+
+

/Associations/Count

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_associations_count():
+    api_instance = FilesApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    objectIds = []
+    
+    try:
+        api_response = api_instance.get_associations_count(xero_tenant_id, objectIds)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling FilesApi->getAssociationsCount: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

files	Grant read-write access to files and folders
files.read	Grant read-only access to files and folders

Parameters

Header parameters

+ + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

Query parameters

+ + + + + + +

Name	Description
ObjectIds*	+ + + + + + + array[UUID] + + + (uuid) + + + +A comma-separated list of object ids + + + + Required + + + +

@@ -2966,9 +3229,10 @@

Usage and SDK Samples

api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' + idempotency_key = 'KEY_VALUE' try: - api_response = api_instance.update_file(xero_tenant_id, file_id, fileObject) + api_response = api_instance.update_file(xero_tenant_id, file_id, idempotency_key, fileObject) print(api_response) except AccountingBadRequestException as e: print("Exception when calling FilesApi->updateFile: %s\n" % e) @@ -3044,6 +3308,26 @@

PayrollAu

approveLeaveApplication

Approve a requested leave application by a unique leave application id

+
+

/LeaveApplications/{LeaveApplicationID}/approve

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_leave_application(xero_tenant_id, leave_application_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->approveLeaveApplication: %s\n" % e)

Scopes

+ + + + + + + +

payroll.employees

Grant read-write access to payroll employees

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
LeaveApplicationID*	+ + + + + + + UUID + + + (uuid) + + + +Leave Application id for single object + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

@@ -3400,6 +3712,7 @@

Usage and SDK Samples

def accounting_create_employee(): api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xeroTenantId_example' + idempotency_key = 'KEY_VALUE' date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z') home_address = HomeAddress( @@ -3415,7 +3728,7 @@

Usage and SDK Samples

homeAddress = home_address) try: - api_response = api_instance.create_employee(xero_tenant_id, employee) + api_response = api_instance.create_employee(xero_tenant_id, employee, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling PayrollAuApi->createEmployee: %s\n" % e) @@ -3458,6 +3771,26 @@

Parameters

+ + + Idempotency-Key + + + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

+ @@ -3542,6 +3875,7 @@

Usage and SDK Samples

def accounting_create_leave_application(): api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xeroTenantId_example' + idempotency_key = 'KEY_VALUE' start_date = dateutil.parser.parse('2020-10-28T00:00:00Z') end_date = dateutil.parser.parse('2020-10-30T00:00:00Z') @@ -3553,7 +3887,7 @@

Usage and SDK Samples

end_date = end_date) try: - api_response = api_instance.create_leave_application(xero_tenant_id, leaveApplication) + api_response = api_instance.create_leave_application(xero_tenant_id, leaveApplication, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling PayrollAuApi->createLeaveApplication: %s\n" % e) @@ -3598,21 +3932,41 @@

Parameters

- -

Body parameters

- - - - - - - - + + + +

Name	Description
leaveApplication *	- - - - array[LeaveApplication] - +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + + + + + +

Name

Description

leaveApplication *

+ + array[LeaveApplication] +

@@ -3680,6 +4034,7 @@

Usage and SDK Samples

def accounting_create_pay_item(): api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xeroTenantId_example' + idempotency_key = 'KEY_VALUE' earnings_rate = EarningsRate( name = "Ordinary Hours 123", @@ -3723,7 +4078,7 @@

Usage and SDK Samples

reimbursementTypes = reimbursement_types) try: - api_response = api_instance.create_pay_item(xero_tenant_id, payItem) + api_response = api_instance.create_pay_item(xero_tenant_id, payItem, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling PayrollAuApi->createPayItem: %s\n" % e) @@ -3766,6 +4121,26 @@

Parameters

Idempotency-Key

+ + +

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

@@ -3798,7 +4173,7 @@

Parameters

"schema" : { "$ref" : "#/components/schemas/PayItem" }, - "example" : "{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }" + "example" : "{ \"EarningsRates\": [ { \"Name\": \"MyRate\", \"AccountCode\": \"400\", \"TypeOfUnits\": \"4.00\", \"IsExemptFromTax\": true, \"IsExemptFromSuper\": true, \"IsReportableAsW1\": false, \"AllowanceContributesToAnnualLeaveRate\": false, \"AllowanceContributesToOvertimeRate\": false, \"EarningsType\": \"ORDINARYTIMEEARNINGS\", \"EarningsRateID\": \"1fa4e226-b711-46ba-a8a7-4344c9c5fb87\", \"RateType\": \"MULTIPLE\", \"RatePerUnit\": \"10.0\", \"Multiplier\": 1.5, \"Amount\": 5, \"EmploymentTerminationPaymentType\": \"O\" } ] }" } }, "required" : true @@ -3847,12 +4222,13 @@

Usage and SDK Samples

def accounting_create_pay_run(): api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xeroTenantId_example' + idempotency_key = 'KEY_VALUE' pay_run = PayRun( payroll_calendar_id = "00000000-0000-0000-0000-000000000000") try: - api_response = api_instance.create_pay_run(xero_tenant_id, payRun) + api_response = api_instance.create_pay_run(xero_tenant_id, payRun, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling PayrollAuApi->createPayRun: %s\n" % e) @@ -3895,6 +4271,26 @@

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Parameters

+ + String + + +

+Xero identifier for Tenant +

+ Required +

+ + + + + +

getLeaveApplications

Retrieves leave applications

+
+

/LeaveApplications

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_leave_applications():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
+    where = 'Status=="ACTIVE"'
+    order = 'EmailAddress%20DESC'
+    
+    try:
+        api_response = api_instance.get_leave_applications(xero_tenant_id, if_modified_since, where, order, page)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->getLeaveApplications: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

payroll.employees	Grant read-write access to payroll employees
payroll.employees.read	Grant read-only access to payroll employees

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
If-Modified-Since	+ + + + + + + Date + + + (date-time) + + + +Only records created or modified since this timestamp will be returned + + + + +

Query parameters

+ + + + + + + + + + + + + + + @@ -4796,11 +5443,11 @@

Parameters

getLeaveApplications

Retrieves leave applications

getLeaveApplicationsV2

Retrieves leave applications including leave requests

@@ -4808,17 +5455,17 @@

getLeaveApplications

/LeaveApplications

/LeaveApplications/v2

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -4832,7 +5479,7 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_get_leave_applications():
+def accounting_get_leave_applications_v2():
     api_instance = PayrollAuApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
     if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
@@ -4840,10 +5487,10 @@ Usage and SDK Samples
     order = 'EmailAddress%20DESC'
     
     try:
-        api_response = api_instance.get_leave_applications(xero_tenant_id, if_modified_since, where, order, page)
+        api_response = api_instance.get_leave_applications_v2(xero_tenant_id, if_modified_since, where, order, page)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling PayrollAuApi->getLeaveApplications: %s\n" % e)

+ print("Exception when calling PayrollAuApi->getLeaveApplicationsV2: %s\n" % e)

Scopes

@@ -4871,7 +5518,7 @@

Parameters

+ + +

Name	Description
where	+ + + + + + + String + + + +Filter by an any element + + + + +
order	+ + + + + + + String + + + +Order by an any element + + + + +
page	+ + + - String + Integer -Xero identifier for Tenant +e.g. page=1 – Up to 100 objects will be returned in a single API call - - Required -	- + @@ -4894,7 +5541,7 @@ Parameters	- + @@ -4924,7 +5571,7 @@ Parameters	- + @@ -4944,7 +5591,7 @@ Parameters	- + @@ -4964,7 +5611,7 @@ Parameters	- + @@ -6802,6 +7449,151 @@ Parameters

rejectLeaveApplication

Reject a leave application by a unique leave application id

+
+

/LeaveApplications/{LeaveApplicationID}/reject

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_reject_leave_application():
+    api_instance = PayrollAuApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    leave_application_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.reject_leave_application(xero_tenant_id, leave_application_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuApi->rejectLeaveApplication: %s\n" % e)

Scopes

+ + + + + + + +

payroll.employees

Grant read-write access to payroll employees

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
LeaveApplicationID*	+ + + + + + + UUID + + + (uuid) + + + +Leave Application id for single object + + + + Required + + + +

Header parameters

+ + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

@@ -6848,6 +7640,7 @@

Usage and SDK Samples

api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xeroTenantId_example' employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' + idempotency_key = 'KEY_VALUE' date_of_birth = dateutil.parser.parse('2000-10-28T00:00:00Z') home_address = HomeAddress( @@ -6863,7 +7656,7 @@

Usage and SDK Samples

homeAddress = home_address) try: - api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee) + api_response = api_instance.update_employee(xero_tenant_id, employee_id, idempotency_key, employee) print(api_response) except AccountingBadRequestException as e: print("Exception when calling PayrollAuApi->updateEmployee: %s\n" % e) @@ -6939,6 +7732,26 @@

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Usage and SDK Samples

Parameters

+ + String + + +

+
+

/Projects/{projectId}/Tasks

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.create_task(xero_tenant_id, project_id, taskCreateOrUpdate, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->createTask: %s\n" % e)

Scopes

+ + + + + + + +

projects

Grant read-write access to projects

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
projectId*	+ + + + + + + UUID + + + (uuid) + + + +You can create a task on a specified projectId + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
taskCreateOrUpdate *	+ + + + TaskCreateOrUpdate + + + The task object you are creating + + + + Required + + +

@@ -1694,9 +1900,10 @@

Usage and SDK Samples

api_instance = ProjectApi(api_client) xero_tenant_id = 'xeroTenantId_example' project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' + idempotency_key = 'KEY_VALUE' try: - api_response = api_instance.create_time_entry(xero_tenant_id, project_id, timeEntryCreateOrUpdate) + api_response = api_instance.create_time_entry(xero_tenant_id, project_id, timeEntryCreateOrUpdate, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling ProjectApi->createTimeEntry: %s\n" % e) @@ -1772,6 +1979,26 @@

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

Parameters

The time entry object you are creating

- Required -

+ Required +

deleteTask

Allows you to delete a task

Allows you to delete a specific task

+
+

/Projects/{projectId}/Tasks/{taskId}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_instance.delete_task(xero_tenant_id, project_id, task_id)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->deleteTask: %s\n" % e)

Scopes

+ + + + + + + +

projects

Grant read-write access to projects

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
projectId*	+ + + + + + + UUID + + + (uuid) + + + +You can specify an individual project by appending the projectId to the endpoint + + + + Required + + + +
taskId*	+ + + + + + + UUID + + + (uuid) + + + +You can specify an individual task by appending the id to the endpoint + + + + Required + + + +

Header parameters

+ + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + - +

Parameters

Allows you to update a specific task

+
+

/Projects/{projectId}/Tasks/{taskId}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_task():
+    api_instance = ProjectApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    task_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_instance.update_task(xero_tenant_id, project_id, task_id, taskCreateOrUpdate, idempotency_key)
+    except AccountingBadRequestException as e:
+        print("Exception when calling ProjectApi->updateTask: %s\n" % e)

Scopes

+ + + + + + + +

projects

Grant read-write access to projects

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
projectId*	+ + + + + + + UUID + + + (uuid) + + + +You can specify an individual project by appending the projectId to the endpoint + + + + Required + + + +
taskId*	+ + + + + + + UUID + + + (uuid) + + + +You can specify an individual task by appending the id to the endpoint + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
taskCreateOrUpdate *	+ + + + TaskCreateOrUpdate + + + The task object you are updating + + + + Required + + +

@@ -3699,9 +4325,10 @@

Usage and SDK Samples

xero_tenant_id = 'xeroTenantId_example' project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' time_entry_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' + idempotency_key = 'KEY_VALUE' try: - api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, timeEntryCreateOrUpdate) + api_instance.update_time_entry(xero_tenant_id, project_id, time_entry_id, timeEntryCreateOrUpdate, idempotency_key) except AccountingBadRequestException as e: print("Exception when calling ProjectApi->updateTimeEntry: %s\n" % e)

Parameters

+ + String + + +

+This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

receipts = [receipt]) try: - api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, idempotency_key, unitdp) + api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->updateReceipt: %s\n" % e) diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index 943e8d9f..4507deb8 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1241,7 +1241,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index f4393e09..f3f2477c 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1392,7 +1392,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

createAsset @@ -1638,7 +1638,7 @@

Usage and SDK Samples

book_depreciation_setting = book_depreciation_setting) try: - api_response = api_instance.create_asset_type(xero_tenant_id, idempotency_key, assetType) + api_response = api_instance.create_asset_type(xero_tenant_id, assetType, idempotency_key) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AssetApi->createAssetType: %s\n" % e) @@ -1711,7 +1711,7 @@

Parameters

Description - assetType + assetType *

@@ -1722,6 +1722,9 @@

Parameters

Asset type to add

+ Required +

diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index 2cd67923..f63b7927 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1155,7 +1155,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 6d731eeb..4f3a0273 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2734,7 +2734,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 802c895d..a4fdfae8 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index f120e4e8..a2820c18 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -3843,7 +3843,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 73380eef..77528ce1 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3510,7 +3510,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index ca41a311..ae74476c 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

SDK:
VSN: 1.27.0
VSN: 2.0.0
Methods

createProject diff --git a/setup.py b/setup.py index e9a4955b..d5b7f55c 100644 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ def load_requirements(file_name): def read_file(filename): - with open(filename, encoding='utf-8') as fp: + with open(filename, encoding="utf-8") as fp: return fp.read() @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="1.27.0", + version="2.0.0", ) diff --git a/tests/accounting/api/test_accounting_api.py b/tests/accounting/api/test_accounting_api.py index ed4b9663..77a86362 100644 --- a/tests/accounting/api/test_accounting_api.py +++ b/tests/accounting/api/test_accounting_api.py @@ -86,11 +86,11 @@ def test_invoice_attachment_upload_and_download( ): """This is a full integration test, tested steps are: - 1. get first page of invoices - 2. choose first invoice - 3. upload test pdf file as invoice attachment - 4. confirm the invoice has new attachment - 5. download uploaded pdf file + 1. get first page of invoices + 2. choose first invoice + 3. upload test pdf file as invoice attachment + 4. confirm the invoice has new attachment + 5. download uploaded pdf file """ # 1. get first page of invoices @@ -373,7 +373,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): is_discounted=False, line_amount_types=LineAmountTypes.EXCLUSIVE, reference="Red Fish, Blue Fish", - repeating_invoice_id= '428c0d75-909f-4b04-8403-a48dc27283b0', + repeating_invoice_id="428c0d75-909f-4b04-8403-a48dc27283b0", sent_to_contact=True, status="VOIDED", sub_total=Decimal("40.00"), diff --git a/tests/conftest.py b/tests/conftest.py index 049d4057..9c76c301 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -127,6 +127,7 @@ def oauth2_token( "token_type": "Bearer", } + @pytest.fixture() def oauth2_token_without_id_token( xero_access_token, diff --git a/tests/test_api_client/test_oauth2.py b/tests/test_api_client/test_oauth2.py index 490af0c6..dd8eb6ee 100644 --- a/tests/test_api_client/test_oauth2.py +++ b/tests/test_api_client/test_oauth2.py @@ -205,6 +205,7 @@ def test_auth2_call_refresh_token_api(oauth2_refresh_token): assert call_kwargs == {} assert new_token is token + def test_auth2_call_refresh_token_api_without_id_token(oauth2_token_without_id_token): # Given valid refresh token and client credentials without using OpenID scope (id_token absent) oauth2_token = OAuth2Token() diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 2bcbeeb8..12349889 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "1.27.0" +__version__ = "2.0.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 87972398..70fed9e1 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib @@ -452,9 +452,9 @@ def create_bank_transactions( self, xero_tenant_id, bank_transactions, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -463,9 +463,9 @@ def create_bank_transactions( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransactions bank_transactions: BankTransactions with an array of BankTransaction objects in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1493,8 +1493,8 @@ def create_contacts( self, xero_tenant_id, contacts, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1503,8 +1503,8 @@ def create_contacts( OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: Contacts with an array of Contact objects to create in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1583,8 +1583,8 @@ def create_credit_note_allocation( xero_tenant_id, credit_note_id, allocations, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1594,8 +1594,8 @@ def create_credit_note_allocation( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) :param Allocations allocations: Allocations with array of Allocation object in body of request. (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1685,8 +1685,8 @@ def create_credit_note_attachment_by_file_name( credit_note_id, file_name, body, - idempotency_key=empty, include_online=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1697,8 +1697,8 @@ def create_credit_note_attachment_by_file_name( :param str credit_note_id: Unique identifier for a Credit Note (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool include_online: Allows an attachment to be seen by the end customer within their online invoice + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1889,9 +1889,9 @@ def create_credit_notes( self, xero_tenant_id, credit_notes, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1900,9 +1900,9 @@ def create_credit_notes( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param CreditNotes credit_notes: Credit Notes with array of CreditNote object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2067,8 +2067,8 @@ def create_employees( self, xero_tenant_id, employees, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2077,8 +2077,8 @@ def create_employees( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employees employees: Employees with array of Employee object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2338,8 +2338,8 @@ def create_invoice_attachment_by_file_name( invoice_id, file_name, body, - idempotency_key=empty, include_online=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2350,8 +2350,8 @@ def create_invoice_attachment_by_file_name( :param str invoice_id: Unique identifier for an Invoice (required) :param str file_name: Name of the attachment (required) :param str body: Byte array of file in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool include_online: Allows an attachment to be seen by the end customer within their online invoice + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2540,9 +2540,9 @@ def create_invoices( self, xero_tenant_id, invoices, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2551,9 +2551,9 @@ def create_invoices( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Invoices invoices: Invoices with an array of invoice objects in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2728,9 +2728,9 @@ def create_items( self, xero_tenant_id, items, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2739,9 +2739,9 @@ def create_items( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Items items: Items with an array of Item objects in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3108,8 +3108,8 @@ def create_manual_journals( self, xero_tenant_id, manual_journals, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3118,8 +3118,8 @@ def create_manual_journals( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3198,8 +3198,8 @@ def create_overpayment_allocations( xero_tenant_id, overpayment_id, allocations, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3209,8 +3209,8 @@ def create_overpayment_allocations( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str overpayment_id: Unique identifier for a Overpayment (required) :param Allocations allocations: Allocations array with Allocation object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3654,8 +3654,8 @@ def create_payments( self, xero_tenant_id, payments, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3664,8 +3664,8 @@ def create_payments( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Payments payments: Payments array with Payment object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -3744,8 +3744,8 @@ def create_prepayment_allocations( xero_tenant_id, prepayment_id, allocations, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -3755,8 +3755,8 @@ def create_prepayment_allocations( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str prepayment_id: Unique identifier for a PrePayment (required) :param Allocations allocations: Allocations with an array of Allocation object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4141,8 +4141,8 @@ def create_purchase_orders( self, xero_tenant_id, purchase_orders, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4151,8 +4151,8 @@ def create_purchase_orders( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: PurchaseOrders with an array of PurchaseOrder object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4429,8 +4429,8 @@ def create_quotes( self, xero_tenant_id, quotes, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4439,8 +4439,8 @@ def create_quotes( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: Quotes with an array of Quote object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -4518,8 +4518,8 @@ def create_receipt( self, xero_tenant_id, receipts, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -4528,8 +4528,8 @@ def create_receipt( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Receipts receipts: Receipts with an array of Receipt object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -5009,8 +5009,8 @@ def create_repeating_invoices( self, xero_tenant_id, repeating_invoices, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -5019,8 +5019,8 @@ def create_repeating_invoices( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param RepeatingInvoices repeating_invoices: RepeatingInvoices with an array of repeating invoice objects in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17355,8 +17355,8 @@ def update_bank_transaction( xero_tenant_id, bank_transaction_id, bank_transactions, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17366,8 +17366,8 @@ def update_bank_transaction( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str bank_transaction_id: Xero generated unique identifier for a bank transaction (required) :param BankTransactions bank_transactions: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -17961,8 +17961,8 @@ def update_credit_note( xero_tenant_id, credit_note_id, credit_notes, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -17972,8 +17972,8 @@ def update_credit_note( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str credit_note_id: Unique identifier for a Credit Note (required) :param CreditNotes credit_notes: an array of Credit Notes containing credit note details to update (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18261,8 +18261,8 @@ def update_invoice( xero_tenant_id, invoice_id, invoices, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18272,8 +18272,8 @@ def update_invoice( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str invoice_id: Unique identifier for an Invoice (required) :param Invoices invoices: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18465,8 +18465,8 @@ def update_item( xero_tenant_id, item_id, items, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18476,8 +18476,8 @@ def update_item( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str item_id: Unique identifier for an Item (required) :param Items items: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18856,9 +18856,9 @@ def update_or_create_bank_transactions( self, xero_tenant_id, bank_transactions, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18867,9 +18867,9 @@ def update_or_create_bank_transactions( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param BankTransactions bank_transactions: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -18952,8 +18952,8 @@ def update_or_create_contacts( self, xero_tenant_id, contacts, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -18962,8 +18962,8 @@ def update_or_create_contacts( OAuth2 scope: accounting.contacts :param str xero_tenant_id: Xero identifier for Tenant (required) :param Contacts contacts: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19041,9 +19041,9 @@ def update_or_create_credit_notes( self, xero_tenant_id, credit_notes, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19052,9 +19052,9 @@ def update_or_create_credit_notes( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param CreditNotes credit_notes: an array of Credit Notes with a single CreditNote object. (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19137,8 +19137,8 @@ def update_or_create_employees( self, xero_tenant_id, employees, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19147,8 +19147,8 @@ def update_or_create_employees( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Employees employees: Employees with array of Employee object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19226,9 +19226,9 @@ def update_or_create_invoices( self, xero_tenant_id, invoices, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19237,9 +19237,9 @@ def update_or_create_invoices( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Invoices invoices: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19320,9 +19320,9 @@ def update_or_create_items( self, xero_tenant_id, items, - idempotency_key=empty, summarize_errors=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19331,9 +19331,9 @@ def update_or_create_items( OAuth2 scope: accounting.settings :param str xero_tenant_id: Xero identifier for Tenant (required) :param Items items: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19414,8 +19414,8 @@ def update_or_create_manual_journals( self, xero_tenant_id, manual_journals, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19424,8 +19424,8 @@ def update_or_create_manual_journals( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param ManualJournals manual_journals: ManualJournals array with ManualJournal object in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19505,8 +19505,8 @@ def update_or_create_purchase_orders( self, xero_tenant_id, purchase_orders, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19515,8 +19515,8 @@ def update_or_create_purchase_orders( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param PurchaseOrders purchase_orders: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19596,8 +19596,8 @@ def update_or_create_quotes( self, xero_tenant_id, quotes, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19606,8 +19606,8 @@ def update_or_create_quotes( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param Quotes quotes: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -19685,8 +19685,8 @@ def update_or_create_repeating_invoices( self, xero_tenant_id, repeating_invoices, - idempotency_key=empty, summarize_errors=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -19695,8 +19695,8 @@ def update_or_create_repeating_invoices( OAuth2 scope: accounting.transactions :param str xero_tenant_id: Xero identifier for Tenant (required) :param RepeatingInvoices repeating_invoices: RepeatingInvoices with an array of repeating invoice objects in body of request (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -20176,8 +20176,8 @@ def update_receipt( xero_tenant_id, receipt_id, receipts, - idempotency_key=empty, unitdp=empty, + idempotency_key=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -20187,8 +20187,8 @@ def update_receipt( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str receipt_id: Unique identifier for a Receipt (required) :param Receipts receipts: (required) - :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 52194ac4..96eb2cc9 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -513,7 +513,7 @@ Name | Type | Description | Notes [[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) # **create_bank_transactions** -> BankTransactions create_bank_transactions(xero_tenant_id, bank_transactions, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> BankTransactions create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates one or more spent or received money transaction @@ -545,12 +545,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} # BankTransactions | BankTransactions with an array of BankTransaction objects in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more spent or received money transaction - api_response = api_instance.create_bank_transactions(xero_tenant_id, bank_transactions, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_bank_transactions: %s\n" % e) @@ -562,9 +562,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| BankTransactions with an array of BankTransaction objects in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1250,7 +1250,7 @@ Name | Type | Description | Notes [[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) # **create_contacts** -> Contacts create_contacts(xero_tenant_id, contacts, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Contacts create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates multiple contacts (bulk) in a Xero organisation @@ -1282,11 +1282,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contacts = { "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [] } ] } # Contacts | Contacts with an array of Contact objects to create in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple contacts (bulk) in a Xero organisation - api_response = api_instance.create_contacts(xero_tenant_id, contacts, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_contacts: %s\n" % e) @@ -1298,8 +1298,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| Contacts with an array of Contact objects to create in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1317,7 +1317,7 @@ Name | Type | Description | Notes [[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) # **create_credit_note_allocation** -> Allocations create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Allocations create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates allocation for a specific credit note @@ -1350,11 +1350,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841" }, "Amount": 1, "Date": "2019-03-05" } ] } # Allocations | Allocations with array of Allocation object in body of request. -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates allocation for a specific credit note - api_response = api_instance.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_note_allocation: %s\n" % e) @@ -1367,8 +1367,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **allocations** | [**Allocations**](Allocations.md)| Allocations with array of Allocation object in body of request. | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1386,7 +1386,7 @@ Name | Type | Description | Notes [[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) # **create_credit_note_attachment_by_file_name** -> Attachments create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, idempotency_key=idempotency_key, include_online=include_online) +> Attachments create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) Creates an attachment for a specific credit note @@ -1420,11 +1420,11 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment for a specific credit note - api_response = api_instance.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, idempotency_key=idempotency_key, include_online=include_online) + api_response = api_instance.create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_note_attachment_by_file_name: %s\n" % e) @@ -1438,8 +1438,8 @@ Name | Type | Description | Notes **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **include_online** | **bool**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1524,7 +1524,7 @@ Name | Type | Description | Notes [[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) # **create_credit_notes** -> CreditNotes create_credit_notes(xero_tenant_id, credit_notes, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> CreditNotes create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates a new credit note @@ -1556,12 +1556,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | Credit Notes with array of CreditNote object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a new credit note - api_response = api_instance.create_credit_notes(xero_tenant_id, credit_notes, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_credit_notes: %s\n" % e) @@ -1573,9 +1573,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **credit_notes** | [**CreditNotes**](CreditNotes.md)| Credit Notes with array of CreditNote object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1658,7 +1658,7 @@ Name | Type | Description | Notes [[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) # **create_employees** -> Employees create_employees(xero_tenant_id, employees, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Employees create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates new employees used in Xero payrun @@ -1690,11 +1690,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates new employees used in Xero payrun - api_response = api_instance.create_employees(xero_tenant_id, employees, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_employees: %s\n" % e) @@ -1706,8 +1706,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1857,7 +1857,7 @@ Name | Type | Description | Notes [[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) # **create_invoice_attachment_by_file_name** -> Attachments create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, idempotency_key=idempotency_key, include_online=include_online) +> Attachments create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) Creates an attachment for a specific invoice or purchase bill by filename @@ -1891,11 +1891,11 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # str | Name of the attachment body = 'body_example' # str | Byte array of file in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) include_online = False # bool | Allows an attachment to be seen by the end customer within their online invoice (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an attachment for a specific invoice or purchase bill by filename - api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, idempotency_key=idempotency_key, include_online=include_online) + api_response = api_instance.create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, include_online=include_online, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_invoice_attachment_by_file_name: %s\n" % e) @@ -1909,8 +1909,8 @@ Name | Type | Description | Notes **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **file_name** | **str**| Name of the attachment | **body** | **str**| Byte array of file in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **include_online** | **bool**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1995,7 +1995,7 @@ Name | Type | Description | Notes [[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) # **create_invoices** -> Invoices create_invoices(xero_tenant_id, invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> Invoices create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates one or more sales invoices or purchase bills @@ -2027,12 +2027,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | Invoices with an array of invoice objects in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more sales invoices or purchase bills - api_response = api_instance.create_invoices(xero_tenant_id, invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_invoices: %s\n" % e) @@ -2044,9 +2044,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **invoices** | [**Invoices**](Invoices.md)| Invoices with an array of invoice objects in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2131,7 +2131,7 @@ Name | Type | Description | Notes [[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) # **create_items** -> Items create_items(xero_tenant_id, items, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> Items create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Creates one or more items @@ -2163,12 +2163,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant items = { "Items": [ { "Code": "code123", "Name": "Item Name XYZ", "Description": "Foobar", "InventoryAssetAccountCode": "140", "PurchaseDetails": { "COGSAccountCode": "500" } } ] } # Items | Items with an array of Item objects in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more items - api_response = api_instance.create_items(xero_tenant_id, items, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_items: %s\n" % e) @@ -2180,9 +2180,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **items** | [**Items**](Items.md)| Items with an array of Item objects in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2401,7 +2401,7 @@ Name | Type | Description | Notes [[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) # **create_manual_journals** -> ManualJournals create_manual_journals(xero_tenant_id, manual_journals, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> ManualJournals create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or more manual journals @@ -2433,11 +2433,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more manual journals - api_response = api_instance.create_manual_journals(xero_tenant_id, manual_journals, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_manual_journals: %s\n" % e) @@ -2449,8 +2449,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2468,7 +2468,7 @@ Name | Type | Description | Notes [[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) # **create_overpayment_allocations** -> Allocations create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Allocations create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates a single allocation for a specific overpayment @@ -2501,11 +2501,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant overpayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Overpayment allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a single allocation for a specific overpayment - api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_overpayment_allocations: %s\n" % e) @@ -2518,8 +2518,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **overpayment_id** | [**str**](.md)| Unique identifier for a Overpayment | **allocations** | [**Allocations**](Allocations.md)| Allocations array with Allocation object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2801,7 +2801,7 @@ Name | Type | Description | Notes [[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) # **create_payments** -> Payments create_payments(xero_tenant_id, payments, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Payments create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates multiple payments for invoices or credit notes @@ -2833,11 +2833,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates multiple payments for invoices or credit notes - api_response = api_instance.create_payments(xero_tenant_id, payments, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_payments(xero_tenant_id, payments, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_payments: %s\n" % e) @@ -2849,8 +2849,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payments** | [**Payments**](Payments.md)| Payments array with Payment object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2868,7 +2868,7 @@ Name | Type | Description | Notes [[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) # **create_prepayment_allocations** -> Allocations create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Allocations create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Allows you to create an Allocation for prepayments @@ -2901,11 +2901,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant prepayment_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a PrePayment allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Allows you to create an Allocation for prepayments - api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_prepayment_allocations: %s\n" % e) @@ -2918,8 +2918,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **prepayment_id** | [**str**](.md)| Unique identifier for a PrePayment | **allocations** | [**Allocations**](Allocations.md)| Allocations with an array of Allocation object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3140,7 +3140,7 @@ Name | Type | Description | Notes [[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) # **create_purchase_orders** -> PurchaseOrders create_purchase_orders(xero_tenant_id, purchase_orders, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> PurchaseOrders create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or more purchase orders @@ -3172,11 +3172,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more purchase orders - api_response = api_instance.create_purchase_orders(xero_tenant_id, purchase_orders, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_purchase_orders: %s\n" % e) @@ -3188,8 +3188,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| PurchaseOrders with an array of PurchaseOrder object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3343,7 +3343,7 @@ Name | Type | Description | Notes [[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) # **create_quotes** -> Quotes create_quotes(xero_tenant_id, quotes, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Quotes create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Create one or more quotes @@ -3375,11 +3375,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Create one or more quotes - api_response = api_instance.create_quotes(xero_tenant_id, quotes, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_quotes: %s\n" % e) @@ -3391,8 +3391,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| Quotes with an array of Quote object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3410,7 +3410,7 @@ Name | Type | Description | Notes [[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) # **create_receipt** -> Receipts create_receipt(xero_tenant_id, receipts, idempotency_key=idempotency_key, unitdp=unitdp) +> Receipts create_receipt(xero_tenant_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) Creates draft expense claim receipts for any user @@ -3442,11 +3442,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates draft expense claim receipts for any user - api_response = api_instance.create_receipt(xero_tenant_id, receipts, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.create_receipt(xero_tenant_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_receipt: %s\n" % e) @@ -3458,8 +3458,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **receipts** | [**Receipts**](Receipts.md)| Receipts with an array of Receipt object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3749,7 +3749,7 @@ Name | Type | Description | Notes [[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) # **create_repeating_invoices** -> RepeatingInvoices create_repeating_invoices(xero_tenant_id, repeating_invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> RepeatingInvoices create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates one or more repeating invoice templates @@ -3781,11 +3781,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates one or more repeating invoice templates - api_response = api_instance.create_repeating_invoices(xero_tenant_id, repeating_invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->create_repeating_invoices: %s\n" % e) @@ -3797,8 +3797,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13432,7 +13432,7 @@ Name | Type | Description | Notes [[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) # **update_bank_transaction** -> BankTransactions update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, idempotency_key=idempotency_key, unitdp=unitdp) +> BankTransactions update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp, idempotency_key=idempotency_key) Updates a single spent or received money transaction @@ -13465,11 +13465,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # str | Xero generated unique identifier for a bank transaction bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-0000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a single spent or received money transaction - api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_bank_transaction: %s\n" % e) @@ -13482,8 +13482,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transaction_id** | [**str**](.md)| Xero generated unique identifier for a bank transaction | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13840,7 +13840,7 @@ Name | Type | Description | Notes [[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) # **update_credit_note** -> CreditNotes update_credit_note(xero_tenant_id, credit_note_id, credit_notes, idempotency_key=idempotency_key, unitdp=unitdp) +> CreditNotes update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific credit note @@ -13873,11 +13873,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Credit Note credit_notes = { "CreditNotes": [ { "Type": "ACCPAYCREDIT", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date": "2019-01-05", "Status": "AUTHORISED", "Reference": "HelloWorld", "LineItems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400" } ] } ] } # CreditNotes | an array of Credit Notes containing credit note details to update -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific credit note - api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, credit_notes, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.update_credit_note(xero_tenant_id, credit_note_id, credit_notes, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_credit_note: %s\n" % e) @@ -13890,8 +13890,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **credit_note_id** | [**str**](.md)| Unique identifier for a Credit Note | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes containing credit note details to update | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14045,7 +14045,7 @@ Name | Type | Description | Notes [[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) # **update_invoice** -> Invoices update_invoice(xero_tenant_id, invoice_id, invoices, idempotency_key=idempotency_key, unitdp=unitdp) +> Invoices update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific sales invoices or purchase bills @@ -14078,11 +14078,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Invoice invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific sales invoices or purchase bills - api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.update_invoice(xero_tenant_id, invoice_id, invoices, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_invoice: %s\n" % e) @@ -14095,8 +14095,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **invoice_id** | [**str**](.md)| Unique identifier for an Invoice | **invoices** | [**Invoices**](Invoices.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14183,7 +14183,7 @@ Name | Type | Description | Notes [[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) # **update_item** -> Items update_item(xero_tenant_id, item_id, items, idempotency_key=idempotency_key, unitdp=unitdp) +> Items update_item(xero_tenant_id, item_id, items, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific item @@ -14216,11 +14216,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant item_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for an Item items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific item - api_response = api_instance.update_item(xero_tenant_id, item_id, items, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.update_item(xero_tenant_id, item_id, items, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_item: %s\n" % e) @@ -14233,8 +14233,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **item_id** | [**str**](.md)| Unique identifier for an Item | **items** | [**Items**](Items.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14455,7 +14455,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_bank_transactions** -> BankTransactions update_or_create_bank_transactions(xero_tenant_id, bank_transactions, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> BankTransactions update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more spent or received money transaction @@ -14487,12 +14487,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "400" } ], "BankAccount": { "Code": "088" } } ] } # BankTransactions | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more spent or received money transaction - api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bank_transactions, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_bank_transactions(xero_tenant_id, bank_transactions, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_bank_transactions: %s\n" % e) @@ -14504,9 +14504,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14524,7 +14524,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_contacts** -> Contacts update_or_create_contacts(xero_tenant_id, contacts, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Contacts update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Updates or creates one or more contacts in a Xero organisation @@ -14556,11 +14556,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant contacts = { "Contacts": [ { "Name": "Bruce Banner", "EmailAddress": "hulk@avengers.com", "Phones": [ { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415" } ], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } } } ] } # Contacts | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more contacts in a Xero organisation - api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_contacts(xero_tenant_id, contacts, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_contacts: %s\n" % e) @@ -14572,8 +14572,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14591,7 +14591,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_credit_notes** -> CreditNotes update_or_create_credit_notes(xero_tenant_id, credit_notes, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> CreditNotes update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more credit notes @@ -14623,12 +14623,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date":"2019-01-05", "Status":"AUTHORISED", "Reference": "HelloWorld", "LineItems":[ { "Description":"Foobar", "Quantity":2.0, "UnitAmount":20.0, "AccountCode":"400" } ] } ] } # CreditNotes | an array of Credit Notes with a single CreditNote object. -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more credit notes - api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, credit_notes, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_credit_notes(xero_tenant_id, credit_notes, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_credit_notes: %s\n" % e) @@ -14640,9 +14640,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes with a single CreditNote object. | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14660,7 +14660,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_employees** -> Employees update_or_create_employees(xero_tenant_id, employees, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Employees update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates a single new employees used in Xero payrun @@ -14692,11 +14692,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a single new employees used in Xero payrun - api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_employees: %s\n" % e) @@ -14708,8 +14708,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14727,7 +14727,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_invoices** -> Invoices update_or_create_invoices(xero_tenant_id, invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> Invoices update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more sales invoices or purchase bills @@ -14759,12 +14759,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "LineItems": [ { "Description": "Acme Tires", "Quantity": 2, "UnitAmount": 20, "AccountCode": "200", "TaxType": "NONE", "LineAmount": 40 } ], "Date": "2019-03-11", "DueDate": "2018-12-10", "Reference": "Website Design", "Status": "AUTHORISED" } ] } # Invoices | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more sales invoices or purchase bills - api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_invoices(xero_tenant_id, invoices, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_invoices: %s\n" % e) @@ -14776,9 +14776,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **invoices** | [**Invoices**](Invoices.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14796,7 +14796,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_items** -> Items update_or_create_items(xero_tenant_id, items, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) +> Items update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) Updates or creates one or more items @@ -14828,12 +14828,12 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant items = { "Items": [ { "Code": "ItemCode123", "Name": "ItemName XYZ", "Description": "Item Description ABC" } ] } # Items | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more items - api_response = api_instance.update_or_create_items(xero_tenant_id, items, idempotency_key=idempotency_key, summarize_errors=summarize_errors, unitdp=unitdp) + api_response = api_instance.update_or_create_items(xero_tenant_id, items, summarize_errors=summarize_errors, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_items: %s\n" % e) @@ -14845,9 +14845,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **items** | [**Items**](Items.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14865,7 +14865,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_manual_journals** -> ManualJournals update_or_create_manual_journals(xero_tenant_id, manual_journals, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> ManualJournals update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Updates or creates a single manual journal @@ -14897,11 +14897,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates a single manual journal - api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manual_journals, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_manual_journals(xero_tenant_id, manual_journals, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_manual_journals: %s\n" % e) @@ -14913,8 +14913,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14932,7 +14932,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_purchase_orders** -> PurchaseOrders update_or_create_purchase_orders(xero_tenant_id, purchase_orders, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> PurchaseOrders update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Updates or creates one or more purchase orders @@ -14964,11 +14964,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more purchase orders - api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchase_orders, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_purchase_orders(xero_tenant_id, purchase_orders, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_purchase_orders: %s\n" % e) @@ -14980,8 +14980,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14999,7 +14999,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_quotes** -> Quotes update_or_create_quotes(xero_tenant_id, quotes, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> Quotes update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Updates or creates one or more quotes @@ -15031,11 +15031,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates or creates one or more quotes - api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_quotes(xero_tenant_id, quotes, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_quotes: %s\n" % e) @@ -15047,8 +15047,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15066,7 +15066,7 @@ Name | Type | Description | Notes [[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) # **update_or_create_repeating_invoices** -> RepeatingInvoices update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors) +> RepeatingInvoices update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) Creates or deletes one or more repeating invoice templates @@ -15098,11 +15098,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) summarize_errors = False # bool | If false return 200 OK and mix of successfully created objects and any with validation errors (optional) (default to False) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates or deletes one or more repeating invoice templates - api_response = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, idempotency_key=idempotency_key, summarize_errors=summarize_errors) + api_response = api_instance.update_or_create_repeating_invoices(xero_tenant_id, repeating_invoices, summarize_errors=summarize_errors, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_or_create_repeating_invoices: %s\n" % e) @@ -15114,8 +15114,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **summarize_errors** | **bool**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to False] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15405,7 +15405,7 @@ Name | Type | Description | Notes [[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) # **update_receipt** -> Receipts update_receipt(xero_tenant_id, receipt_id, receipts, idempotency_key=idempotency_key, unitdp=unitdp) +> Receipts update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) Updates a specific draft expense claim receipts @@ -15438,11 +15438,11 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # str | Unique identifier for a Receipt receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | -idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Updates a specific draft expense claim receipts - api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, idempotency_key=idempotency_key, unitdp=unitdp) + api_response = api_instance.update_receipt(xero_tenant_id, receipt_id, receipts, unitdp=unitdp, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->update_receipt: %s\n" % e) @@ -15455,8 +15455,8 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **receipt_id** | [**str**](.md)| Unique identifier for a Receipt | **receipts** | [**Receipts**](Receipts.md)| | - **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 1a54f710..0a77a15d 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 328debe7..df0b3522 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib @@ -143,8 +143,8 @@ def create_asset( def create_asset_type( self, xero_tenant_id, + asset_type, idempotency_key=empty, - asset_type=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -153,8 +153,8 @@ def create_asset_type( OAuth2 scope: assets Adds an fixed asset type to the system # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) + :param AssetType asset_type: Asset type to add (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param AssetType asset_type: Asset type to add :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -167,6 +167,12 @@ def create_asset_type( "Missing the required parameter `xero_tenant_id` " "when calling `create_asset_type`" ) + # verify the required parameter 'asset_type' is set + if asset_type is None: + raise ValueError( + "Missing the required parameter `asset_type` " + "when calling `create_asset_type`" + ) collection_formats = {} path_params = {} diff --git a/xero_python/assets/docs/AssetApi.md b/xero_python/assets/docs/AssetApi.md index 9917be0a..c8d6ad37 100644 --- a/xero_python/assets/docs/AssetApi.md +++ b/xero_python/assets/docs/AssetApi.md @@ -80,7 +80,7 @@ Name | Type | Description | Notes [[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) # **create_asset_type** -> AssetType create_asset_type(xero_tenant_id, idempotency_key=idempotency_key, asset_type=asset_type) +> AssetType create_asset_type(xero_tenant_id, asset_type, idempotency_key=idempotency_key) adds a fixed asset type @@ -113,11 +113,11 @@ api_client = ApiClient( api_instance = AssetApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +asset_type = { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -asset_type = { "assetTypeName":"Machinery11004", "fixedAssetAccountId":"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82", "depreciationExpenseAccountId":"d1602f69-f900-4616-8d34-90af393fa368", "accumulatedDepreciationAccountId":"9195cadd-8645-41e6-9f67-7bcd421defe8", "bookDepreciationSetting":{ "depreciationMethod":"DiminishingValue100", "averagingMethod":"ActualDays", "depreciationRate":0.05, "depreciationCalculationMethod":"None" } } # AssetType | Asset type to add (optional) try: # adds a fixed asset type - api_response = api_instance.create_asset_type(xero_tenant_id, idempotency_key=idempotency_key, asset_type=asset_type) + api_response = api_instance.create_asset_type(xero_tenant_id, asset_type, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling AssetApi->create_asset_type: %s\n" % e) @@ -128,8 +128,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | + **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **asset_type** | [**AssetType**](AssetType.md)| Asset type to add | [optional] ### Return type diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index f50ffbc6..932cac2a 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 2.40.3 -- Package version: 1.27.0 +- API version: 3.0.0 +- Package version: 2.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 272a56cc..e2e2a276 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib @@ -60,8 +60,8 @@ def create_file_association( self, xero_tenant_id, file_id, + association, idempotency_key=empty, - association=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -71,8 +71,8 @@ def create_file_association( By passing in the appropriate options, you can create a new folder # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str file_id: File id for single object (required) + :param Association association: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param Association association: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -91,6 +91,12 @@ def create_file_association( "Missing the required parameter `file_id` " "when calling `create_file_association`" ) + # verify the required parameter 'association' is set + if association is None: + raise ValueError( + "Missing the required parameter `association` " + "when calling `create_file_association`" + ) collection_formats = {} path_params = { @@ -148,8 +154,8 @@ def create_file_association( def create_folder( self, xero_tenant_id, + folder, idempotency_key=empty, - folder=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -158,8 +164,8 @@ def create_folder( OAuth2 scope: files By passing in the appropriate properties, you can create a new folder # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Folder folder: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param Folder folder: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -172,6 +178,12 @@ def create_folder( "Missing the required parameter `xero_tenant_id` " "when calling `create_folder`" ) + # verify the required parameter 'folder' is set + if folder is None: + raise ValueError( + "Missing the required parameter `folder` " + "when calling `create_folder`" + ) collection_formats = {} path_params = {} @@ -1182,8 +1194,8 @@ def update_file( self, xero_tenant_id, file_id, + file_object, idempotency_key=empty, - file_object=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -1193,8 +1205,8 @@ def update_file( Updates file properties of a single file # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str file_id: File id for single object (required) + :param FileObject file_object: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param FileObject file_object: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -1212,6 +1224,12 @@ def update_file( raise ValueError( "Missing the required parameter `file_id` " "when calling `update_file`" ) + # verify the required parameter 'file_object' is set + if file_object is None: + raise ValueError( + "Missing the required parameter `file_object` " + "when calling `update_file`" + ) collection_formats = {} path_params = { diff --git a/xero_python/file/docs/FilesApi.md b/xero_python/file/docs/FilesApi.md index e0a1d854..d3eeee1f 100644 --- a/xero_python/file/docs/FilesApi.md +++ b/xero_python/file/docs/FilesApi.md @@ -25,7 +25,7 @@ Method | HTTP request | Description # **create_file_association** -> Association create_file_association(xero_tenant_id, file_id, idempotency_key=idempotency_key, association=association) +> Association create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key) Creates a new file association @@ -59,11 +59,11 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object +association = { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -association = { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | (optional) try: # Creates a new file association - api_response = api_instance.create_file_association(xero_tenant_id, file_id, idempotency_key=idempotency_key, association=association) + api_response = api_instance.create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->create_file_association: %s\n" % e) @@ -75,8 +75,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **file_id** | [**str**](.md)| File id for single object | + **association** | [**Association**](Association.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **association** | [**Association**](Association.md)| | [optional] ### Return type @@ -94,7 +94,7 @@ Name | Type | Description | Notes [[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) # **create_folder** -> Folder create_folder(xero_tenant_id, idempotency_key=idempotency_key, folder=folder) +> Folder create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key) Creates a new folder @@ -127,11 +127,11 @@ api_client = ApiClient( api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +folder = { "Name": "My Docs" } # Folder | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -folder = { "Name": "My Docs" } # Folder | (optional) try: # Creates a new folder - api_response = api_instance.create_folder(xero_tenant_id, idempotency_key=idempotency_key, folder=folder) + api_response = api_instance.create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->create_folder: %s\n" % e) @@ -142,8 +142,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | + **folder** | [**Folder**](Folder.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **folder** | [**Folder**](Folder.md)| | [optional] ### Return type @@ -946,7 +946,7 @@ Name | Type | Description | Notes [[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) # **update_file** -> FileObject update_file(xero_tenant_id, file_id, idempotency_key=idempotency_key, file_object=file_object) +> FileObject update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key) Update a file @@ -980,11 +980,11 @@ api_instance = FilesApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object +file_object = { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -file_object = { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | (optional) try: # Update a file - api_response = api_instance.update_file(xero_tenant_id, file_id, idempotency_key=idempotency_key, file_object=file_object) + api_response = api_instance.update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling FilesApi->update_file: %s\n" % e) @@ -996,8 +996,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **file_id** | [**str**](.md)| File id for single object | + **file_object** | [**FileObject**](FileObject.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **file_object** | [**FileObject**](FileObject.md)| | [optional] ### Return type diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index e2d596ab..54fe3fe6 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index ceb22e17..949300a5 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 9914aa64..01c4e4e5 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib @@ -2172,8 +2172,8 @@ def update_employee( self, xero_tenant_id, employee_id, + employee, idempotency_key=empty, - employee=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2183,8 +2183,8 @@ def update_employee( Update properties on a single employee # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str employee_id: Employee id for single object (required) + :param list[Employee] employee: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param list[Employee] employee: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2203,6 +2203,12 @@ def update_employee( "Missing the required parameter `employee_id` " "when calling `update_employee`" ) + # verify the required parameter 'employee' is set + if employee is None: + raise ValueError( + "Missing the required parameter `employee` " + "when calling `update_employee`" + ) collection_formats = {} path_params = { @@ -2355,8 +2361,8 @@ def update_pay_run( self, xero_tenant_id, pay_run_id, + pay_run, idempotency_key=empty, - pay_run=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2366,8 +2372,8 @@ def update_pay_run( Update properties on a single PayRun # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str pay_run_id: PayRun id for single object (required) + :param list[PayRun] pay_run: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param list[PayRun] pay_run: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2386,6 +2392,12 @@ def update_pay_run( "Missing the required parameter `pay_run_id` " "when calling `update_pay_run`" ) + # verify the required parameter 'pay_run' is set + if pay_run is None: + raise ValueError( + "Missing the required parameter `pay_run` " + "when calling `update_pay_run`" + ) collection_formats = {} path_params = { @@ -2444,8 +2456,8 @@ def update_payslip( self, xero_tenant_id, payslip_id, + payslip_lines, idempotency_key=empty, - payslip_lines=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2455,8 +2467,8 @@ def update_payslip( Update lines on a single payslips # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str payslip_id: Payslip id for single object (required) + :param list[PayslipLines] payslip_lines: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param list[PayslipLines] payslip_lines: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2475,6 +2487,12 @@ def update_payslip( "Missing the required parameter `payslip_id` " "when calling `update_payslip`" ) + # verify the required parameter 'payslip_lines' is set + if payslip_lines is None: + raise ValueError( + "Missing the required parameter `payslip_lines` " + "when calling `update_payslip`" + ) collection_formats = {} path_params = { @@ -2533,8 +2551,8 @@ def update_superfund( self, xero_tenant_id, super_fund_id, + super_fund, idempotency_key=empty, - super_fund=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2544,8 +2562,8 @@ def update_superfund( Update properties on a single Superfund # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str super_fund_id: Superfund id for single object (required) + :param list[SuperFund] super_fund: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param list[SuperFund] super_fund: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2564,6 +2582,12 @@ def update_superfund( "Missing the required parameter `super_fund_id` " "when calling `update_superfund`" ) + # verify the required parameter 'super_fund' is set + if super_fund is None: + raise ValueError( + "Missing the required parameter `super_fund` " + "when calling `update_superfund`" + ) collection_formats = {} path_params = { @@ -2622,8 +2646,8 @@ def update_timesheet( self, xero_tenant_id, timesheet_id, + timesheet, idempotency_key=empty, - timesheet=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -2633,8 +2657,8 @@ def update_timesheet( Update properties on a single timesheet # noqa: E501 :param str xero_tenant_id: Xero identifier for Tenant (required) :param str timesheet_id: Timesheet id for single object (required) + :param list[Timesheet] timesheet: (required) :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - :param list[Timesheet] timesheet: :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -2653,6 +2677,12 @@ def update_timesheet( "Missing the required parameter `timesheet_id` " "when calling `update_timesheet`" ) + # verify the required parameter 'timesheet' is set + if timesheet is None: + raise ValueError( + "Missing the required parameter `timesheet` " + "when calling `update_timesheet`" + ) collection_formats = {} path_params = { diff --git a/xero_python/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md index 5c6c25ee..a71dc4d8 100644 --- a/xero_python/payrollau/docs/PayrollAuApi.md +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -1743,7 +1743,7 @@ Name | Type | Description | Notes [[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) # **update_employee** -> Employees update_employee(xero_tenant_id, employee_id, idempotency_key=idempotency_key, employee=employee) +> Employees update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) Updates an employee's detail @@ -1777,11 +1777,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee = [ { "MiddleNames": "Frank" } ] # list[Employee] | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -employee = [ { "MiddleNames": "Frank" } ] # list[Employee] | (optional) try: # Updates an employee's detail - api_response = api_instance.update_employee(xero_tenant_id, employee_id, idempotency_key=idempotency_key, employee=employee) + api_response = api_instance.update_employee(xero_tenant_id, employee_id, employee, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_employee: %s\n" % e) @@ -1793,8 +1793,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **employee_id** | [**str**](.md)| Employee id for single object | + **employee** | [**list[Employee]**](Employee.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **employee** | [**list[Employee]**](Employee.md)| | [optional] ### Return type @@ -1879,7 +1879,7 @@ Name | Type | Description | Notes [[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) # **update_pay_run** -> PayRuns update_pay_run(xero_tenant_id, pay_run_id, idempotency_key=idempotency_key, pay_run=pay_run) +> PayRuns update_pay_run(xero_tenant_id, pay_run_id, pay_run, idempotency_key=idempotency_key) Updates a pay run @@ -1913,11 +1913,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant pay_run_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | PayRun id for single object +pay_run = [xero_python.payrollau.PayRun()] # list[PayRun] | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -pay_run = [xero_python.payrollau.PayRun()] # list[PayRun] | (optional) try: # Updates a pay run - api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, idempotency_key=idempotency_key, pay_run=pay_run) + api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, pay_run, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_pay_run: %s\n" % e) @@ -1929,8 +1929,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **pay_run_id** | [**str**](.md)| PayRun id for single object | + **pay_run** | [**list[PayRun]**](PayRun.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **pay_run** | [**list[PayRun]**](PayRun.md)| | [optional] ### Return type @@ -1948,7 +1948,7 @@ Name | Type | Description | Notes [[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) # **update_payslip** -> Payslips update_payslip(xero_tenant_id, payslip_id, idempotency_key=idempotency_key, payslip_lines=payslip_lines) +> Payslips update_payslip(xero_tenant_id, payslip_id, payslip_lines, idempotency_key=idempotency_key) Updates a payslip @@ -1982,11 +1982,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant payslip_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Payslip id for single object +payslip_lines = { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # list[PayslipLines] | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -payslip_lines = { "Payslip": { "EmployeeID": "cdfb8371-0b21-4b8a-8903-1024df6c391e", "DeductionLines": [ { "DeductionTypeID": "727af5e8-b347-4ae7-85fc-9b82266d0aec", "CalculationType": "FIXEDAMOUNT", "NumberOfUnits": 10 } ] } } # list[PayslipLines] | (optional) try: # Updates a payslip - api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, idempotency_key=idempotency_key, payslip_lines=payslip_lines) + api_response = api_instance.update_payslip(xero_tenant_id, payslip_id, payslip_lines, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_payslip: %s\n" % e) @@ -1998,8 +1998,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **payslip_id** | [**str**](.md)| Payslip id for single object | + **payslip_lines** | [**list[PayslipLines]**](PayslipLines.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **payslip_lines** | [**list[PayslipLines]**](PayslipLines.md)| | [optional] ### Return type @@ -2017,7 +2017,7 @@ Name | Type | Description | Notes [[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) # **update_superfund** -> SuperFunds update_superfund(xero_tenant_id, super_fund_id, idempotency_key=idempotency_key, super_fund=super_fund) +> SuperFunds update_superfund(xero_tenant_id, super_fund_id, super_fund, idempotency_key=idempotency_key) Updates a superfund @@ -2051,11 +2051,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant super_fund_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Superfund id for single object +super_fund = [ { "Type":"REGULATED", "Name":"Nice23534" } ] # list[SuperFund] | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -super_fund = [ { "Type":"REGULATED", "Name":"Nice23534" } ] # list[SuperFund] | (optional) try: # Updates a superfund - api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, idempotency_key=idempotency_key, super_fund=super_fund) + api_response = api_instance.update_superfund(xero_tenant_id, super_fund_id, super_fund, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_superfund: %s\n" % e) @@ -2067,8 +2067,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **super_fund_id** | [**str**](.md)| Superfund id for single object | + **super_fund** | [**list[SuperFund]**](SuperFund.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **super_fund** | [**list[SuperFund]**](SuperFund.md)| | [optional] ### Return type @@ -2086,7 +2086,7 @@ Name | Type | Description | Notes [[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) # **update_timesheet** -> Timesheets update_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key, timesheet=timesheet) +> Timesheets update_timesheet(xero_tenant_id, timesheet_id, timesheet, idempotency_key=idempotency_key) Updates a timesheet @@ -2120,11 +2120,11 @@ api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant timesheet_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Timesheet id for single object +timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ] # list[Timesheet] | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) -timesheet = [ { "EmployeeID":"b34e89ff-770d-4099-b7e5-f968767118bc", "StartDate":"/Date(1573171200000+0000)/", "EndDate":"/Date(1573689600000+0000)/", "Status":"APPROVED", "Hours":22.0, "TimesheetID":"a7eb0a79-8511-4ee7-b473-3a25f28abcb9", "TimesheetLines":[ { "EarningsRateID":"ab874dfb-ab09-4c91-954e-43acf6fc23b4", "TrackingItemID":"af5e9ce2-2349-4136-be99-3561b189f473", "NumberOfUnits":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], "UpdatedDateUTC":"/Date(1573516185127+0000)/" } ] } ] # list[Timesheet] | (optional) try: # Updates a timesheet - api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key, timesheet=timesheet) + api_response = api_instance.update_timesheet(xero_tenant_id, timesheet_id, timesheet, idempotency_key=idempotency_key) pprint(api_response) except ApiException as e: print("Exception when calling PayrollAuApi->update_timesheet: %s\n" % e) @@ -2136,8 +2136,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **str**| Xero identifier for Tenant | **timesheet_id** | [**str**](.md)| Timesheet id for single object | + **timesheet** | [**list[Timesheet]**](Timesheet.md)| | **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] - **timesheet** | [**list[Timesheet]**](Timesheet.md)| | [optional] ### Return type diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index e182b1a3..61b3e708 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index f2849c9d..5322dbfe 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 918da26a..5d807b9b 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 2.40.3 + OpenAPI spec version: 3.0.0 """ import importlib From 33bc7249ce388dd9db1469a783dcda19f731e129 Mon Sep 17 00:00:00 2001 From: manishT72 <147086188+manishT72@users.noreply.github.com> Date: Thu, 2 May 2024 18:48:23 +0530 Subject: [PATCH 30/79] Build from OAS 3.0.3 --- docs/v1/accounting/index.html | 165 ++++++++++++++++--- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/api/accounting_api.py | 83 +++++++++- xero_python/accounting/docs/AccountingApi.md | 70 +++++++- xero_python/accounting/docs/Payment.md | 1 + xero_python/accounting/models/payment.py | 29 ++++ xero_python/accounting/models/tax_rate.py | 1 + xero_python/accounting/models/tax_type.py | 3 + xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 27 files changed, 338 insertions(+), 56 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index c9611cb9..2c6e41af 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -4377,6 +4377,13 @@ "items" : { "$ref" : "#/components/schemas/ValidationError" } + }, + "Warnings" : { + "type" : "array", + "description" : "Displays array of warning messages from the API", + "items" : { + "$ref" : "#/components/schemas/ValidationError" + } } }, "description" : "", @@ -5632,7 +5639,7 @@ "ReportTaxType" : { "type" : "string", "description" : "See ReportTaxTypes", - "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX" ] + "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX", "BLINPUT3" ] }, "CanApplyToAssets" : { "type" : "boolean", @@ -5697,7 +5704,7 @@ "title" : "", "type" : "string", "description" : "See Tax Types – can only be used on update calls", - "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2" ] + "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2", "BLINPUT3", "BLINPUT3Y23", "BLINPUT3Y24" ] }; defs["TenNinetyNineContact"] = { "title" : "", @@ -6093,7 +6100,7 @@

Parameters

getTaxRateByTaxType

Retrieves a specific tax rate according to given TaxType code

+
+

/TaxRates/{TaxType}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_tax_rate_by_tax_type():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    taxType = 'INPUT2'
+    
+    try:
+        api_response = api_instance.get_tax_rate_by_tax_type(xero_tenant_id, taxType)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->getTaxRateByTaxType: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

accounting.settings	Grant read-write access to organisation and account settings
accounting.settings.read	Grant read-only access to organisation and account settings

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TaxType*	+ + + + + + + String + + + +A valid TaxType code + + + + Required + + + +

Header parameters

+ + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

@@ -38625,10 +38761,9 @@

Usage and SDK Samples

xero_tenant_id = 'YOUR_XERO_TENANT_ID' where = 'Status=="ACTIVE"' order = 'Name ASC' - tax_type = 'INPUT' try: - api_response = api_instance.get_tax_rates(xero_tenant_id, where, order, tax_type) + api_response = api_instance.get_tax_rates(xero_tenant_id, where, order) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getTaxRates: %s\n" % e) @@ -38723,26 +38858,6 @@

Parameters

- - String - - -

-Filter by tax type -

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index f3f2477c..f009fa92 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1392,7 +1392,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index f63b7927..ca55e055 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1155,7 +1155,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 4f3a0273..0cf24d14 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2734,7 +2734,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index a4fdfae8..ed45837d 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index a2820c18..df4947ed 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -3843,7 +3843,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 77528ce1..518052a6 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3510,7 +3510,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index ae74476c..3568d181 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

SDK:
VSN: 2.0.0
VSN: 3.0.0
Methods

createProject diff --git a/setup.py b/setup.py index d5b7f55c..439bcb2e 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="2.0.0", + version="3.0.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 12349889..b58a3b50 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "2.0.0" +__version__ = "3.0.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 70fed9e1..7257ac64 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib @@ -16674,12 +16674,87 @@ def get_reports_list( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_reports_list") + def get_tax_rate_by_tax_type( + self, + xero_tenant_id, + tax_type, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves a specific tax rate according to given TaxType code # noqa: E501 + OAuth2 scope: accounting.settings, accounting.settings.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str tax_type: A valid TaxType code (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TaxRates + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_tax_rate_by_tax_type`" + ) + # verify the required parameter 'tax_type' is set + if tax_type is None: + raise ValueError( + "Missing the required parameter `tax_type` " + "when calling `get_tax_rate_by_tax_type`" + ) + + collection_formats = {} + path_params = { + "TaxType": tax_type, + } + + query_params = [] + + header_params = { + "xero-tenant-id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/TaxRates/{TaxType}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TaxRates", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_tax_rate_by_tax_type") + def get_tax_rates( self, xero_tenant_id, where=empty, order=empty, - tax_type=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -16689,7 +16764,6 @@ def get_tax_rates( :param str xero_tenant_id: Xero identifier for Tenant (required) :param str where: Filter by an any element :param str order: Order by an any element - :param str tax_type: Filter by tax type :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -16714,9 +16788,6 @@ def get_tax_rates( if order is not empty: query_params.append(("order", order)) - if tax_type is not empty: - query_params.append(("TaxType", tax_type)) - header_params = { "xero-tenant-id": xero_tenant_id, } diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 96eb2cc9..5825dda5 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -196,6 +196,7 @@ Method | HTTP request | Description [**get_report_ten_ninety_nine**](AccountingApi.md#get_report_ten_ninety_nine) | **GET** /Reports/TenNinetyNine | Retrieve reports for 1099 [**get_report_trial_balance**](AccountingApi.md#get_report_trial_balance) | **GET** /Reports/TrialBalance | Retrieves report for trial balance [**get_reports_list**](AccountingApi.md#get_reports_list) | **GET** /Reports | Retrieves a list of the organistaions unique reports that require a uuid to fetch +[**get_tax_rate_by_tax_type**](AccountingApi.md#get_tax_rate_by_tax_type) | **GET** /TaxRates/{TaxType} | Retrieves a specific tax rate according to given TaxType code [**get_tax_rates**](AccountingApi.md#get_tax_rates) | **GET** /TaxRates | Retrieves tax rates [**get_tracking_categories**](AccountingApi.md#get_tracking_categories) | **GET** /TrackingCategories | Retrieves tracking categories and options [**get_tracking_category**](AccountingApi.md#get_tracking_category) | **GET** /TrackingCategories/{TrackingCategoryID} | Retrieves specific tracking categories and options using a unique tracking category Id @@ -12903,8 +12904,71 @@ Name | Type | Description | Notes [[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) +# **get_tax_rate_by_tax_type** +> TaxRates get_tax_rate_by_tax_type(xero_tenant_id, tax_type) + +Retrieves a specific tax rate according to given TaxType code + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.accounting import AccountingApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = AccountingApi(api_client) + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant +tax_type = 'INPUT2' # str | A valid TaxType code +try: + # Retrieves a specific tax rate according to given TaxType code + api_response = api_instance.get_tax_rate_by_tax_type(xero_tenant_id, tax_type) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountingApi->get_tax_rate_by_tax_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **tax_type** | **str**| A valid TaxType code | + +### Return type + +[**TaxRates**](TaxRates.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + # **get_tax_rates** -> TaxRates get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) +> TaxRates get_tax_rates(xero_tenant_id, where=where, order=order) Retrieves tax rates @@ -12937,10 +13001,9 @@ api_instance = AccountingApi(api_client) xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant where = 'Status==\"ACTIVE\"' # str | Filter by an any element (optional) order = 'Name ASC' # str | Order by an any element (optional) -tax_type = 'INPUT' # str | Filter by tax type (optional) try: # Retrieves tax rates - api_response = api_instance.get_tax_rates(xero_tenant_id, where=where, order=order, tax_type=tax_type) + api_response = api_instance.get_tax_rates(xero_tenant_id, where=where, order=order) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_tax_rates: %s\n" % e) @@ -12953,7 +13016,6 @@ Name | Type | Description | Notes **xero_tenant_id** | **str**| Xero identifier for Tenant | **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] - **tax_type** | **str**| Filter by tax type | [optional] ### Return type diff --git a/xero_python/accounting/docs/Payment.md b/xero_python/accounting/docs/Payment.md index 44957f6a..d3498524 100644 --- a/xero_python/accounting/docs/Payment.md +++ b/xero_python/accounting/docs/Payment.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes **has_validation_errors** | **bool** | A boolean to indicate if a contact has an validation errors | [optional] [default to False] **status_attribute_string** | **str** | A string to indicate if a invoice status | [optional] **validation_errors** | [**list[ValidationError]**](ValidationError.md) | Displays array of validation error messages from the API | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/models/payment.py b/xero_python/accounting/models/payment.py index bb5f4148..d9fb7e20 100644 --- a/xero_python/accounting/models/payment.py +++ b/xero_python/accounting/models/payment.py @@ -57,6 +57,7 @@ class Payment(BaseModel): "has_validation_errors": "bool", "status_attribute_string": "str", "validation_errors": "list[ValidationError]", + "warnings": "list[ValidationError]", } attribute_map = { @@ -87,6 +88,7 @@ class Payment(BaseModel): "has_validation_errors": "HasValidationErrors", "status_attribute_string": "StatusAttributeString", "validation_errors": "ValidationErrors", + "warnings": "Warnings", } def __init__( @@ -118,6 +120,7 @@ def __init__( has_validation_errors=False, status_attribute_string=None, validation_errors=None, + warnings=None, ): # noqa: E501 """Payment - a model defined in OpenAPI""" # noqa: E501 @@ -148,6 +151,7 @@ def __init__( self._has_validation_errors = None self._status_attribute_string = None self._validation_errors = None + self._warnings = None self.discriminator = None if invoice is not None: @@ -204,6 +208,8 @@ def __init__( self.status_attribute_string = status_attribute_string if validation_errors is not None: self.validation_errors = validation_errors + if warnings is not None: + self.warnings = warnings @property def invoice(self): @@ -841,3 +847,26 @@ def validation_errors(self, validation_errors): """ self._validation_errors = validation_errors + + @property + def warnings(self): + """Gets the warnings of this Payment. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Payment. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Payment. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Payment. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings diff --git a/xero_python/accounting/models/tax_rate.py b/xero_python/accounting/models/tax_rate.py index 498eedec..0934f1e7 100644 --- a/xero_python/accounting/models/tax_rate.py +++ b/xero_python/accounting/models/tax_rate.py @@ -341,6 +341,7 @@ def report_tax_type(self, report_tax_type): "IMRE", "BADDEBTRECOVERY", "USSALESTAX", + "BLINPUT3", "None", ] # noqa: E501 diff --git a/xero_python/accounting/models/tax_type.py b/xero_python/accounting/models/tax_type.py index 453231cd..48908c62 100644 --- a/xero_python/accounting/models/tax_type.py +++ b/xero_python/accounting/models/tax_type.py @@ -144,3 +144,6 @@ class TaxType(Enum): IMREY24 = "IMREY24" BADDEBTRECOVERYY24 = "BADDEBTRECOVERYY24" OSOUTPUT2 = "OSOUTPUT2" + BLINPUT3 = "BLINPUT3" + BLINPUT3Y23 = "BLINPUT3Y23" + BLINPUT3Y24 = "BLINPUT3Y24" diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 0a77a15d..9a48b2dd 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index df0b3522..5c5e730a 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 932cac2a..2281160b 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 3.0.0 -- Package version: 2.0.0 +- API version: 3.0.3 +- Package version: 3.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index e2e2a276..3bf31604 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index 54fe3fe6..543c4e71 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 949300a5..f3b32e9f 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 01c4e4e5..3b189e38 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 61b3e708..8c9ff2dd 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 5322dbfe..26a2dc9b 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 5d807b9b..49e05f38 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.0 + OpenAPI spec version: 3.0.3 """ import importlib From 7def785d248b92524c81b71edd9c3a2c919c9df1 Mon Sep 17 00:00:00 2001 From: manishT72 <147086188+manishT72@users.noreply.github.com> Date: Fri, 3 May 2024 21:50:45 +0530 Subject: [PATCH 31/79] removes jobkeeper allowance type --- docs/v1/payroll-au/index.html | 2 +- xero_python/payrollau/models/allowance_type.py | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index ed45837d..254669bf 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -927,7 +927,7 @@ "title" : "", "type" : "string", "description" : "", - "enum" : [ "CAR", "TRANSPORT", "LAUNDRY", "MEALS", "TRAVEL", "OTHER", "JOBKEEPER", "TOOLS", "TASKS", "QUALIFICATIONS" ] + "enum" : [ "CAR", "TRANSPORT", "LAUNDRY", "MEALS", "TRAVEL", "OTHER", "TOOLS", "TASKS", "QUALIFICATIONS" ] }; defs["BankAccount"] = { "title" : "", diff --git a/xero_python/payrollau/models/allowance_type.py b/xero_python/payrollau/models/allowance_type.py index 970dbeff..9af76362 100644 --- a/xero_python/payrollau/models/allowance_type.py +++ b/xero_python/payrollau/models/allowance_type.py @@ -30,7 +30,6 @@ class AllowanceType(Enum): MEALS = "MEALS" TRAVEL = "TRAVEL" OTHER = "OTHER" - JOBKEEPER = "JOBKEEPER" TOOLS = "TOOLS" TASKS = "TASKS" QUALIFICATIONS = "QUALIFICATIONS" From 6aaad9d92674260e7a452b9b943cc87766c438fb Mon Sep 17 00:00:00 2001 From: OptimusPrime <147086188+manishT72@users.noreply.github.com> Date: Sat, 22 Jun 2024 01:34:09 +0530 Subject: [PATCH 32/79] build from oas 4.0.0 (#134) --- docs/v1/accounting/index.html | 4 +- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 17 +++- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/api/accounting_api.py | 2 +- xero_python/accounting/models/organisation.py | 3 + xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/file/docs/Association.md | 3 + xero_python/file/models/association.py | 93 ++++++++++++++++++- xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 25 files changed, 137 insertions(+), 25 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index 2c6e41af..bae82c09 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -4062,7 +4062,7 @@ "Class" : { "type" : "string", "description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)", - "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE" ] + "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE", "LITE", "IGNITE", "GROW", "COMPREHENSIVE" ] }, "Edition" : { "type" : "string", @@ -6100,7 +6100,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

createAccount diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index 3cbd1c4a..403bb960 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1241,7 +1241,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index f009fa92..6b661cdf 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1392,7 +1392,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index ca55e055..f0874f3c 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -866,6 +866,21 @@ "title" : "", "type" : "object", "properties" : { + "SendWithObject" : { + "type" : "boolean", + "description" : "Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint.", + "example" : true + }, + "Name" : { + "type" : "string", + "description" : "The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint.", + "example" : "Test.pdf" + }, + "Size" : { + "type" : "integer", + "description" : "The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.", + "example" : 12357 + }, "FileId" : { "type" : "string", "description" : "The unique identifier of the file", @@ -1155,7 +1170,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 0cf24d14..ffa9f53c 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2734,7 +2734,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 254669bf..4466a743 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index df4947ed..68def9c3 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -3843,7 +3843,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 518052a6..7d4bb16c 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3510,7 +3510,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 3568d181..2ec3fe0d 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

SDK:
VSN: 3.0.0
VSN: 4.0.0
Methods

createProject diff --git a/setup.py b/setup.py index 439bcb2e..7f408a79 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="3.0.0", + version="4.0.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index b58a3b50..4e3cf907 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "3.0.0" +__version__ = "4.0.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 7257ac64..05189b0d 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/accounting/models/organisation.py b/xero_python/accounting/models/organisation.py index 0bf4b17f..d88f380a 100644 --- a/xero_python/accounting/models/organisation.py +++ b/xero_python/accounting/models/organisation.py @@ -981,6 +981,9 @@ def _class(self, _class): "NON_GST_CASHBOOK", "ULTIMATE", "LITE", + "IGNITE", + "GROW", + "COMPREHENSIVE", "None", ] # noqa: E501 diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 9a48b2dd..aa8e61bb 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 5c5e730a..d66de553 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 2281160b..36f4ac13 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 3.0.3 -- Package version: 3.0.0 +- API version: 4.0.0 +- Package version: 4.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 3bf31604..1fb9315c 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/file/docs/Association.md b/xero_python/file/docs/Association.md index 029356d2..04153507 100644 --- a/xero_python/file/docs/Association.md +++ b/xero_python/file/docs/Association.md @@ -3,6 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**send_with_object** | **bool** | Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**name** | **str** | The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. | [optional] +**size** | **int** | The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. | [optional] **file_id** | **str** | The unique identifier of the file | [optional] **object_id** | **str** | The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID) | [optional] **object_group** | [**ObjectGroup**](ObjectGroup.md) | | [optional] diff --git a/xero_python/file/models/association.py b/xero_python/file/models/association.py index 2b568922..bbc9e41a 100644 --- a/xero_python/file/models/association.py +++ b/xero_python/file/models/association.py @@ -30,6 +30,9 @@ class Association(BaseModel): and the value is json key in definition. """ openapi_types = { + "send_with_object": "bool", + "name": "str", + "size": "int", "file_id": "str", "object_id": "str", "object_group": "ObjectGroup", @@ -37,6 +40,9 @@ class Association(BaseModel): } attribute_map = { + "send_with_object": "SendWithObject", + "name": "Name", + "size": "Size", "file_id": "FileId", "object_id": "ObjectId", "object_group": "ObjectGroup", @@ -44,16 +50,32 @@ class Association(BaseModel): } def __init__( - self, file_id=None, object_id=None, object_group=None, object_type=None + self, + send_with_object=None, + name=None, + size=None, + file_id=None, + object_id=None, + object_group=None, + object_type=None, ): # noqa: E501 """Association - a model defined in OpenAPI""" # noqa: E501 + self._send_with_object = None + self._name = None + self._size = None self._file_id = None self._object_id = None self._object_group = None self._object_type = None self.discriminator = None + if send_with_object is not None: + self.send_with_object = send_with_object + if name is not None: + self.name = name + if size is not None: + self.size = size if file_id is not None: self.file_id = file_id if object_id is not None: @@ -63,6 +85,75 @@ def __init__( if object_type is not None: self.object_type = object_type + @property + def send_with_object(self): + """Gets the send_with_object of this Association. # noqa: E501 + + Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The send_with_object of this Association. # noqa: E501 + :rtype: bool + """ + return self._send_with_object + + @send_with_object.setter + def send_with_object(self, send_with_object): + """Sets the send_with_object of this Association. + + Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param send_with_object: The send_with_object of this Association. # noqa: E501 + :type: bool + """ + + self._send_with_object = send_with_object + + @property + def name(self): + """Gets the name of this Association. # noqa: E501 + + The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The name of this Association. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Association. + + The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param name: The name of this Association. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def size(self): + """Gets the size of this Association. # noqa: E501 + + The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :return: The size of this Association. # noqa: E501 + :rtype: int + """ + return self._size + + @size.setter + def size(self, size): + """Sets the size of this Association. + + The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. # noqa: E501 + + :param size: The size of this Association. # noqa: E501 + :type: int + """ + + self._size = size + @property def file_id(self): """Gets the file_id of this Association. # noqa: E501 diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index 543c4e71..bf2e35a4 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index f3b32e9f..0b5593f5 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 3b189e38..4b36b0f1 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 8c9ff2dd..0c510855 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 26a2dc9b..b66db55c 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 49e05f38..8ff30279 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 3.0.3 + OpenAPI spec version: 4.0.0 """ import importlib From 38e7eb8a93dc67c7815041812d9c6b68c3374c5f Mon Sep 17 00:00:00 2001 From: sangeet-joy-tw <157606431+sangeet-joy-tw@users.noreply.github.com> Date: Mon, 1 Jul 2024 15:12:41 +0530 Subject: [PATCH 33/79] Build from OAS 5.0.0 (#135) * build from OAS 5.0.0 * cleared print statement * adjusted the py test cases * added the page size changes from open api 5.0.0 * test cases commented for now due to wrong data received from api. * python sdk version update * fix test_get_invoices test * test cases fixed * build from latest OAS --------- Co-authored-by: sangeet-joy_xero Co-authored-by: manishT72 <147086188+manishT72@users.noreply.github.com> --- docs/v1/accounting/index.html | 436 +++++++++++++++++- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 35 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- tests/accounting/api/test_accounting_api.py | 17 +- xero_python/accounting/__init__.py | 22 + xero_python/accounting/api/accounting_api.py | 73 ++- xero_python/accounting/docs/AccountingApi.md | 64 ++- .../docs/GetBankTransactionsResponse.md | 15 + .../accounting/docs/GetContactsResponse.md | 15 + .../accounting/docs/GetCreditNotesResponse.md | 15 + .../accounting/docs/GetInvoicesResponse.md | 15 + .../docs/GetManualJournalsResponse.md | 15 + .../docs/GetOverpaymentsResponse.md | 15 + .../accounting/docs/GetPaymentsResponse.md | 15 + .../accounting/docs/GetPrepaymentsResponse.md | 15 + .../docs/GetPurchaseOrdersResponse.md | 15 + xero_python/accounting/docs/PageInfo.md | 13 + xero_python/accounting/models/__init__.py | 22 + .../models/get_bank_transactions_response.py | 206 +++++++++ .../models/get_contacts_response.py | 206 +++++++++ .../models/get_credit_notes_response.py | 206 +++++++++ .../models/get_invoices_response.py | 206 +++++++++ .../models/get_manual_journals_response.py | 206 +++++++++ .../models/get_overpayments_response.py | 206 +++++++++ .../models/get_payments_response.py | 206 +++++++++ .../models/get_prepayments_response.py | 206 +++++++++ .../models/get_purchase_orders_response.py | 206 +++++++++ xero_python/accounting/models/page_info.py | 148 ++++++ xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/finance/api/finance_api.py | 2 +- .../finance/docs/DataSourceResponse.md | 30 +- .../finance/models/data_source_response.py | 60 +-- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 46 files changed, 2808 insertions(+), 137 deletions(-) create mode 100644 xero_python/accounting/docs/GetBankTransactionsResponse.md create mode 100644 xero_python/accounting/docs/GetContactsResponse.md create mode 100644 xero_python/accounting/docs/GetCreditNotesResponse.md create mode 100644 xero_python/accounting/docs/GetInvoicesResponse.md create mode 100644 xero_python/accounting/docs/GetManualJournalsResponse.md create mode 100644 xero_python/accounting/docs/GetOverpaymentsResponse.md create mode 100644 xero_python/accounting/docs/GetPaymentsResponse.md create mode 100644 xero_python/accounting/docs/GetPrepaymentsResponse.md create mode 100644 xero_python/accounting/docs/GetPurchaseOrdersResponse.md create mode 100644 xero_python/accounting/docs/PageInfo.md create mode 100644 xero_python/accounting/models/get_bank_transactions_response.py create mode 100644 xero_python/accounting/models/get_contacts_response.py create mode 100644 xero_python/accounting/models/get_credit_notes_response.py create mode 100644 xero_python/accounting/models/get_invoices_response.py create mode 100644 xero_python/accounting/models/get_manual_journals_response.py create mode 100644 xero_python/accounting/models/get_overpayments_response.py create mode 100644 xero_python/accounting/models/get_payments_response.py create mode 100644 xero_python/accounting/models/get_prepayments_response.py create mode 100644 xero_python/accounting/models/get_purchase_orders_response.py create mode 100644 xero_python/accounting/models/page_info.py diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index bae82c09..29ab224f 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -2859,6 +2859,267 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/organisation/" } +}; + defs["GetBankTransactionsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "BankTransactions" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BankTransaction" + } + } + }, + "description" : "" +}; + defs["GetContactsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Contacts" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Contact" + } + } + }, + "description" : "" +}; + defs["GetCreditNotesResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "CreditNotes" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CreditNote" + } + } + }, + "description" : "" +}; + defs["GetInvoicesResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Invoices" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Invoice" + } + } + }, + "description" : "" +}; + defs["GetManualJournalsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "ManualJournals" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ManualJournal" + } + } + }, + "description" : "" +}; + defs["GetOverpaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Overpayments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Overpayment" + } + } + }, + "description" : "" +}; + defs["GetPaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Payments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Payment" + } + } + }, + "description" : "" +}; + defs["GetPrepaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Prepayments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Prepayment" + } + } + }, + "description" : "" +}; + defs["GetPurchaseOrdersResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "PurchaseOrders" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PurchaseOrder" + } + } + }, + "description" : "" }; defs["HistoryRecord"] = { "title" : "", @@ -4247,6 +4508,25 @@ }, "description" : "", "x-isObjectArray" : true +}; + defs["PageInfo"] = { + "title" : "", + "type" : "object", + "properties" : { + "Page" : { + "type" : "integer" + }, + "PageSize" : { + "type" : "integer" + }, + "TotalPages" : { + "type" : "integer" + }, + "TotalRows" : { + "type" : "integer" + } + }, + "description" : "Pagination information" }; defs["Payment"] = { "title" : "", @@ -6100,7 +6380,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

+ diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index 403bb960..c56f5531 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1241,7 +1241,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index 6b661cdf..cd648d64 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1392,7 +1392,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index f0874f3c..bebe6f93 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1170,7 +1170,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index ffa9f53c..ca4b71c9 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -1529,91 +1529,94 @@ "properties" : { "directBankFeed" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data.", "format" : "double", "x-is-money" : true }, "indirectBankFeed" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data.", + "description" : "No longer in use.", "format" : "double", + "deprecated" : true, "x-is-money" : true }, "fileUpload" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data.", "format" : "double", "x-is-money" : true }, "manual" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data.", + "description" : "Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data.", "format" : "double", "x-is-money" : true }, "directBankFeedPos" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", "format" : "double", "x-is-money" : true }, "indirectBankFeedPos" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", + "description" : "No longer in use.", "format" : "double", + "deprecated" : true, "x-is-money" : true }, "fileUploadPos" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", "format" : "double", "x-is-money" : true }, "manualPos" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", "format" : "double", "x-is-money" : true }, "directBankFeedNeg" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", "format" : "double", "x-is-money" : true }, "indirectBankFeedNeg" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", + "description" : "No longer in use.", "format" : "double", + "deprecated" : true, "x-is-money" : true }, "fileUploadNeg" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", "format" : "double", "x-is-money" : true }, "manualNeg" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", "format" : "double", "x-is-money" : true }, "otherPos" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included.", "format" : "double", "x-is-money" : true }, "otherNeg" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", + "description" : "Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included.", "format" : "double", "x-is-money" : true }, "other" : { "type" : "number", - "description" : "Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data.", + "description" : "Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data.", "format" : "double", "x-is-money" : true } @@ -2734,7 +2737,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 4466a743..aeb99473 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index 68def9c3..61b39c15 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -3843,7 +3843,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 7d4bb16c..9ad370f0 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3510,7 +3510,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 2ec3fe0d..03bd9c89 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

SDK:
VSN: 4.0.0
VSN: 5.0.0
Methods

createProject diff --git a/tests/accounting/api/test_accounting_api.py b/tests/accounting/api/test_accounting_api.py index 77a86362..898d3f80 100644 --- a/tests/accounting/api/test_accounting_api.py +++ b/tests/accounting/api/test_accounting_api.py @@ -29,6 +29,7 @@ LineItem, Attachments, Attachment, + GetInvoicesResponse ) from xero_python.api_client import ApiClient from xero_python.rest import RESTClientObject @@ -94,11 +95,11 @@ def test_invoice_attachment_upload_and_download( """ # 1. get first page of invoices - invoices = accounting_api.get_invoices(xero_tenant_id, page=1) - assert isinstance(invoices, Invoices) - assert len(invoices.invoices) + invoiceResponse = accounting_api.get_invoices(xero_tenant_id, page=1) + assert isinstance(invoiceResponse, GetInvoicesResponse) + assert len(invoiceResponse.invoices) # 2. choose first invoice - invoice = invoices.invoices[0] + invoice = invoiceResponse.invoices[0] assert isinstance(invoice, Invoice) # 3. upload test pdf file as invoice attachment include_online = True @@ -341,7 +342,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): # When getting all invoices result = sandbox_accounting_api.get_invoices(xero_tenant_id) # Then expect correct invoices received - expected = Invoices( + expected = GetInvoicesResponse( invoices=[ Invoice( amount_credited=Decimal("0.00"), @@ -473,7 +474,11 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id): 2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC ), ), - ] + ], + provider_name = 'Provider Name Example', + status = 'OK', + date_time_utc = '/Date(1552326816230)/', + id = '900c500b-e83c-4ce2-902a-b8ba04751748' ) assert result == expected diff --git a/xero_python/accounting/__init__.py b/xero_python/accounting/__init__.py index c5f7c873..c1e7e1ce 100644 --- a/xero_python/accounting/__init__.py +++ b/xero_python/accounting/__init__.py @@ -76,6 +76,27 @@ from xero_python.accounting.models.expense_claim import ExpenseClaim from xero_python.accounting.models.expense_claims import ExpenseClaims from xero_python.accounting.models.external_link import ExternalLink +from xero_python.accounting.models.get_bank_transactions_response import ( + GetBankTransactionsResponse, +) +from xero_python.accounting.models.get_contacts_response import GetContactsResponse +from xero_python.accounting.models.get_credit_notes_response import ( + GetCreditNotesResponse, +) +from xero_python.accounting.models.get_invoices_response import GetInvoicesResponse +from xero_python.accounting.models.get_manual_journals_response import ( + GetManualJournalsResponse, +) +from xero_python.accounting.models.get_overpayments_response import ( + GetOverpaymentsResponse, +) +from xero_python.accounting.models.get_payments_response import GetPaymentsResponse +from xero_python.accounting.models.get_prepayments_response import ( + GetPrepaymentsResponse, +) +from xero_python.accounting.models.get_purchase_orders_response import ( + GetPurchaseOrdersResponse, +) from xero_python.accounting.models.history_record import HistoryRecord from xero_python.accounting.models.history_records import HistoryRecords from xero_python.accounting.models.import_summary import ImportSummary @@ -108,6 +129,7 @@ from xero_python.accounting.models.organisations import Organisations from xero_python.accounting.models.overpayment import Overpayment from xero_python.accounting.models.overpayments import Overpayments +from xero_python.accounting.models.page_info import PageInfo from xero_python.accounting.models.payment import Payment from xero_python.accounting.models.payment_delete import PaymentDelete from xero_python.accounting.models.payment_service import PaymentService diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 05189b0d..0f749e13 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib @@ -7331,6 +7331,7 @@ def get_bank_transactions( order=empty, page=empty, unitdp=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -7343,10 +7344,11 @@ def get_bank_transactions( :param str order: Order by an any element :param int page: Up to 100 bank transactions will be returned in a single API call with line items details :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: BankTransactions + :return: GetBankTransactionsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -7373,6 +7375,9 @@ def get_bank_transactions( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -7403,7 +7408,7 @@ def get_bank_transactions( body=body_params, post_params=form_params, files=local_var_files, - response_type="BankTransactions", + response_type="GetBankTransactionsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9358,6 +9363,7 @@ def get_contacts( include_archived=empty, summary_only=empty, search_term=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -9373,10 +9379,11 @@ def get_contacts( :param bool include_archived: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response :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. :param str search_term: Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Contacts + :return: GetContactsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -9414,6 +9421,9 @@ def get_contacts( if search_term is not empty: query_params.append(("searchTerm", search_term)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -9444,7 +9454,7 @@ def get_contacts( body=body_params, post_params=form_params, files=local_var_files, - response_type="Contacts", + response_type="GetContactsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -9968,6 +9978,7 @@ def get_credit_notes( order=empty, page=empty, unitdp=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -9980,10 +9991,11 @@ def get_credit_notes( :param str order: Order by an any element :param int page: 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 :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: CreditNotes + :return: GetCreditNotesResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -10010,6 +10022,9 @@ def get_credit_notes( if unitdp is not empty: query_params.append(("unitdp", unitdp)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -10040,7 +10055,7 @@ def get_credit_notes( body=body_params, post_params=form_params, files=local_var_files, - response_type="CreditNotes", + response_type="GetCreditNotesResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -11099,6 +11114,7 @@ def get_invoices( created_by_my_app=empty, unitdp=empty, summary_only=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -11118,10 +11134,11 @@ def get_invoices( :param bool created_by_my_app: When set to true you'll only retrieve Invoices created by your app :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts :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. + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Invoices + :return: GetInvoicesResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -11174,6 +11191,9 @@ def get_invoices( if summary_only is not empty: query_params.append(("summaryOnly", summary_only)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -11204,7 +11224,7 @@ def get_invoices( body=body_params, post_params=form_params, files=local_var_files, - response_type="Invoices", + response_type="GetInvoicesResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -12219,6 +12239,7 @@ def get_manual_journals( where=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -12230,10 +12251,11 @@ def get_manual_journals( :param str where: Filter by an any element :param str order: Order by an any element :param int page: e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: ManualJournals + :return: GetManualJournalsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -12257,6 +12279,9 @@ def get_manual_journals( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -12287,7 +12312,7 @@ def get_manual_journals( body=body_params, post_params=form_params, files=local_var_files, - response_type="ManualJournals", + response_type="GetManualJournalsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -12835,7 +12860,7 @@ def get_overpayments( :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Overpayments + :return: GetOverpaymentsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -12892,7 +12917,7 @@ def get_overpayments( body=body_params, post_params=form_params, files=local_var_files, - response_type="Overpayments", + response_type="GetOverpaymentsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -13128,6 +13153,7 @@ def get_payments( where=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -13139,10 +13165,11 @@ def get_payments( :param str where: Filter by an any element :param str order: Order by an any element :param int page: Up to 100 payments will be returned in a single API call + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Payments + :return: GetPaymentsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -13166,6 +13193,9 @@ def get_payments( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -13196,7 +13226,7 @@ def get_payments( body=body_params, post_params=form_params, files=local_var_files, - response_type="Payments", + response_type="GetPaymentsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -13382,7 +13412,7 @@ def get_prepayments( :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: Prepayments + :return: GetPrepaymentsResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -13439,7 +13469,7 @@ def get_prepayments( body=body_params, post_params=form_params, files=local_var_files, - response_type="Prepayments", + response_type="GetPrepaymentsResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, @@ -14039,6 +14069,7 @@ def get_purchase_orders( date_to=empty, order=empty, page=empty, + page_size=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -14052,10 +14083,11 @@ def get_purchase_orders( :param str date_to: Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 :param str order: Order by an any element :param int page: 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. + :param int page_size: Number of records to retrieve per page :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: PurchaseOrders + :return: GetPurchaseOrdersResponse """ # verify the required parameter 'xero_tenant_id' is set @@ -14085,6 +14117,9 @@ def get_purchase_orders( if page is not empty: query_params.append(("page", page)) + if page_size is not empty: + query_params.append(("pageSize", page_size)) + header_params = { "xero-tenant-id": xero_tenant_id, } @@ -14115,7 +14150,7 @@ def get_purchase_orders( body=body_params, post_params=form_params, files=local_var_files, - response_type="PurchaseOrders", + response_type="GetPurchaseOrdersResponse", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 5825dda5..cc78846a 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -5504,7 +5504,7 @@ Name | Type | Description | Notes [[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) # **get_bank_transactions** -> BankTransactions get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> GetBankTransactionsResponse get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) Retrieves any spent or received money transactions @@ -5540,9 +5540,10 @@ where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Type ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 bank transactions will be returned in a single API call with line items details (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves any spent or received money transactions - api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) + api_response = api_instance.get_bank_transactions(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_bank_transactions: %s\n" % e) @@ -5558,10 +5559,11 @@ Name | Type | Description | Notes **order** | **str**| Order by an any element | [optional] **page** | **int**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**BankTransactions**](BankTransactions.md) +[**GetBankTransactionsResponse**](GetBankTransactionsResponse.md) ### Authorization @@ -7119,7 +7121,7 @@ Name | Type | Description | Notes [[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) # **get_contacts** -> Contacts get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term) +> GetContactsResponse get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term, page_size=page_size) Retrieves all contacts in a Xero organisation @@ -7158,9 +7160,10 @@ page = 1 # int | e.g. page=1 - Up to 100 contacts will be returned in a single A include_archived = true # bool | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response (optional) summary_only = False # 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) search_term = 'Joe Bloggs' # str | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves all contacts in a Xero organisation - api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term) + api_response = api_instance.get_contacts(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, page=page, include_archived=include_archived, summary_only=summary_only, search_term=search_term, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_contacts: %s\n" % e) @@ -7179,10 +7182,11 @@ Name | Type | Description | Notes **include_archived** | **bool**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] **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] **search_term** | **str**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**Contacts**](Contacts.md) +[**GetContactsResponse**](GetContactsResponse.md) ### Authorization @@ -7584,7 +7588,7 @@ Name | Type | Description | Notes [[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) # **get_credit_notes** -> CreditNotes get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> GetCreditNotesResponse get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) Retrieves any credit notes @@ -7620,9 +7624,10 @@ where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'CreditNoteNumber ASC' # str | Order by an any element (optional) page = 1 # int | 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) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves any credit notes - api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) + api_response = api_instance.get_credit_notes(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_credit_notes: %s\n" % e) @@ -7638,10 +7643,11 @@ Name | Type | Description | Notes **order** | **str**| Order by an any element | [optional] **page** | **int**| 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] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**CreditNotes**](CreditNotes.md) +[**GetCreditNotesResponse**](GetCreditNotesResponse.md) ### Authorization @@ -8492,7 +8498,7 @@ Name | Type | Description | Notes [[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) # **get_invoices** -> Invoices get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only) +> GetInvoicesResponse get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only, page_size=page_size) Retrieves sales invoices or purchase bills @@ -8535,9 +8541,10 @@ include_archived = true # bool | e.g. includeArchived=true - Invoices with a sta created_by_my_app = false # bool | When set to true you'll only retrieve Invoices created by your app (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) summary_only = False # 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) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves sales invoices or purchase bills - api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only) + api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, i_ds=i_ds, invoice_numbers=invoice_numbers, contact_i_ds=contact_i_ds, statuses=statuses, page=page, include_archived=include_archived, created_by_my_app=created_by_my_app, unitdp=unitdp, summary_only=summary_only, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_invoices: %s\n" % e) @@ -8560,10 +8567,11 @@ Name | Type | Description | Notes **created_by_my_app** | **bool**| When set to true you'll only retrieve Invoices created by your app | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] **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] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**Invoices**](Invoices.md) +[**GetInvoicesResponse**](GetInvoicesResponse.md) ### Authorization @@ -9363,7 +9371,7 @@ Name | Type | Description | Notes [[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) # **get_manual_journals** -> ManualJournals get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) +> GetManualJournalsResponse get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) Retrieves manual journals @@ -9398,9 +9406,10 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"DRAFT\"' # str | Filter by an any element (optional) order = 'Date ASC' # str | Order by an any element (optional) page = 1 # int | 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) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves manual journals - api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + api_response = api_instance.get_manual_journals(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_manual_journals: %s\n" % e) @@ -9415,10 +9424,11 @@ Name | Type | Description | Notes **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| 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] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**ManualJournals**](ManualJournals.md) +[**GetManualJournalsResponse**](GetManualJournalsResponse.md) ### Authorization @@ -9869,7 +9879,7 @@ Name | Type | Description | Notes [[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) # **get_overpayments** -> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> GetOverpaymentsResponse get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) Retrieves overpayments @@ -9926,7 +9936,7 @@ Name | Type | Description | Notes ### Return type -[**Overpayments**](Overpayments.md) +[**GetOverpaymentsResponse**](GetOverpaymentsResponse.md) ### Authorization @@ -10127,7 +10137,7 @@ Name | Type | Description | Notes [[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) # **get_payments** -> Payments get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) +> GetPaymentsResponse get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) Retrieves payments for invoices and credit notes @@ -10162,9 +10172,10 @@ if_modified_since = '2020-02-06T12:17:43.202-08:00' # datetime | Only records cr where = 'Status==\"AUTHORISED\"' # str | Filter by an any element (optional) order = 'Amount ASC' # str | Order by an any element (optional) page = 1 # int | Up to 100 payments will be returned in a single API call (optional) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves payments for invoices and credit notes - api_response = api_instance.get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page) + api_response = api_instance.get_payments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_payments: %s\n" % e) @@ -10179,10 +10190,11 @@ Name | Type | Description | Notes **where** | **str**| Filter by an any element | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| Up to 100 payments will be returned in a single API call | [optional] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**Payments**](Payments.md) +[**GetPaymentsResponse**](GetPaymentsResponse.md) ### Authorization @@ -10322,7 +10334,7 @@ Name | Type | Description | Notes [[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) # **get_prepayments** -> Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) +> GetPrepaymentsResponse get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp) Retrieves prepayments @@ -10379,7 +10391,7 @@ Name | Type | Description | Notes ### Return type -[**Prepayments**](Prepayments.md) +[**GetPrepaymentsResponse**](GetPrepaymentsResponse.md) ### Authorization @@ -10842,7 +10854,7 @@ Name | Type | Description | Notes [[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) # **get_purchase_orders** -> PurchaseOrders get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) +> GetPurchaseOrdersResponse get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page, page_size=page_size) Retrieves purchase orders @@ -10879,9 +10891,10 @@ date_from = '2019-12-01' # str | Filter by purchase order date (e.g. GET https:/ date_to = '2019-12-31' # str | Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 (optional) order = 'PurchaseOrderNumber ASC' # str | Order by an any element (optional) page = 1 # int | 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) +page_size = 100 # int | Number of records to retrieve per page (optional) try: # Retrieves purchase orders - api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page) + api_response = api_instance.get_purchase_orders(xero_tenant_id, if_modified_since=if_modified_since, status=status, date_from=date_from, date_to=date_to, order=order, page=page, page_size=page_size) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_purchase_orders: %s\n" % e) @@ -10898,10 +10911,11 @@ Name | Type | Description | Notes **date_to** | **str**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional] **order** | **str**| Order by an any element | [optional] **page** | **int**| 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] + **page_size** | **int**| Number of records to retrieve per page | [optional] ### Return type -[**PurchaseOrders**](PurchaseOrders.md) +[**GetPurchaseOrdersResponse**](GetPurchaseOrdersResponse.md) ### Authorization diff --git a/xero_python/accounting/docs/GetBankTransactionsResponse.md b/xero_python/accounting/docs/GetBankTransactionsResponse.md new file mode 100644 index 00000000..42a29d99 --- /dev/null +++ b/xero_python/accounting/docs/GetBankTransactionsResponse.md @@ -0,0 +1,15 @@ +# GetBankTransactionsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**bank_transactions** | [**list[BankTransaction]**](BankTransaction.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetContactsResponse.md b/xero_python/accounting/docs/GetContactsResponse.md new file mode 100644 index 00000000..0af1064e --- /dev/null +++ b/xero_python/accounting/docs/GetContactsResponse.md @@ -0,0 +1,15 @@ +# GetContactsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**contacts** | [**list[Contact]**](Contact.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetCreditNotesResponse.md b/xero_python/accounting/docs/GetCreditNotesResponse.md new file mode 100644 index 00000000..0448a411 --- /dev/null +++ b/xero_python/accounting/docs/GetCreditNotesResponse.md @@ -0,0 +1,15 @@ +# GetCreditNotesResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**credit_notes** | [**list[CreditNote]**](CreditNote.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetInvoicesResponse.md b/xero_python/accounting/docs/GetInvoicesResponse.md new file mode 100644 index 00000000..0cf80c40 --- /dev/null +++ b/xero_python/accounting/docs/GetInvoicesResponse.md @@ -0,0 +1,15 @@ +# GetInvoicesResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**invoices** | [**list[Invoice]**](Invoice.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetManualJournalsResponse.md b/xero_python/accounting/docs/GetManualJournalsResponse.md new file mode 100644 index 00000000..8e19aec3 --- /dev/null +++ b/xero_python/accounting/docs/GetManualJournalsResponse.md @@ -0,0 +1,15 @@ +# GetManualJournalsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**manual_journals** | [**list[ManualJournal]**](ManualJournal.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetOverpaymentsResponse.md b/xero_python/accounting/docs/GetOverpaymentsResponse.md new file mode 100644 index 00000000..9d3943f8 --- /dev/null +++ b/xero_python/accounting/docs/GetOverpaymentsResponse.md @@ -0,0 +1,15 @@ +# GetOverpaymentsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**overpayments** | [**list[Overpayment]**](Overpayment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetPaymentsResponse.md b/xero_python/accounting/docs/GetPaymentsResponse.md new file mode 100644 index 00000000..7e95b0bd --- /dev/null +++ b/xero_python/accounting/docs/GetPaymentsResponse.md @@ -0,0 +1,15 @@ +# GetPaymentsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**payments** | [**list[Payment]**](Payment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetPrepaymentsResponse.md b/xero_python/accounting/docs/GetPrepaymentsResponse.md new file mode 100644 index 00000000..962dc54d --- /dev/null +++ b/xero_python/accounting/docs/GetPrepaymentsResponse.md @@ -0,0 +1,15 @@ +# GetPrepaymentsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**prepayments** | [**list[Prepayment]**](Prepayment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/GetPurchaseOrdersResponse.md b/xero_python/accounting/docs/GetPurchaseOrdersResponse.md new file mode 100644 index 00000000..1d50ee85 --- /dev/null +++ b/xero_python/accounting/docs/GetPurchaseOrdersResponse.md @@ -0,0 +1,15 @@ +# GetPurchaseOrdersResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | | [optional] +**provider_name** | **str** | | [optional] +**date_time_utc** | **str** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**purchase_orders** | [**list[PurchaseOrder]**](PurchaseOrder.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/docs/PageInfo.md b/xero_python/accounting/docs/PageInfo.md new file mode 100644 index 00000000..32fec0fd --- /dev/null +++ b/xero_python/accounting/docs/PageInfo.md @@ -0,0 +1,13 @@ +# PageInfo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **int** | | [optional] +**page_size** | **int** | | [optional] +**total_pages** | **int** | | [optional] +**total_rows** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/accounting/models/__init__.py b/xero_python/accounting/models/__init__.py index d98997c3..ced1b6c5 100644 --- a/xero_python/accounting/models/__init__.py +++ b/xero_python/accounting/models/__init__.py @@ -71,6 +71,27 @@ from xero_python.accounting.models.expense_claim import ExpenseClaim from xero_python.accounting.models.expense_claims import ExpenseClaims from xero_python.accounting.models.external_link import ExternalLink +from xero_python.accounting.models.get_bank_transactions_response import ( + GetBankTransactionsResponse, +) +from xero_python.accounting.models.get_contacts_response import GetContactsResponse +from xero_python.accounting.models.get_credit_notes_response import ( + GetCreditNotesResponse, +) +from xero_python.accounting.models.get_invoices_response import GetInvoicesResponse +from xero_python.accounting.models.get_manual_journals_response import ( + GetManualJournalsResponse, +) +from xero_python.accounting.models.get_overpayments_response import ( + GetOverpaymentsResponse, +) +from xero_python.accounting.models.get_payments_response import GetPaymentsResponse +from xero_python.accounting.models.get_prepayments_response import ( + GetPrepaymentsResponse, +) +from xero_python.accounting.models.get_purchase_orders_response import ( + GetPurchaseOrdersResponse, +) from xero_python.accounting.models.history_record import HistoryRecord from xero_python.accounting.models.history_records import HistoryRecords from xero_python.accounting.models.import_summary import ImportSummary @@ -103,6 +124,7 @@ from xero_python.accounting.models.organisations import Organisations from xero_python.accounting.models.overpayment import Overpayment from xero_python.accounting.models.overpayments import Overpayments +from xero_python.accounting.models.page_info import PageInfo from xero_python.accounting.models.payment import Payment from xero_python.accounting.models.payment_delete import PaymentDelete from xero_python.accounting.models.payment_service import PaymentService diff --git a/xero_python/accounting/models/get_bank_transactions_response.py b/xero_python/accounting/models/get_bank_transactions_response.py new file mode 100644 index 00000000..ed8dba6b --- /dev/null +++ b/xero_python/accounting/models/get_bank_transactions_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetBankTransactionsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "bank_transactions": "list[BankTransaction]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "bank_transactions": "BankTransactions", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + bank_transactions=None, + ): # noqa: E501 + """GetBankTransactionsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._bank_transactions = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if bank_transactions is not None: + self.bank_transactions = bank_transactions + + @property + def id(self): + """Gets the id of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The id of this GetBankTransactionsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetBankTransactionsResponse. + + + :param id: The id of this GetBankTransactionsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The status of this GetBankTransactionsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetBankTransactionsResponse. + + + :param status: The status of this GetBankTransactionsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The provider_name of this GetBankTransactionsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetBankTransactionsResponse. + + + :param provider_name: The provider_name of this GetBankTransactionsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetBankTransactionsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetBankTransactionsResponse. + + + :param date_time_utc: The date_time_utc of this GetBankTransactionsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The page_info of this GetBankTransactionsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetBankTransactionsResponse. + + + :param page_info: The page_info of this GetBankTransactionsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def bank_transactions(self): + """Gets the bank_transactions of this GetBankTransactionsResponse. # noqa: E501 + + + :return: The bank_transactions of this GetBankTransactionsResponse. # noqa: E501 + :rtype: list[BankTransaction] + """ + return self._bank_transactions + + @bank_transactions.setter + def bank_transactions(self, bank_transactions): + """Sets the bank_transactions of this GetBankTransactionsResponse. + + + :param bank_transactions: The bank_transactions of this GetBankTransactionsResponse. # noqa: E501 + :type: list[BankTransaction] + """ + + self._bank_transactions = bank_transactions diff --git a/xero_python/accounting/models/get_contacts_response.py b/xero_python/accounting/models/get_contacts_response.py new file mode 100644 index 00000000..4997af2b --- /dev/null +++ b/xero_python/accounting/models/get_contacts_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetContactsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "contacts": "list[Contact]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "contacts": "Contacts", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + contacts=None, + ): # noqa: E501 + """GetContactsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._contacts = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if contacts is not None: + self.contacts = contacts + + @property + def id(self): + """Gets the id of this GetContactsResponse. # noqa: E501 + + + :return: The id of this GetContactsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetContactsResponse. + + + :param id: The id of this GetContactsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetContactsResponse. # noqa: E501 + + + :return: The status of this GetContactsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetContactsResponse. + + + :param status: The status of this GetContactsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetContactsResponse. # noqa: E501 + + + :return: The provider_name of this GetContactsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetContactsResponse. + + + :param provider_name: The provider_name of this GetContactsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetContactsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetContactsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetContactsResponse. + + + :param date_time_utc: The date_time_utc of this GetContactsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetContactsResponse. # noqa: E501 + + + :return: The page_info of this GetContactsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetContactsResponse. + + + :param page_info: The page_info of this GetContactsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def contacts(self): + """Gets the contacts of this GetContactsResponse. # noqa: E501 + + + :return: The contacts of this GetContactsResponse. # noqa: E501 + :rtype: list[Contact] + """ + return self._contacts + + @contacts.setter + def contacts(self, contacts): + """Sets the contacts of this GetContactsResponse. + + + :param contacts: The contacts of this GetContactsResponse. # noqa: E501 + :type: list[Contact] + """ + + self._contacts = contacts diff --git a/xero_python/accounting/models/get_credit_notes_response.py b/xero_python/accounting/models/get_credit_notes_response.py new file mode 100644 index 00000000..945d363c --- /dev/null +++ b/xero_python/accounting/models/get_credit_notes_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetCreditNotesResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "credit_notes": "list[CreditNote]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "credit_notes": "CreditNotes", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + credit_notes=None, + ): # noqa: E501 + """GetCreditNotesResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._credit_notes = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if credit_notes is not None: + self.credit_notes = credit_notes + + @property + def id(self): + """Gets the id of this GetCreditNotesResponse. # noqa: E501 + + + :return: The id of this GetCreditNotesResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetCreditNotesResponse. + + + :param id: The id of this GetCreditNotesResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetCreditNotesResponse. # noqa: E501 + + + :return: The status of this GetCreditNotesResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetCreditNotesResponse. + + + :param status: The status of this GetCreditNotesResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetCreditNotesResponse. # noqa: E501 + + + :return: The provider_name of this GetCreditNotesResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetCreditNotesResponse. + + + :param provider_name: The provider_name of this GetCreditNotesResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetCreditNotesResponse. # noqa: E501 + + + :return: The date_time_utc of this GetCreditNotesResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetCreditNotesResponse. + + + :param date_time_utc: The date_time_utc of this GetCreditNotesResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetCreditNotesResponse. # noqa: E501 + + + :return: The page_info of this GetCreditNotesResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetCreditNotesResponse. + + + :param page_info: The page_info of this GetCreditNotesResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def credit_notes(self): + """Gets the credit_notes of this GetCreditNotesResponse. # noqa: E501 + + + :return: The credit_notes of this GetCreditNotesResponse. # noqa: E501 + :rtype: list[CreditNote] + """ + return self._credit_notes + + @credit_notes.setter + def credit_notes(self, credit_notes): + """Sets the credit_notes of this GetCreditNotesResponse. + + + :param credit_notes: The credit_notes of this GetCreditNotesResponse. # noqa: E501 + :type: list[CreditNote] + """ + + self._credit_notes = credit_notes diff --git a/xero_python/accounting/models/get_invoices_response.py b/xero_python/accounting/models/get_invoices_response.py new file mode 100644 index 00000000..9cf16804 --- /dev/null +++ b/xero_python/accounting/models/get_invoices_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetInvoicesResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "invoices": "list[Invoice]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "invoices": "Invoices", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + invoices=None, + ): # noqa: E501 + """GetInvoicesResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._invoices = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if invoices is not None: + self.invoices = invoices + + @property + def id(self): + """Gets the id of this GetInvoicesResponse. # noqa: E501 + + + :return: The id of this GetInvoicesResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetInvoicesResponse. + + + :param id: The id of this GetInvoicesResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetInvoicesResponse. # noqa: E501 + + + :return: The status of this GetInvoicesResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetInvoicesResponse. + + + :param status: The status of this GetInvoicesResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetInvoicesResponse. # noqa: E501 + + + :return: The provider_name of this GetInvoicesResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetInvoicesResponse. + + + :param provider_name: The provider_name of this GetInvoicesResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetInvoicesResponse. # noqa: E501 + + + :return: The date_time_utc of this GetInvoicesResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetInvoicesResponse. + + + :param date_time_utc: The date_time_utc of this GetInvoicesResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetInvoicesResponse. # noqa: E501 + + + :return: The page_info of this GetInvoicesResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetInvoicesResponse. + + + :param page_info: The page_info of this GetInvoicesResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def invoices(self): + """Gets the invoices of this GetInvoicesResponse. # noqa: E501 + + + :return: The invoices of this GetInvoicesResponse. # noqa: E501 + :rtype: list[Invoice] + """ + return self._invoices + + @invoices.setter + def invoices(self, invoices): + """Sets the invoices of this GetInvoicesResponse. + + + :param invoices: The invoices of this GetInvoicesResponse. # noqa: E501 + :type: list[Invoice] + """ + + self._invoices = invoices diff --git a/xero_python/accounting/models/get_manual_journals_response.py b/xero_python/accounting/models/get_manual_journals_response.py new file mode 100644 index 00000000..807d679a --- /dev/null +++ b/xero_python/accounting/models/get_manual_journals_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetManualJournalsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "manual_journals": "list[ManualJournal]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "manual_journals": "ManualJournals", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + manual_journals=None, + ): # noqa: E501 + """GetManualJournalsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._manual_journals = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if manual_journals is not None: + self.manual_journals = manual_journals + + @property + def id(self): + """Gets the id of this GetManualJournalsResponse. # noqa: E501 + + + :return: The id of this GetManualJournalsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetManualJournalsResponse. + + + :param id: The id of this GetManualJournalsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetManualJournalsResponse. # noqa: E501 + + + :return: The status of this GetManualJournalsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetManualJournalsResponse. + + + :param status: The status of this GetManualJournalsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetManualJournalsResponse. # noqa: E501 + + + :return: The provider_name of this GetManualJournalsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetManualJournalsResponse. + + + :param provider_name: The provider_name of this GetManualJournalsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetManualJournalsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetManualJournalsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetManualJournalsResponse. + + + :param date_time_utc: The date_time_utc of this GetManualJournalsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetManualJournalsResponse. # noqa: E501 + + + :return: The page_info of this GetManualJournalsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetManualJournalsResponse. + + + :param page_info: The page_info of this GetManualJournalsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def manual_journals(self): + """Gets the manual_journals of this GetManualJournalsResponse. # noqa: E501 + + + :return: The manual_journals of this GetManualJournalsResponse. # noqa: E501 + :rtype: list[ManualJournal] + """ + return self._manual_journals + + @manual_journals.setter + def manual_journals(self, manual_journals): + """Sets the manual_journals of this GetManualJournalsResponse. + + + :param manual_journals: The manual_journals of this GetManualJournalsResponse. # noqa: E501 + :type: list[ManualJournal] + """ + + self._manual_journals = manual_journals diff --git a/xero_python/accounting/models/get_overpayments_response.py b/xero_python/accounting/models/get_overpayments_response.py new file mode 100644 index 00000000..2a51fe95 --- /dev/null +++ b/xero_python/accounting/models/get_overpayments_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetOverpaymentsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "overpayments": "list[Overpayment]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "overpayments": "Overpayments", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + overpayments=None, + ): # noqa: E501 + """GetOverpaymentsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._overpayments = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if overpayments is not None: + self.overpayments = overpayments + + @property + def id(self): + """Gets the id of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The id of this GetOverpaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetOverpaymentsResponse. + + + :param id: The id of this GetOverpaymentsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The status of this GetOverpaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetOverpaymentsResponse. + + + :param status: The status of this GetOverpaymentsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The provider_name of this GetOverpaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetOverpaymentsResponse. + + + :param provider_name: The provider_name of this GetOverpaymentsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetOverpaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetOverpaymentsResponse. + + + :param date_time_utc: The date_time_utc of this GetOverpaymentsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The page_info of this GetOverpaymentsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetOverpaymentsResponse. + + + :param page_info: The page_info of this GetOverpaymentsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def overpayments(self): + """Gets the overpayments of this GetOverpaymentsResponse. # noqa: E501 + + + :return: The overpayments of this GetOverpaymentsResponse. # noqa: E501 + :rtype: list[Overpayment] + """ + return self._overpayments + + @overpayments.setter + def overpayments(self, overpayments): + """Sets the overpayments of this GetOverpaymentsResponse. + + + :param overpayments: The overpayments of this GetOverpaymentsResponse. # noqa: E501 + :type: list[Overpayment] + """ + + self._overpayments = overpayments diff --git a/xero_python/accounting/models/get_payments_response.py b/xero_python/accounting/models/get_payments_response.py new file mode 100644 index 00000000..b3bf5451 --- /dev/null +++ b/xero_python/accounting/models/get_payments_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetPaymentsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "payments": "list[Payment]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "payments": "Payments", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + payments=None, + ): # noqa: E501 + """GetPaymentsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._payments = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if payments is not None: + self.payments = payments + + @property + def id(self): + """Gets the id of this GetPaymentsResponse. # noqa: E501 + + + :return: The id of this GetPaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetPaymentsResponse. + + + :param id: The id of this GetPaymentsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetPaymentsResponse. # noqa: E501 + + + :return: The status of this GetPaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetPaymentsResponse. + + + :param status: The status of this GetPaymentsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetPaymentsResponse. # noqa: E501 + + + :return: The provider_name of this GetPaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetPaymentsResponse. + + + :param provider_name: The provider_name of this GetPaymentsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetPaymentsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetPaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetPaymentsResponse. + + + :param date_time_utc: The date_time_utc of this GetPaymentsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetPaymentsResponse. # noqa: E501 + + + :return: The page_info of this GetPaymentsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetPaymentsResponse. + + + :param page_info: The page_info of this GetPaymentsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def payments(self): + """Gets the payments of this GetPaymentsResponse. # noqa: E501 + + + :return: The payments of this GetPaymentsResponse. # noqa: E501 + :rtype: list[Payment] + """ + return self._payments + + @payments.setter + def payments(self, payments): + """Sets the payments of this GetPaymentsResponse. + + + :param payments: The payments of this GetPaymentsResponse. # noqa: E501 + :type: list[Payment] + """ + + self._payments = payments diff --git a/xero_python/accounting/models/get_prepayments_response.py b/xero_python/accounting/models/get_prepayments_response.py new file mode 100644 index 00000000..468762f5 --- /dev/null +++ b/xero_python/accounting/models/get_prepayments_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetPrepaymentsResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "prepayments": "list[Prepayment]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "prepayments": "Prepayments", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + prepayments=None, + ): # noqa: E501 + """GetPrepaymentsResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._prepayments = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if prepayments is not None: + self.prepayments = prepayments + + @property + def id(self): + """Gets the id of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The id of this GetPrepaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetPrepaymentsResponse. + + + :param id: The id of this GetPrepaymentsResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The status of this GetPrepaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetPrepaymentsResponse. + + + :param status: The status of this GetPrepaymentsResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The provider_name of this GetPrepaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetPrepaymentsResponse. + + + :param provider_name: The provider_name of this GetPrepaymentsResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The date_time_utc of this GetPrepaymentsResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetPrepaymentsResponse. + + + :param date_time_utc: The date_time_utc of this GetPrepaymentsResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The page_info of this GetPrepaymentsResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetPrepaymentsResponse. + + + :param page_info: The page_info of this GetPrepaymentsResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def prepayments(self): + """Gets the prepayments of this GetPrepaymentsResponse. # noqa: E501 + + + :return: The prepayments of this GetPrepaymentsResponse. # noqa: E501 + :rtype: list[Prepayment] + """ + return self._prepayments + + @prepayments.setter + def prepayments(self, prepayments): + """Sets the prepayments of this GetPrepaymentsResponse. + + + :param prepayments: The prepayments of this GetPrepaymentsResponse. # noqa: E501 + :type: list[Prepayment] + """ + + self._prepayments = prepayments diff --git a/xero_python/accounting/models/get_purchase_orders_response.py b/xero_python/accounting/models/get_purchase_orders_response.py new file mode 100644 index 00000000..7fb6427d --- /dev/null +++ b/xero_python/accounting/models/get_purchase_orders_response.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class GetPurchaseOrdersResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "id": "str", + "status": "str", + "provider_name": "str", + "date_time_utc": "str", + "page_info": "PageInfo", + "purchase_orders": "list[PurchaseOrder]", + } + + attribute_map = { + "id": "Id", + "status": "Status", + "provider_name": "ProviderName", + "date_time_utc": "DateTimeUTC", + "page_info": "PageInfo", + "purchase_orders": "PurchaseOrders", + } + + def __init__( + self, + id=None, + status=None, + provider_name=None, + date_time_utc=None, + page_info=None, + purchase_orders=None, + ): # noqa: E501 + """GetPurchaseOrdersResponse - a model defined in OpenAPI""" # noqa: E501 + + self._id = None + self._status = None + self._provider_name = None + self._date_time_utc = None + self._page_info = None + self._purchase_orders = None + self.discriminator = None + + if id is not None: + self.id = id + if status is not None: + self.status = status + if provider_name is not None: + self.provider_name = provider_name + if date_time_utc is not None: + self.date_time_utc = date_time_utc + if page_info is not None: + self.page_info = page_info + if purchase_orders is not None: + self.purchase_orders = purchase_orders + + @property + def id(self): + """Gets the id of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The id of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetPurchaseOrdersResponse. + + + :param id: The id of this GetPurchaseOrdersResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def status(self): + """Gets the status of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The status of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this GetPurchaseOrdersResponse. + + + :param status: The status of this GetPurchaseOrdersResponse. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def provider_name(self): + """Gets the provider_name of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The provider_name of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: str + """ + return self._provider_name + + @provider_name.setter + def provider_name(self, provider_name): + """Sets the provider_name of this GetPurchaseOrdersResponse. + + + :param provider_name: The provider_name of this GetPurchaseOrdersResponse. # noqa: E501 + :type: str + """ + + self._provider_name = provider_name + + @property + def date_time_utc(self): + """Gets the date_time_utc of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The date_time_utc of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: str + """ + return self._date_time_utc + + @date_time_utc.setter + def date_time_utc(self, date_time_utc): + """Sets the date_time_utc of this GetPurchaseOrdersResponse. + + + :param date_time_utc: The date_time_utc of this GetPurchaseOrdersResponse. # noqa: E501 + :type: str + """ + + self._date_time_utc = date_time_utc + + @property + def page_info(self): + """Gets the page_info of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The page_info of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: PageInfo + """ + return self._page_info + + @page_info.setter + def page_info(self, page_info): + """Sets the page_info of this GetPurchaseOrdersResponse. + + + :param page_info: The page_info of this GetPurchaseOrdersResponse. # noqa: E501 + :type: PageInfo + """ + + self._page_info = page_info + + @property + def purchase_orders(self): + """Gets the purchase_orders of this GetPurchaseOrdersResponse. # noqa: E501 + + + :return: The purchase_orders of this GetPurchaseOrdersResponse. # noqa: E501 + :rtype: list[PurchaseOrder] + """ + return self._purchase_orders + + @purchase_orders.setter + def purchase_orders(self, purchase_orders): + """Sets the purchase_orders of this GetPurchaseOrdersResponse. + + + :param purchase_orders: The purchase_orders of this GetPurchaseOrdersResponse. # noqa: E501 + :type: list[PurchaseOrder] + """ + + self._purchase_orders = purchase_orders diff --git a/xero_python/accounting/models/page_info.py b/xero_python/accounting/models/page_info.py new file mode 100644 index 00000000..00179639 --- /dev/null +++ b/xero_python/accounting/models/page_info.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" + Xero Accounting API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class PageInfo(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "page": "int", + "page_size": "int", + "total_pages": "int", + "total_rows": "int", + } + + attribute_map = { + "page": "Page", + "page_size": "PageSize", + "total_pages": "TotalPages", + "total_rows": "TotalRows", + } + + def __init__( + self, page=None, page_size=None, total_pages=None, total_rows=None + ): # noqa: E501 + """PageInfo - a model defined in OpenAPI""" # noqa: E501 + + self._page = None + self._page_size = None + self._total_pages = None + self._total_rows = None + self.discriminator = None + + if page is not None: + self.page = page + if page_size is not None: + self.page_size = page_size + if total_pages is not None: + self.total_pages = total_pages + if total_rows is not None: + self.total_rows = total_rows + + @property + def page(self): + """Gets the page of this PageInfo. # noqa: E501 + + + :return: The page of this PageInfo. # noqa: E501 + :rtype: int + """ + return self._page + + @page.setter + def page(self, page): + """Sets the page of this PageInfo. + + + :param page: The page of this PageInfo. # noqa: E501 + :type: int + """ + + self._page = page + + @property + def page_size(self): + """Gets the page_size of this PageInfo. # noqa: E501 + + + :return: The page_size of this PageInfo. # noqa: E501 + :rtype: int + """ + return self._page_size + + @page_size.setter + def page_size(self, page_size): + """Sets the page_size of this PageInfo. + + + :param page_size: The page_size of this PageInfo. # noqa: E501 + :type: int + """ + + self._page_size = page_size + + @property + def total_pages(self): + """Gets the total_pages of this PageInfo. # noqa: E501 + + + :return: The total_pages of this PageInfo. # noqa: E501 + :rtype: int + """ + return self._total_pages + + @total_pages.setter + def total_pages(self, total_pages): + """Sets the total_pages of this PageInfo. + + + :param total_pages: The total_pages of this PageInfo. # noqa: E501 + :type: int + """ + + self._total_pages = total_pages + + @property + def total_rows(self): + """Gets the total_rows of this PageInfo. # noqa: E501 + + + :return: The total_rows of this PageInfo. # noqa: E501 + :rtype: int + """ + return self._total_rows + + @total_rows.setter + def total_rows(self, total_rows): + """Sets the total_rows of this PageInfo. + + + :param total_rows: The total_rows of this PageInfo. # noqa: E501 + :type: int + """ + + self._total_rows = total_rows diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index aa8e61bb..49c48642 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index d66de553..eb17e0d5 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 36f4ac13..d135791e 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 4.0.0 -- Package version: 4.0.0 +- API version: 5.0.0 +- Package version: 5.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 1fb9315c..11641c35 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index bf2e35a4..b94d1650 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/finance/docs/DataSourceResponse.md b/xero_python/finance/docs/DataSourceResponse.md index 6e8ceffd..cf0841f5 100644 --- a/xero_python/finance/docs/DataSourceResponse.md +++ b/xero_python/finance/docs/DataSourceResponse.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**direct_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**indirect_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. | [optional] -**file_upload** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**manual** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] -**direct_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**indirect_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**file_upload_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**manual_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**direct_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**indirect_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**file_upload_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**manual_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**other_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] -**other_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] -**other** | **float** | Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. | [optional] +**direct_bank_feed** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. | [optional] +**indirect_bank_feed** | **float** | No longer in use. | [optional] +**file_upload** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] +**manual** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. | [optional] +**direct_bank_feed_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**indirect_bank_feed_pos** | **float** | No longer in use. | [optional] +**file_upload_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**manual_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**direct_bank_feed_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**indirect_bank_feed_neg** | **float** | No longer in use. | [optional] +**file_upload_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**manual_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**other_pos** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] +**other_neg** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. | [optional] +**other** | **float** | Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/finance/models/data_source_response.py b/xero_python/finance/models/data_source_response.py index a3b33ba6..44cf283f 100644 --- a/xero_python/finance/models/data_source_response.py +++ b/xero_python/finance/models/data_source_response.py @@ -137,7 +137,7 @@ def __init__( def direct_bank_feed(self): """Gets the direct_bank_feed of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The direct_bank_feed of this DataSourceResponse. # noqa: E501 :rtype: float @@ -148,7 +148,7 @@ def direct_bank_feed(self): def direct_bank_feed(self, direct_bank_feed): """Sets the direct_bank_feed of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param direct_bank_feed: The direct_bank_feed of this DataSourceResponse. # noqa: E501 :type: float @@ -160,7 +160,7 @@ def direct_bank_feed(self, direct_bank_feed): def indirect_bank_feed(self): """Gets the indirect_bank_feed of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. # noqa: E501 + No longer in use. # noqa: E501 :return: The indirect_bank_feed of this DataSourceResponse. # noqa: E501 :rtype: float @@ -171,7 +171,7 @@ def indirect_bank_feed(self): def indirect_bank_feed(self, indirect_bank_feed): """Sets the indirect_bank_feed of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. # noqa: E501 + No longer in use. # noqa: E501 :param indirect_bank_feed: The indirect_bank_feed of this DataSourceResponse. # noqa: E501 :type: float @@ -183,7 +183,7 @@ def indirect_bank_feed(self, indirect_bank_feed): def file_upload(self): """Gets the file_upload of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The file_upload of this DataSourceResponse. # noqa: E501 :rtype: float @@ -194,7 +194,7 @@ def file_upload(self): def file_upload(self, file_upload): """Sets the file_upload of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param file_upload: The file_upload of this DataSourceResponse. # noqa: E501 :type: float @@ -206,7 +206,7 @@ def file_upload(self, file_upload): def manual(self): """Gets the manual of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The manual of this DataSourceResponse. # noqa: E501 :rtype: float @@ -217,7 +217,7 @@ def manual(self): def manual(self, manual): """Sets the manual of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param manual: The manual of this DataSourceResponse. # noqa: E501 :type: float @@ -229,7 +229,7 @@ def manual(self, manual): def direct_bank_feed_pos(self): """Gets the direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -240,7 +240,7 @@ def direct_bank_feed_pos(self): def direct_bank_feed_pos(self, direct_bank_feed_pos): """Sets the direct_bank_feed_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param direct_bank_feed_pos: The direct_bank_feed_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -252,7 +252,7 @@ def direct_bank_feed_pos(self, direct_bank_feed_pos): def indirect_bank_feed_pos(self): """Gets the indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + No longer in use. # noqa: E501 :return: The indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -263,7 +263,7 @@ def indirect_bank_feed_pos(self): def indirect_bank_feed_pos(self, indirect_bank_feed_pos): """Sets the indirect_bank_feed_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + No longer in use. # noqa: E501 :param indirect_bank_feed_pos: The indirect_bank_feed_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -275,7 +275,7 @@ def indirect_bank_feed_pos(self, indirect_bank_feed_pos): def file_upload_pos(self): """Gets the file_upload_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The file_upload_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -286,7 +286,7 @@ def file_upload_pos(self): def file_upload_pos(self, file_upload_pos): """Sets the file_upload_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param file_upload_pos: The file_upload_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -298,7 +298,7 @@ def file_upload_pos(self, file_upload_pos): def manual_pos(self): """Gets the manual_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The manual_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -309,7 +309,7 @@ def manual_pos(self): def manual_pos(self, manual_pos): """Sets the manual_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param manual_pos: The manual_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -321,7 +321,7 @@ def manual_pos(self, manual_pos): def direct_bank_feed_neg(self): """Gets the direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -332,7 +332,7 @@ def direct_bank_feed_neg(self): def direct_bank_feed_neg(self, direct_bank_feed_neg): """Sets the direct_bank_feed_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration. This could be from a bank or aggregator. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param direct_bank_feed_neg: The direct_bank_feed_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -344,7 +344,7 @@ def direct_bank_feed_neg(self, direct_bank_feed_neg): def indirect_bank_feed_neg(self): """Gets the indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + No longer in use. # noqa: E501 :return: The indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -355,7 +355,7 @@ def indirect_bank_feed_neg(self): def indirect_bank_feed_neg(self, indirect_bank_feed_neg): """Sets the indirect_bank_feed_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee). This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + No longer in use. # noqa: E501 :param indirect_bank_feed_neg: The indirect_bank_feed_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -367,7 +367,7 @@ def indirect_bank_feed_neg(self, indirect_bank_feed_neg): def file_upload_neg(self): """Gets the file_upload_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The file_upload_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -378,7 +378,7 @@ def file_upload_neg(self): def file_upload_neg(self, file_upload_neg): """Sets the file_upload_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param file_upload_neg: The file_upload_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -390,7 +390,7 @@ def file_upload_neg(self, file_upload_neg): def manual_neg(self): """Gets the manual_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The manual_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -401,7 +401,7 @@ def manual_neg(self): def manual_neg(self, manual_neg): """Sets the manual_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was manually input in to Xero. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param manual_neg: The manual_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -413,7 +413,7 @@ def manual_neg(self, manual_neg): def other_pos(self): """Gets the other_pos of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :return: The other_pos of this DataSourceResponse. # noqa: E501 :rtype: float @@ -424,7 +424,7 @@ def other_pos(self): def other_pos(self, other_pos): """Sets the other_pos of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only positive transactions are included. # noqa: E501 :param other_pos: The other_pos of this DataSourceResponse. # noqa: E501 :type: float @@ -436,7 +436,7 @@ def other_pos(self, other_pos): def other_neg(self): """Gets the other_neg of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :return: The other_neg of this DataSourceResponse. # noqa: E501 :rtype: float @@ -447,7 +447,7 @@ def other_neg(self): def other_neg(self, other_neg): """Sets the other_neg of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. Only negative transactions are included. # noqa: E501 :param other_neg: The other_neg of this DataSourceResponse. # noqa: E501 :type: float @@ -459,7 +459,7 @@ def other_neg(self, other_neg): def other(self): """Gets the other of this DataSourceResponse. # noqa: E501 - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. # noqa: E501 :return: The other of this DataSourceResponse. # noqa: E501 :rtype: float @@ -470,7 +470,7 @@ def other(self): def other(self, other): """Sets the other of this DataSourceResponse. - Sum of the amounts of all statement lines where the source of the data was any other category. This gives an indication on the certainty of correctness of the data. # noqa: E501 + Sum of the amounts of all statement lines where the source of the data was unknown. This gives an indication on the certainty of correctness of the data. # noqa: E501 :param other: The other of this DataSourceResponse. # noqa: E501 :type: float diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 0b5593f5..a801f141 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 4b36b0f1..a050c796 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 0c510855..e81cb80d 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index b66db55c..a7e6b521 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 8ff30279..b94a295b 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 4.0.0 + OpenAPI spec version: 5.0.0 """ import importlib From b0d3c2c5c30d671bb2739072226072912da98c49 Mon Sep 17 00:00:00 2001 From: OptimusPrime <147086188+manishT72@users.noreply.github.com> Date: Mon, 1 Jul 2024 15:29:48 +0530 Subject: [PATCH 34/79] Bump version to 5.0.0 (#136) Bump version to 5.0.0 --- setup.py | 2 +- xero_python/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 7f408a79..59e939c7 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="4.0.0", + version="5.0.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 4e3cf907..597bfa3c 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "4.0.0" +__version__ = "5.0.0" From 25a6d3eb2e03a6205de966336e51ac44a7bcfc88 Mon Sep 17 00:00:00 2001 From: sangeet-joy_xero Date: Fri, 12 Jul 2024 13:30:40 +0530 Subject: [PATCH 35/79] Build from OAS 6.0.0 --- docs/v1/accounting/index.html | 381 +++++------------- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- setup.py | 2 +- tests/accounting/api/test_accounting_api.py | 9 +- xero_python/__init__.py | 2 +- xero_python/accounting/__init__.py | 23 +- xero_python/accounting/api/accounting_api.py | 53 ++- xero_python/accounting/docs/AccountingApi.md | 48 ++- .../accounting/docs/BankTransactions.md | 1 + xero_python/accounting/docs/Contacts.md | 1 + xero_python/accounting/docs/CreditNotes.md | 1 + xero_python/accounting/docs/Invoices.md | 1 + xero_python/accounting/docs/ManualJournals.md | 1 + xero_python/accounting/docs/Overpayments.md | 1 + xero_python/accounting/docs/Pagination.md | 13 + xero_python/accounting/docs/Payments.md | 1 + xero_python/accounting/docs/Prepayments.md | 1 + xero_python/accounting/docs/PurchaseOrders.md | 1 + xero_python/accounting/models/__init__.py | 23 +- .../accounting/models/bank_transactions.py | 36 +- xero_python/accounting/models/contacts.py | 30 +- xero_python/accounting/models/credit_notes.py | 30 +- xero_python/accounting/models/invoices.py | 30 +- .../accounting/models/manual_journals.py | 33 +- xero_python/accounting/models/overpayments.py | 30 +- xero_python/accounting/models/pagination.py | 148 +++++++ xero_python/accounting/models/payments.py | 30 +- xero_python/accounting/models/prepayments.py | 30 +- .../accounting/models/purchase_orders.py | 33 +- xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 46 files changed, 615 insertions(+), 416 deletions(-) create mode 100644 xero_python/accounting/docs/Pagination.md create mode 100644 xero_python/accounting/models/pagination.py diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index 29ab224f..65c8b328 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -1465,6 +1465,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "BankTransactions" : { "type" : "array", "items" : { @@ -2320,6 +2323,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "Contacts" : { "type" : "array", "items" : { @@ -2555,6 +2561,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "CreditNotes" : { "type" : "array", "items" : { @@ -2859,267 +2868,6 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/organisation/" } -}; - defs["GetBankTransactionsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "BankTransactions" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/BankTransaction" - } - } - }, - "description" : "" -}; - defs["GetContactsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "Contacts" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Contact" - } - } - }, - "description" : "" -}; - defs["GetCreditNotesResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "CreditNotes" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CreditNote" - } - } - }, - "description" : "" -}; - defs["GetInvoicesResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "Invoices" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Invoice" - } - } - }, - "description" : "" -}; - defs["GetManualJournalsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "ManualJournals" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/ManualJournal" - } - } - }, - "description" : "" -}; - defs["GetOverpaymentsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "Overpayments" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Overpayment" - } - } - }, - "description" : "" -}; - defs["GetPaymentsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "Payments" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Payment" - } - } - }, - "description" : "" -}; - defs["GetPrepaymentsResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "Prepayments" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Prepayment" - } - } - }, - "description" : "" -}; - defs["GetPurchaseOrdersResponse"] = { - "title" : "", - "type" : "object", - "properties" : { - "Id" : { - "type" : "string" - }, - "Status" : { - "type" : "string" - }, - "ProviderName" : { - "type" : "string" - }, - "DateTimeUTC" : { - "type" : "string" - }, - "PageInfo" : { - "$ref" : "#/components/schemas/PageInfo" - }, - "PurchaseOrders" : { - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PurchaseOrder" - } - } - }, - "description" : "" }; defs["HistoryRecord"] = { "title" : "", @@ -3529,6 +3277,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "Invoices" : { "type" : "array", "items" : { @@ -4165,6 +3916,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "ManualJournals" : { "type" : "array", "items" : { @@ -4499,6 +4253,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "Overpayments" : { "type" : "array", "items" : { @@ -4509,24 +4266,24 @@ "description" : "", "x-isObjectArray" : true }; - defs["PageInfo"] = { + defs["Pagination"] = { "title" : "", "type" : "object", "properties" : { - "Page" : { + "page" : { "type" : "integer" }, - "PageSize" : { + "pageSize" : { "type" : "integer" }, - "TotalPages" : { + "pageCount" : { "type" : "integer" }, - "TotalRows" : { + "itemCount" : { "type" : "integer" } }, - "description" : "Pagination information" + "description" : "" }; defs["Payment"] = { "title" : "", @@ -4764,6 +4521,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "Payments" : { "type" : "array", "items" : { @@ -4929,6 +4689,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "Prepayments" : { "type" : "array", "items" : { @@ -5128,6 +4891,9 @@ "title" : "", "type" : "object", "properties" : { + "pagination" : { + "$ref" : "#/components/schemas/Pagination" + }, "PurchaseOrders" : { "type" : "array", "items" : { @@ -6380,7 +6146,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

+ @@ -43200,13 +43027,13 @@

Usage and SDK Samples

manual_journal_lines = [] credit = ManualJournalLine( - line_amount = 100.0, + line_amount = -100.0, account_code = "400", description = "Hello there") manual_journal_lines.append(credit) debit = ManualJournalLine( - line_amount = -100.0, + line_amount = 100.0, account_code = "120", description = "Hello there") manual_journal_lines.append(debit) diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index c56f5531..5b43a9d9 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1241,7 +1241,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index cd648d64..a65b7346 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1392,7 +1392,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index bebe6f93..9349088e 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1170,7 +1170,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index ca4b71c9..a14b3672 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2737,7 +2737,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index aeb99473..aef69da1 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index 61b39c15..7ffcb585 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -3843,7 +3843,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 9ad370f0..32942841 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3510,7 +3510,7 @@

SDK:
VSN: 5.0.0
VSN: 6.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 03bd9c89..58bcc302 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

createEmployeeEarningsTemplate

/Employees/{EmployeeID}/PayTemplates/earnings

/Employees/{EmployeeID}/PayTemplates/Earnings

Usage and SDK Samples

createEmployeeLeaveSetup

/Employees/{EmployeeID}/leaveSetup

/Employees/{EmployeeID}/LeaveSetup

Usage and SDK Samples

Parameters

Usage and SDK Samples

Parameters

createEmployeeOpeningBalances

/Employees/{EmployeeID}/openingBalances

/Employees/{EmployeeID}/OpeningBalances

Usage and SDK Samples

Parameters

createEmployment

Creates an employment detail for a specific employee

createEmployeeWorkingPattern

Creates an employee working pattern

@@ -6012,17 +6220,17 @@

createEmployment

/Employees/{EmployeeID}/Employment

/Employees/{EmployeeID}/Working-Patterns

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -6036,22 +6244,27 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_employment():
+def accounting_create_employee_working_pattern():
     api_instance = PayrollNzApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
     employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
     idempotency_key = 'KEY_VALUE'
-    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
-
-    employment = Employment(
-        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
-        start_date = start_date)
+    effective_from = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    workingWeek = WorkingWeek(
+        monday = 8,
+        tuesday = 8,
+        wednesday = 8,
+        thursday = 8,
+        friday = 8,
+        saturday = 0,
+        sunday = 0)
     
     try:
-        api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key)
+        api_response = api_instance.create_employee_working_pattern(xero_tenant_id, employee_id, employeeWorkingPatternWithWorkingWeeksRequest, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling PayrollNzApi->createEmployment: %s\n" % e)

createLeaveType

Creates a new leave type

createEmployment

Creates an employment detail for a specific employee

@@ -6198,17 +6411,17 @@

createLeaveType

/LeaveTypes

/Employees/{EmployeeID}/Employment

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -6222,33 +6435,69 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_leave_type():
+def accounting_create_employment():
     api_instance = PayrollNzApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
     idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
 
-    leave_type = LeaveType(
-        name = "LeaveType",
-        is_paid_leave = true,
-        show_on_payslip = true)
+    employment = Employment(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        engagement_type = "",
+        fixed_term_end_date = )
     
     try:
-        api_response = api_instance.create_leave_type(xero_tenant_id, leaveType, idempotency_key)
+        api_response = api_instance.create_employment(xero_tenant_id, employee_id, employment, idempotency_key)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling PayrollNzApi->createLeaveType: %s\n" % e)

+ print("Exception when calling PayrollNzApi->createEmployment: %s\n" % e)

Scopes

- - + +

payroll.settings

Grant read-write access to payroll settings

payroll.employees

Grant read-write access to payroll employees

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
EmployeeID*	+ + + + + + + UUID + + + (uuid) + + + +Employee id for single object + + + + Required + + + +

Header parameters

@@ -6259,7 +6508,7 @@

Parameters

- + - + + + + + - - - -

@@ -6282,7 +6531,7 @@

Parameters

@@ -6306,12 +6555,12 @@

Parameters

Description

leaveType *

employment *

- LeaveType + Employment

@@ -6326,9 +6575,9 @@

Parameters

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/LeaveType" + "$ref" : "#/components/schemas/Employment" }, - "example" : "{ \"name\": \"My wqwhhiktun Leave\", \"isPaidLeave\": false, \"showOnPayslip\": true }" + "example" : "{ \"payrollCalendarID\": \"9aa56064-990f-4ad3-a189-d966d8f6a030\", \"startDate\": \"2020-09-02\", \"engagementType\": \"FixedTerm\", \"fixedTermEndDate\": \"2026-01-01\" }" } }, "required" : true @@ -6338,11 +6587,11 @@

Parameters

createMultipleEmployeeEarningsTemplate

Creates multiple employee earnings template records for a specific employee

createLeaveType

Creates a new leave type

@@ -6350,17 +6599,17 @@

createMultipleEmployeeEarningsTemplate

/Employees/{EmployeeID}/paytemplateearnings

/LeaveTypes

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -6374,18 +6623,170 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_create_multiple_employee_earnings_template():
+def accounting_create_leave_type():
     api_instance = PayrollNzApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
-    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
     idempotency_key = 'KEY_VALUE'
 
-    earnings_template = EarningsTemplate(
-        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
-        rate_per_unit = 14.25,
-        number_of_units = 35.5,
-        fixed_amount = 50,
-        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+    leave_type = LeaveType(
+        name = "LeaveType",
+        is_paid_leave = true,
+        show_on_payslip = true)
+    
+    try:
+        api_response = api_instance.create_leave_type(xero_tenant_id, leaveType, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->createLeaveType: %s\n" % e)

Scopes

+ + + + + + + +

payroll.settings

Grant read-write access to payroll settings

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
leaveType *	+ + + + LeaveType + + + + + + + Required + + + +

createMultipleEmployeeEarningsTemplate

Creates multiple employee earnings template records for a specific employee

+
+

/Employees/{EmployeeID}/PayTemplateEarnings

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_multiple_employee_earnings_template():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    idempotency_key = 'KEY_VALUE'
+
+    earnings_template = EarningsTemplate(
+        pay_template_earning_id = "00000000-0000-0000-0000-000000000000",
+        rate_per_unit = 14.25,
+        number_of_units = 35.5,
+        fixed_amount = 50,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
         name = "Overtime Hours")
     
     earnings_templates = []    
@@ -7499,7 +7900,7 @@ deleteEmployeeEarningsTemplate
                   
                   
                   

-                  /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}
+                  /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}
                   
                   
Usage and SDK Samples
                   
@@ -7940,11 +8341,11 @@ Parameters


                   
-                    deleteTimesheet
-                    Deletes a timesheet
+                    deleteEmployeeWorkingPattern
+                    deletes employee's working patterns
                   
                   
                   
@@ -7952,17 +8353,17 @@ deleteTimesheet
                   
                   
                   

-                  /Timesheets/{TimesheetID}
+                  /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}
                   
                   
Usage and SDK Samples
                   
                   
                     
-                    Python
+                    Python


                       # configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -7976,24 +8377,25 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_timesheet():
+def accounting_delete_employee_working_pattern():
     api_instance = PayrollNzApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
-    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c'
     
     try:
-        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
+        api_response = api_instance.delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling PayrollNzApi->deleteTimesheet: %s\n" % e)
+        print("Exception when calling PayrollNzApi->deleteEmployeeWorkingPattern: %s\n" % e)

Scopes

- - + +

payroll.timesheets

Grant read-write access to payroll timesheets

payroll.employees

Grant read-write access to payroll employees

@@ -8004,11 +8406,11 @@

Parameters

Name

Description

TimesheetID*

EmployeeID*

@@ -8019,7 +8421,33 @@

Parameters

-Identifier for the timesheet +Employee id for single object +

+ Required +

EmployeeWorkingPatternID*

+ + +

+ + UUID + + + (uuid) + + +

+Employee working pattern id for single object

@@ -8041,7 +8469,7 @@

Parameters

@@ -8064,11 +8492,11 @@

Parameters

deleteTimesheetLine

Deletes a timesheet line for a specific timesheet

deleteTimesheet

Deletes a timesheet

@@ -8076,17 +8504,17 @@

deleteTimesheetLine

/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

/Timesheets/{TimesheetID}

Usage and SDK Samples

Python
Python

# configure api_client for use with xero-python sdk client
 api_client = ApiClient(
     Configuration(
@@ -8100,17 +8528,16 @@ Usage and SDK Samples
 
 api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
 
-def accounting_delete_timesheet_line():
+def accounting_delete_timesheet():
     api_instance = PayrollNzApi(api_client)
     xero_tenant_id = 'xeroTenantId_example'
     timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
     
     try:
-        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
         print(api_response)
     except AccountingBadRequestException as e:
-        print("Exception when calling PayrollNzApi->deleteTimesheetLine: %s\n" % e)

+ print("Exception when calling PayrollNzApi->deleteTimesheet: %s\n" % e)

Scopes

@@ -8133,7 +8560,7 @@

Parameters

@@ -8153,32 +8580,6 @@

Parameters

TimesheetLineID*

- - -

- - UUID - - - (uuid) - - -

-Identifier for the timesheet line -

- Required -

@@ -8192,7 +8593,7 @@

Parameters

@@ -8215,8 +8616,159 @@

Parameters

deleteTimesheetLine

Deletes a timesheet line for a specific timesheet

+
+

/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet_line():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->deleteTimesheetLine: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +
TimesheetLineID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet line + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getDeduction

Retrieves a single deduction by using a unique deduction ID

@@ -9429,7 +9981,7 @@

getEmployeeOpeningBalances

/Employees/{EmployeeID}/openingBalances

/Employees/{EmployeeID}/OpeningBalances

Usage and SDK Samples

@@ -10239,6 +10791,291 @@

Parameters

+ + + +

getEmployeeWorkingPattern

Retrieves employee's working patterns

+
+

/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_working_pattern():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeWorkingPattern: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

payroll.employees	Grant read-write access to payroll employees
payroll.employees.read	Grant read-only access to payroll employees

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
EmployeeID*	+ + + + + + + UUID + + + (uuid) + + + +Employee id for single object + + + + Required + + + +
EmployeeWorkingPatternID*	+ + + + + + + UUID + + + (uuid) + + + +Employee working pattern id for single object + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getEmployeeWorkingPatterns

Retrieves employee's working patterns

+
+

/Employees/{EmployeeID}/Working-Patterns

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_employee_working_patterns():
+    api_instance = PayrollNzApi(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c'
+    
+    try:
+        api_response = api_instance.get_employee_working_patterns(xero_tenant_id, employee_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollNzApi->getEmployeeWorkingPatterns: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

payroll.employees	Grant read-write access to payroll employees
payroll.employees.read	Grant read-only access to payroll employees

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
EmployeeID*	+ + + + + + + UUID + + + (uuid) + + + +Employee id for single object + + + + Required + + + +

Header parameters

+ + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

@@ -13111,7 +13948,7 @@

updateEmployeeEarningsTemplate

/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}

/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}

Usage and SDK Samples

diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 328e0e1e..beb3cf05 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/accounting/docs/BankTransactions.md b/xero_python/accounting/docs/BankTransactions.md index eec412ff..c24be2e1 100644 --- a/xero_python/accounting/docs/BankTransactions.md +++ b/xero_python/accounting/docs/BankTransactions.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **bank_transactions** | [**list[BankTransaction]**](BankTransaction.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Contacts.md b/xero_python/accounting/docs/Contacts.md index 91b0558c..e9d7da7c 100644 --- a/xero_python/accounting/docs/Contacts.md +++ b/xero_python/accounting/docs/Contacts.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **contacts** | [**list[Contact]**](Contact.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/CreditNotes.md b/xero_python/accounting/docs/CreditNotes.md index 807355de..69cd8f2b 100644 --- a/xero_python/accounting/docs/CreditNotes.md +++ b/xero_python/accounting/docs/CreditNotes.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **credit_notes** | [**list[CreditNote]**](CreditNote.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Invoices.md b/xero_python/accounting/docs/Invoices.md index 5ea83682..3b56eb42 100644 --- a/xero_python/accounting/docs/Invoices.md +++ b/xero_python/accounting/docs/Invoices.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **invoices** | [**list[Invoice]**](Invoice.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Journals.md b/xero_python/accounting/docs/Journals.md index bf3c0631..4b94daa2 100644 --- a/xero_python/accounting/docs/Journals.md +++ b/xero_python/accounting/docs/Journals.md @@ -3,6 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **journals** | [**list[Journal]**](Journal.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/ManualJournals.md b/xero_python/accounting/docs/ManualJournals.md index a7f1b662..1072787d 100644 --- a/xero_python/accounting/docs/ManualJournals.md +++ b/xero_python/accounting/docs/ManualJournals.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **manual_journals** | [**list[ManualJournal]**](ManualJournal.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Overpayments.md b/xero_python/accounting/docs/Overpayments.md index b82f9269..85042a86 100644 --- a/xero_python/accounting/docs/Overpayments.md +++ b/xero_python/accounting/docs/Overpayments.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **overpayments** | [**list[Overpayment]**](Overpayment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Payments.md b/xero_python/accounting/docs/Payments.md index 441071f8..768a9ea6 100644 --- a/xero_python/accounting/docs/Payments.md +++ b/xero_python/accounting/docs/Payments.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **payments** | [**list[Payment]**](Payment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/Prepayments.md b/xero_python/accounting/docs/Prepayments.md index 619a1f28..f30ec4b7 100644 --- a/xero_python/accounting/docs/Prepayments.md +++ b/xero_python/accounting/docs/Prepayments.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **prepayments** | [**list[Prepayment]**](Prepayment.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/docs/PurchaseOrders.md b/xero_python/accounting/docs/PurchaseOrders.md index 9b0d6e3a..a8568046 100644 --- a/xero_python/accounting/docs/PurchaseOrders.md +++ b/xero_python/accounting/docs/PurchaseOrders.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | [optional] +**warnings** | [**list[ValidationError]**](ValidationError.md) | Displays array of warning messages from the API | [optional] **purchase_orders** | [**list[PurchaseOrder]**](PurchaseOrder.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/models/bank_transactions.py b/xero_python/accounting/models/bank_transactions.py index 7fbabde4..81f7e787 100644 --- a/xero_python/accounting/models/bank_transactions.py +++ b/xero_python/accounting/models/bank_transactions.py @@ -31,23 +31,30 @@ class BankTransactions(BaseModel): """ openapi_types = { "pagination": "Pagination", + "warnings": "list[ValidationError]", "bank_transactions": "list[BankTransaction]", } attribute_map = { "pagination": "pagination", + "warnings": "Warnings", "bank_transactions": "BankTransactions", } - def __init__(self, pagination=None, bank_transactions=None): # noqa: E501 + def __init__( + self, pagination=None, warnings=None, bank_transactions=None + ): # noqa: E501 """BankTransactions - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._bank_transactions = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if bank_transactions is not None: self.bank_transactions = bank_transactions @@ -72,6 +79,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this BankTransactions. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this BankTransactions. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this BankTransactions. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this BankTransactions. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def bank_transactions(self): """Gets the bank_transactions of this BankTransactions. # noqa: E501 diff --git a/xero_python/accounting/models/contacts.py b/xero_python/accounting/models/contacts.py index 6376b4a1..afe9e404 100644 --- a/xero_python/accounting/models/contacts.py +++ b/xero_python/accounting/models/contacts.py @@ -29,19 +29,30 @@ class Contacts(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "contacts": "list[Contact]"} - - attribute_map = {"pagination": "pagination", "contacts": "Contacts"} - - def __init__(self, pagination=None, contacts=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "contacts": "list[Contact]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "contacts": "Contacts", + } + + def __init__(self, pagination=None, warnings=None, contacts=None): # noqa: E501 """Contacts - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._contacts = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if contacts is not None: self.contacts = contacts @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this Contacts. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Contacts. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Contacts. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Contacts. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def contacts(self): """Gets the contacts of this Contacts. # noqa: E501 diff --git a/xero_python/accounting/models/credit_notes.py b/xero_python/accounting/models/credit_notes.py index cdb40a1a..64c45687 100644 --- a/xero_python/accounting/models/credit_notes.py +++ b/xero_python/accounting/models/credit_notes.py @@ -29,19 +29,30 @@ class CreditNotes(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "credit_notes": "list[CreditNote]"} - - attribute_map = {"pagination": "pagination", "credit_notes": "CreditNotes"} - - def __init__(self, pagination=None, credit_notes=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "credit_notes": "list[CreditNote]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "credit_notes": "CreditNotes", + } + + def __init__(self, pagination=None, warnings=None, credit_notes=None): # noqa: E501 """CreditNotes - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._credit_notes = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if credit_notes is not None: self.credit_notes = credit_notes @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this CreditNotes. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this CreditNotes. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this CreditNotes. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this CreditNotes. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def credit_notes(self): """Gets the credit_notes of this CreditNotes. # noqa: E501 diff --git a/xero_python/accounting/models/invoices.py b/xero_python/accounting/models/invoices.py index 3068856a..90b7b99d 100644 --- a/xero_python/accounting/models/invoices.py +++ b/xero_python/accounting/models/invoices.py @@ -29,19 +29,30 @@ class Invoices(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "invoices": "list[Invoice]"} - - attribute_map = {"pagination": "pagination", "invoices": "Invoices"} - - def __init__(self, pagination=None, invoices=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "invoices": "list[Invoice]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "invoices": "Invoices", + } + + def __init__(self, pagination=None, warnings=None, invoices=None): # noqa: E501 """Invoices - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._invoices = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if invoices is not None: self.invoices = invoices @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this Invoices. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Invoices. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Invoices. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Invoices. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def invoices(self): """Gets the invoices of this Invoices. # noqa: E501 diff --git a/xero_python/accounting/models/journals.py b/xero_python/accounting/models/journals.py index ef4524e8..68e8fea5 100644 --- a/xero_python/accounting/models/journals.py +++ b/xero_python/accounting/models/journals.py @@ -29,19 +29,45 @@ class Journals(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"journals": "list[Journal]"} + openapi_types = {"warnings": "list[ValidationError]", "journals": "list[Journal]"} - attribute_map = {"journals": "Journals"} + attribute_map = {"warnings": "Warnings", "journals": "Journals"} - def __init__(self, journals=None): # noqa: E501 + def __init__(self, warnings=None, journals=None): # noqa: E501 """Journals - a model defined in OpenAPI""" # noqa: E501 + self._warnings = None self._journals = None self.discriminator = None + if warnings is not None: + self.warnings = warnings if journals is not None: self.journals = journals + @property + def warnings(self): + """Gets the warnings of this Journals. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Journals. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Journals. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Journals. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def journals(self): """Gets the journals of this Journals. # noqa: E501 diff --git a/xero_python/accounting/models/manual_journals.py b/xero_python/accounting/models/manual_journals.py index da54f06b..b4c2c66e 100644 --- a/xero_python/accounting/models/manual_journals.py +++ b/xero_python/accounting/models/manual_journals.py @@ -31,20 +31,30 @@ class ManualJournals(BaseModel): """ openapi_types = { "pagination": "Pagination", + "warnings": "list[ValidationError]", "manual_journals": "list[ManualJournal]", } - attribute_map = {"pagination": "pagination", "manual_journals": "ManualJournals"} + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "manual_journals": "ManualJournals", + } - def __init__(self, pagination=None, manual_journals=None): # noqa: E501 + def __init__( + self, pagination=None, warnings=None, manual_journals=None + ): # noqa: E501 """ManualJournals - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._manual_journals = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if manual_journals is not None: self.manual_journals = manual_journals @@ -69,6 +79,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this ManualJournals. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this ManualJournals. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this ManualJournals. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this ManualJournals. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def manual_journals(self): """Gets the manual_journals of this ManualJournals. # noqa: E501 diff --git a/xero_python/accounting/models/overpayments.py b/xero_python/accounting/models/overpayments.py index 0d16524e..bc80ac4e 100644 --- a/xero_python/accounting/models/overpayments.py +++ b/xero_python/accounting/models/overpayments.py @@ -29,19 +29,30 @@ class Overpayments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "overpayments": "list[Overpayment]"} - - attribute_map = {"pagination": "pagination", "overpayments": "Overpayments"} - - def __init__(self, pagination=None, overpayments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "overpayments": "list[Overpayment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "overpayments": "Overpayments", + } + + def __init__(self, pagination=None, warnings=None, overpayments=None): # noqa: E501 """Overpayments - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._overpayments = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if overpayments is not None: self.overpayments = overpayments @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this Overpayments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Overpayments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Overpayments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Overpayments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def overpayments(self): """Gets the overpayments of this Overpayments. # noqa: E501 diff --git a/xero_python/accounting/models/payments.py b/xero_python/accounting/models/payments.py index 4e72a42b..83643062 100644 --- a/xero_python/accounting/models/payments.py +++ b/xero_python/accounting/models/payments.py @@ -29,19 +29,30 @@ class Payments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "payments": "list[Payment]"} - - attribute_map = {"pagination": "pagination", "payments": "Payments"} - - def __init__(self, pagination=None, payments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "payments": "list[Payment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "payments": "Payments", + } + + def __init__(self, pagination=None, warnings=None, payments=None): # noqa: E501 """Payments - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._payments = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if payments is not None: self.payments = payments @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this Payments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Payments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Payments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Payments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def payments(self): """Gets the payments of this Payments. # noqa: E501 diff --git a/xero_python/accounting/models/prepayments.py b/xero_python/accounting/models/prepayments.py index 4cae4cb3..54e57108 100644 --- a/xero_python/accounting/models/prepayments.py +++ b/xero_python/accounting/models/prepayments.py @@ -29,19 +29,30 @@ class Prepayments(BaseModel): attribute_map (dict): The key is attribute name and the value is json key in definition. """ - openapi_types = {"pagination": "Pagination", "prepayments": "list[Prepayment]"} - - attribute_map = {"pagination": "pagination", "prepayments": "Prepayments"} - - def __init__(self, pagination=None, prepayments=None): # noqa: E501 + openapi_types = { + "pagination": "Pagination", + "warnings": "list[ValidationError]", + "prepayments": "list[Prepayment]", + } + + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "prepayments": "Prepayments", + } + + def __init__(self, pagination=None, warnings=None, prepayments=None): # noqa: E501 """Prepayments - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._prepayments = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if prepayments is not None: self.prepayments = prepayments @@ -66,6 +77,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this Prepayments. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this Prepayments. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this Prepayments. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this Prepayments. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def prepayments(self): """Gets the prepayments of this Prepayments. # noqa: E501 diff --git a/xero_python/accounting/models/purchase_orders.py b/xero_python/accounting/models/purchase_orders.py index 8ad019d8..aa617dbe 100644 --- a/xero_python/accounting/models/purchase_orders.py +++ b/xero_python/accounting/models/purchase_orders.py @@ -31,20 +31,30 @@ class PurchaseOrders(BaseModel): """ openapi_types = { "pagination": "Pagination", + "warnings": "list[ValidationError]", "purchase_orders": "list[PurchaseOrder]", } - attribute_map = {"pagination": "pagination", "purchase_orders": "PurchaseOrders"} + attribute_map = { + "pagination": "pagination", + "warnings": "Warnings", + "purchase_orders": "PurchaseOrders", + } - def __init__(self, pagination=None, purchase_orders=None): # noqa: E501 + def __init__( + self, pagination=None, warnings=None, purchase_orders=None + ): # noqa: E501 """PurchaseOrders - a model defined in OpenAPI""" # noqa: E501 self._pagination = None + self._warnings = None self._purchase_orders = None self.discriminator = None if pagination is not None: self.pagination = pagination + if warnings is not None: + self.warnings = warnings if purchase_orders is not None: self.purchase_orders = purchase_orders @@ -69,6 +79,29 @@ def pagination(self, pagination): self._pagination = pagination + @property + def warnings(self): + """Gets the warnings of this PurchaseOrders. # noqa: E501 + + Displays array of warning messages from the API # noqa: E501 + + :return: The warnings of this PurchaseOrders. # noqa: E501 + :rtype: list[ValidationError] + """ + return self._warnings + + @warnings.setter + def warnings(self, warnings): + """Sets the warnings of this PurchaseOrders. + + Displays array of warning messages from the API # noqa: E501 + + :param warnings: The warnings of this PurchaseOrders. # noqa: E501 + :type: list[ValidationError] + """ + + self._warnings = warnings + @property def purchase_orders(self): """Gets the purchase_orders of this PurchaseOrders. # noqa: E501 diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 9972706f..20048e06 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index a8eaa7c3..c1b35688 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index dac17611..4f1f8849 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,7 +3,7 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 6.0.0 +- API version: 6.0.1 - Package version: 6.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 871e8e2d..5b4f3fdf 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index e319e7ff..4312a685 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index d1abaef7..61b89713 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index edf9a37b..de6326ef 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/payrollnz/__init__.py b/xero_python/payrollnz/__init__.py index 1aa00d0c..f510df98 100644 --- a/xero_python/payrollnz/__init__.py +++ b/xero_python/payrollnz/__init__.py @@ -87,6 +87,19 @@ ) from xero_python.payrollnz.models.employee_tax import EmployeeTax from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employee_working_pattern import EmployeeWorkingPattern +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks import ( + EmployeeWorkingPatternWithWorkingWeeks, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_object import ( + EmployeeWorkingPatternWithWorkingWeeksObject, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_request import ( + EmployeeWorkingPatternWithWorkingWeeksRequest, +) +from xero_python.payrollnz.models.employee_working_patterns_object import ( + EmployeeWorkingPatternsObject, +) from xero_python.payrollnz.models.employees import Employees from xero_python.payrollnz.models.employment import Employment from xero_python.payrollnz.models.employment_object import EmploymentObject @@ -144,3 +157,4 @@ from xero_python.payrollnz.models.timesheets import Timesheets from xero_python.payrollnz.models.tracking_categories import TrackingCategories from xero_python.payrollnz.models.tracking_category import TrackingCategory +from xero_python.payrollnz.models.working_week import WorkingWeek diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index e32496ad..9d547e43 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib @@ -460,7 +460,7 @@ def create_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/earnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplates/Earnings") try: return self.api_client.call_api( @@ -650,7 +650,7 @@ def create_employee_leave_setup( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/leaveSetup") + url = self.get_resource_url("/Employees/{EmployeeID}/LeaveSetup") try: return self.api_client.call_api( @@ -838,7 +838,7 @@ def create_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/OpeningBalances") try: return self.api_client.call_api( @@ -1055,6 +1055,102 @@ def create_employee_salary_and_wage( error, self, "create_employee_salary_and_wage" ) + def create_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_with_working_weeks_request, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates an employee working pattern # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param EmployeeWorkingPatternWithWorkingWeeksRequest employee_working_pattern_with_working_weeks_request: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternWithWorkingWeeks + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `create_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_with_working_weeks_request' is set + if employee_working_pattern_with_working_weeks_request is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_with_working_weeks_request` " + "when calling `create_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = employee_working_pattern_with_working_weeks_request + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeID}/Working-Patterns") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternWithWorkingWeeks", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "create_employee_working_pattern" + ) + def create_employment( self, xero_tenant_id, @@ -1304,7 +1400,7 @@ def create_multiple_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/paytemplateearnings") + url = self.get_resource_url("/Employees/{EmployeeID}/PayTemplateEarnings") try: return self.api_client.call_api( @@ -1906,7 +2002,7 @@ def delete_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}" ) try: @@ -2106,6 +2202,95 @@ def delete_employee_salary_and_wage( error, self, "delete_employee_salary_and_wage" ) + def delete_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """deletes employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str employee_working_pattern_id: Employee working pattern id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeLeaveObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `delete_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_id' is set + if employee_working_pattern_id is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_id` " + "when calling `delete_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + "EmployeeWorkingPatternID": employee_working_pattern_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}" + ) + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeLeaveObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "delete_employee_working_pattern" + ) + def delete_timesheet( self, xero_tenant_id, @@ -3004,7 +3189,7 @@ def get_employee_opening_balances( # Authentication setting auth_settings = ["OAuth2"] - url = self.get_resource_url("/Employees/{EmployeeID}/openingBalances") + url = self.get_resource_url("/Employees/{EmployeeID}/OpeningBalances") try: return self.api_client.call_api( @@ -3429,6 +3614,173 @@ def get_employee_tax( except exceptions.HTTPStatusException as error: raise translate_status_exception(error, self, "get_employee_tax") + def get_employee_working_pattern( + self, + xero_tenant_id, + employee_id, + employee_working_pattern_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param str employee_working_pattern_id: Employee working pattern id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternWithWorkingWeeksObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_working_pattern`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_working_pattern`" + ) + # verify the required parameter 'employee_working_pattern_id' is set + if employee_working_pattern_id is None: + raise ValueError( + "Missing the required parameter `employee_working_pattern_id` " + "when calling `get_employee_working_pattern`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + "EmployeeWorkingPatternID": employee_working_pattern_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url( + "/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}" + ) + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternWithWorkingWeeksObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_working_pattern" + ) + + def get_employee_working_patterns( + self, + xero_tenant_id, + employee_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves employee's working patterns # noqa: E501 + OAuth2 scope: payroll.employees, payroll.employees.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str employee_id: Employee id for single object (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: EmployeeWorkingPatternsObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_employee_working_patterns`" + ) + # verify the required parameter 'employee_id' is set + if employee_id is None: + raise ValueError( + "Missing the required parameter `employee_id` " + "when calling `get_employee_working_patterns`" + ) + + collection_formats = {} + path_params = { + "EmployeeID": employee_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Employees/{EmployeeID}/Working-Patterns") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="EmployeeWorkingPatternsObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception( + error, self, "get_employee_working_patterns" + ) + def get_employees( self, xero_tenant_id, @@ -5114,7 +5466,7 @@ def update_employee_earnings_template( # Authentication setting auth_settings = ["OAuth2"] url = self.get_resource_url( - "/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}" + "/Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID}" ) try: diff --git a/xero_python/payrollnz/docs/Employee.md b/xero_python/payrollnz/docs/Employee.md index ba075ac4..4b458d5f 100644 --- a/xero_python/payrollnz/docs/Employee.md +++ b/xero_python/payrollnz/docs/Employee.md @@ -18,6 +18,8 @@ Name | Type | Description | Notes **updated_date_utc** | **datetime** | UTC timestamp of last update to the employee | [optional] **created_date_utc** | **datetime** | UTC timestamp when the employee was created in Xero | [optional] **job_title** | **str** | Employee's job title | [optional] +**engagement_type** | **str** | Engagement type of the employee | [optional] +**fixed_term_end_date** | **date** | End date for an employee with a fixed-term engagement type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md index b9bf6d82..d53341a0 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md @@ -10,6 +10,8 @@ Name | Type | Description | Notes **sick_leave_hours_to_accrue_annually** | **float** | Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day | [optional] **sick_leave_maximum_hours_to_accrue** | **float** | Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day | [optional] **sick_leave_opening_balance** | **float** | Initial sick leave balance. This will be positive unless they've taken sick leave in advance | [optional] +**sick_leave_schedule_of_accrual** | **str** | Set Schedule of Accrual Type for Sick Leave | [optional] +**sick_leave_anniversary_date** | **date** | If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeLeaveType.md b/xero_python/payrollnz/docs/EmployeeLeaveType.md index eca4056f..01d7289b 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveType.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveType.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **include_holiday_pay_every_pay** | **bool** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] **show_annual_leave_in_advance** | **bool** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional] **annual_leave_total_amount_paid** | **float** | Specific to Annual Leave. Annual leave balance in dollars | [optional] +**schedule_of_accrual_date** | **date** | The date when an employee becomes entitled to their accrual. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPattern.md b/xero_python/payrollnz/docs/EmployeeWorkingPattern.md new file mode 100644 index 00000000..c38617ef --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPattern.md @@ -0,0 +1,11 @@ +# EmployeeWorkingPattern + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_working_pattern_id** | **str** | The Xero identifier for for Employee working pattern | +**effective_from** | **date** | The effective date of the corresponding salary and wages | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md new file mode 100644 index 00000000..2ae49f5f --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeks.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternWithWorkingWeeks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payee_working_pattern_id** | **str** | The Xero identifier for for Employee working pattern | +**effective_from** | **date** | The effective date of the corresponding salary and wages | +**working_weeks** | [**list[WorkingWeek]**](WorkingWeek.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md new file mode 100644 index 00000000..b00027b6 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksObject.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternWithWorkingWeeksObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**payee_working_pattern** | [**EmployeeWorkingPatternWithWorkingWeeks**](EmployeeWorkingPatternWithWorkingWeeks.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md new file mode 100644 index 00000000..37d63bb3 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternWithWorkingWeeksRequest.md @@ -0,0 +1,11 @@ +# EmployeeWorkingPatternWithWorkingWeeksRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effective_from** | **date** | The effective date of the corresponding salary and wages | +**working_weeks** | [**list[WorkingWeek]**](WorkingWeek.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md b/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md new file mode 100644 index 00000000..a1f10fa9 --- /dev/null +++ b/xero_python/payrollnz/docs/EmployeeWorkingPatternsObject.md @@ -0,0 +1,12 @@ +# EmployeeWorkingPatternsObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**payee_working_patterns** | [**list[EmployeeWorkingPattern]**](EmployeeWorkingPattern.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/docs/Employment.md b/xero_python/payrollnz/docs/Employment.md index 70b6e694..1cbcb869 100644 --- a/xero_python/payrollnz/docs/Employment.md +++ b/xero_python/payrollnz/docs/Employment.md @@ -6,6 +6,8 @@ Name | Type | Description | Notes **payroll_calendar_id** | **str** | Xero unique identifier for the payroll calendar of the employee | [optional] **pay_run_calendar_id** | **str** | Xero unique identifier for the payrun calendar for the employee (Deprecated in version 1.1.6) | [optional] **start_date** | **date** | Start date of the employment (YYYY-MM-DD) | [optional] +**engagement_type** | **str** | Engagement type of the employee | [optional] +**fixed_term_end_date** | **date** | End date for an employee with a fixed-term engagement type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index 82c3c2e2..f0f47485 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -8,25 +8,27 @@ Method | HTTP request | Description [**create_deduction**](PayrollNzApi.md#create_deduction) | **POST** /Deductions | Creates a new deduction for a specific employee [**create_earnings_rate**](PayrollNzApi.md#create_earnings_rate) | **POST** /EarningsRates | Creates a new earnings rate [**create_employee**](PayrollNzApi.md#create_employee) | **POST** /Employees | Creates an employees -[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/earnings | Creates earnings template records for an employee +[**create_employee_earnings_template**](PayrollNzApi.md#create_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplates/Earnings | Creates earnings template records for an employee [**create_employee_leave**](PayrollNzApi.md#create_employee_leave) | **POST** /Employees/{EmployeeID}/Leave | Creates leave records for a specific employee -[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeID}/leaveSetup | Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee +[**create_employee_leave_setup**](PayrollNzApi.md#create_employee_leave_setup) | **POST** /Employees/{EmployeeID}/LeaveSetup | Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee [**create_employee_leave_type**](PayrollNzApi.md#create_employee_leave_type) | **POST** /Employees/{EmployeeID}/LeaveTypes | Creates leave type records for a specific employee -[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/openingBalances | Creates opening balances for a specific employee +[**create_employee_opening_balances**](PayrollNzApi.md#create_employee_opening_balances) | **POST** /Employees/{EmployeeID}/OpeningBalances | Creates opening balances for a specific employee [**create_employee_payment_method**](PayrollNzApi.md#create_employee_payment_method) | **POST** /Employees/{EmployeeID}/PaymentMethods | Creates a payment method for an employee [**create_employee_salary_and_wage**](PayrollNzApi.md#create_employee_salary_and_wage) | **POST** /Employees/{EmployeeID}/SalaryAndWages | Creates an employee salary and wage record +[**create_employee_working_pattern**](PayrollNzApi.md#create_employee_working_pattern) | **POST** /Employees/{EmployeeID}/Working-Patterns | Creates an employee working pattern [**create_employment**](PayrollNzApi.md#create_employment) | **POST** /Employees/{EmployeeID}/Employment | Creates an employment detail for a specific employee [**create_leave_type**](PayrollNzApi.md#create_leave_type) | **POST** /LeaveTypes | Creates a new leave type -[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/paytemplateearnings | Creates multiple employee earnings template records for a specific employee +[**create_multiple_employee_earnings_template**](PayrollNzApi.md#create_multiple_employee_earnings_template) | **POST** /Employees/{EmployeeID}/PayTemplateEarnings | Creates multiple employee earnings template records for a specific employee [**create_pay_run**](PayrollNzApi.md#create_pay_run) | **POST** /PayRuns | Creates a pay run [**create_pay_run_calendar**](PayrollNzApi.md#create_pay_run_calendar) | **POST** /PayRunCalendars | Creates a new payrun calendar [**create_reimbursement**](PayrollNzApi.md#create_reimbursement) | **POST** /Reimbursements | Creates a new reimbursement [**create_superannuation**](PayrollNzApi.md#create_superannuation) | **POST** /Superannuations | Creates a new superannuation [**create_timesheet**](PayrollNzApi.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet [**create_timesheet_line**](PayrollNzApi.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Create a new timesheet line for a specific time sheet -[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Deletes an employee's earnings template record +[**delete_employee_earnings_template**](PayrollNzApi.md#delete_employee_earnings_template) | **DELETE** /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} | Deletes an employee's earnings template record [**delete_employee_leave**](PayrollNzApi.md#delete_employee_leave) | **DELETE** /Employees/{EmployeeID}/Leave/{LeaveID} | Deletes a leave record for a specific employee [**delete_employee_salary_and_wage**](PayrollNzApi.md#delete_employee_salary_and_wage) | **DELETE** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Deletes an employee's salary and wages record +[**delete_employee_working_pattern**](PayrollNzApi.md#delete_employee_working_pattern) | **DELETE** /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} | deletes employee's working patterns [**delete_timesheet**](PayrollNzApi.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a timesheet [**delete_timesheet_line**](PayrollNzApi.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a timesheet line for a specific timesheet [**get_deduction**](PayrollNzApi.md#get_deduction) | **GET** /Deductions/{deductionId} | Retrieves a single deduction by using a unique deduction ID @@ -38,12 +40,14 @@ Method | HTTP request | Description [**get_employee_leave_periods**](PayrollNzApi.md#get_employee_leave_periods) | **GET** /Employees/{EmployeeID}/LeavePeriods | Retrieves leave periods for a specific employee [**get_employee_leave_types**](PayrollNzApi.md#get_employee_leave_types) | **GET** /Employees/{EmployeeID}/LeaveTypes | Retrieves leave types for a specific employee [**get_employee_leaves**](PayrollNzApi.md#get_employee_leaves) | **GET** /Employees/{EmployeeID}/Leave | Retrieves leave records for a specific employee -[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/openingBalances | Retrieves the opening balance for a specific employee +[**get_employee_opening_balances**](PayrollNzApi.md#get_employee_opening_balances) | **GET** /Employees/{EmployeeID}/OpeningBalances | Retrieves the opening balance for a specific employee [**get_employee_pay_templates**](PayrollNzApi.md#get_employee_pay_templates) | **GET** /Employees/{EmployeeID}/PayTemplates | Retrieves pay templates for a specific employee [**get_employee_payment_method**](PayrollNzApi.md#get_employee_payment_method) | **GET** /Employees/{EmployeeID}/PaymentMethods | Retrieves available payment methods for a specific employee [**get_employee_salary_and_wage**](PayrollNzApi.md#get_employee_salary_and_wage) | **GET** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Retrieves an employee's salary and wages record by using a unique salary and wage ID [**get_employee_salary_and_wages**](PayrollNzApi.md#get_employee_salary_and_wages) | **GET** /Employees/{EmployeeID}/SalaryAndWages | Retrieves an employee's salary and wages [**get_employee_tax**](PayrollNzApi.md#get_employee_tax) | **GET** /Employees/{EmployeeID}/Tax | Retrieves tax records for a specific employee +[**get_employee_working_pattern**](PayrollNzApi.md#get_employee_working_pattern) | **GET** /Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID} | Retrieves employee's working patterns +[**get_employee_working_patterns**](PayrollNzApi.md#get_employee_working_patterns) | **GET** /Employees/{EmployeeID}/Working-Patterns | Retrieves employee's working patterns [**get_employees**](PayrollNzApi.md#get_employees) | **GET** /Employees | Retrieves employees [**get_leave_type**](PayrollNzApi.md#get_leave_type) | **GET** /LeaveTypes/{LeaveTypeID} | Retrieves a specific leave type by using a unique leave type ID [**get_leave_types**](PayrollNzApi.md#get_leave_types) | **GET** /LeaveTypes | Retrieves leave types @@ -65,7 +69,7 @@ Method | HTTP request | Description [**get_tracking_categories**](PayrollNzApi.md#get_tracking_categories) | **GET** /Settings/TrackingCategories | Retrieves tracking categories [**revert_timesheet**](PayrollNzApi.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a timesheet to draft [**update_employee**](PayrollNzApi.md#update_employee) | **PUT** /Employees/{EmployeeID} | Updates an existing employee -[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} | Updates an earnings template records for an employee +[**update_employee_earnings_template**](PayrollNzApi.md#update_employee_earnings_template) | **PUT** /Employees/{EmployeeID}/PayTemplates/Earnings/{PayTemplateEarningID} | Updates an earnings template records for an employee [**update_employee_leave**](PayrollNzApi.md#update_employee_leave) | **PUT** /Employees/{EmployeeID}/Leave/{LeaveID} | Updates leave records for a specific employee [**update_employee_salary_and_wage**](PayrollNzApi.md#update_employee_salary_and_wage) | **PUT** /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} | Updates an employee's salary and wages record [**update_employee_tax**](PayrollNzApi.md#update_employee_tax) | **POST** /Employees/{EmployeeID}/Tax | Updates the tax records for a specific employee @@ -501,7 +505,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10 } # EmployeeLeaveSetup | +employee_leave_setup = { "holidayPayOpeningBalance": 10, "annualLeaveOpeningBalance": 100, "sickLeaveHoursToAccrueAnnually": 20, "sickLeaveToAccrueAnnually": 20, "sickLeaveOpeningBalance": 10, "sickLeaveScheduleOfAccrual": "OnAnniversaryDate", "sickLeaveAnniversaryDate": "2023-12-31", "annualLeaveAnniversaryDate": "2023-12-31" } # EmployeeLeaveSetup | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee @@ -568,7 +572,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType | +employee_leave_type = { "leaveTypeID": "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual": "AnnuallyAfter6Months", "hoursAccruedAnnually": 10, "unitsAccruedAnnually": 10, "typeOfUnitsToAccrue": "Hours", "openingBalanceTypeOfUnits": "Hours" "maximumToAccrue": 80, "openingBalance": 100, "rateAccruedHourly": 3.5 } # EmployeeLeaveType | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates leave type records for a specific employee @@ -803,6 +807,73 @@ Name | Type | Description | Notes [[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) +# **create_employee_working_pattern** +> EmployeeWorkingPatternWithWorkingWeeks create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) + +Creates an employee working pattern + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_with_working_weeks_request = { "effectiveFrom": "2020-01-01T00:00:00", "workingWeeks": [ { "monday": 0.0, "tuesday": 3.0000, "wednesday": 0.0, "thursday": 0.0, "friday": 0.0, "saturday": 0.0, "sunday": 0.0 } ] } # EmployeeWorkingPatternWithWorkingWeeksRequest | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates an employee working pattern + api_response = api_instance.create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->create_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_with_working_weeks_request** | [**EmployeeWorkingPatternWithWorkingWeeksRequest**](EmployeeWorkingPatternWithWorkingWeeksRequest.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**EmployeeWorkingPatternWithWorkingWeeks**](EmployeeWorkingPatternWithWorkingWeeks.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[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) + # **create_employment** > EmploymentObject create_employment(xero_tenant_id, employee_id, employment, idempotency_key=idempotency_key) @@ -836,7 +907,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02" } # Employment | +employment = { "payrollCalendarID": "9aa56064-990f-4ad3-a189-d966d8f6a030", "startDate": "2020-09-02", "engagementType": "FixedTerm", "fixedTermEndDate": "2026-01-01" } # Employment | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates an employment detail for a specific employee @@ -1589,6 +1660,71 @@ Name | Type | Description | Notes [[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) +# **delete_employee_working_pattern** +> EmployeeLeaveObject delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + +deletes employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c' # str | Employee working pattern id for single object +try: + # deletes employee's working patterns + api_response = api_instance.delete_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->delete_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_id** | [**str**](.md)| Employee working pattern id for single object | + +### Return type + +[**EmployeeLeaveObject**](EmployeeLeaveObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + # **delete_timesheet** > TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) @@ -2670,6 +2806,134 @@ Name | Type | Description | Notes [[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) +# **get_employee_working_pattern** +> EmployeeWorkingPatternWithWorkingWeeksObject get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + +Retrieves employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +employee_working_pattern_id = '4ff1e5cc-9835-40d5-bb18-09f3b118db9c' # str | Employee working pattern id for single object +try: + # Retrieves employee's working patterns + api_response = api_instance.get_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_working_pattern: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + **employee_working_pattern_id** | [**str**](.md)| Employee working pattern id for single object | + +### Return type + +[**EmployeeWorkingPatternWithWorkingWeeksObject**](EmployeeWorkingPatternWithWorkingWeeksObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **get_employee_working_patterns** +> EmployeeWorkingPatternsObject get_employee_working_patterns(xero_tenant_id, employee_id) + +Retrieves employee's working patterns + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollnz import PayrollNzApi +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollNzApi(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object +try: + # Retrieves employee's working patterns + api_response = api_instance.get_employee_working_patterns(xero_tenant_id, employee_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollNzApi->get_employee_working_patterns: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **employee_id** | [**str**](.md)| Employee id for single object | + +### Return type + +[**EmployeeWorkingPatternsObject**](EmployeeWorkingPatternsObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + # **get_employees** > Employees get_employees(xero_tenant_id, filter=filter, page=page) diff --git a/xero_python/payrollnz/docs/SalaryAndWage.md b/xero_python/payrollnz/docs/SalaryAndWage.md index fa4cd16a..65ab101c 100644 --- a/xero_python/payrollnz/docs/SalaryAndWage.md +++ b/xero_python/payrollnz/docs/SalaryAndWage.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **annual_salary** | **float** | The annual salary | **status** | **str** | The current status of the corresponding salary and wages | **payment_type** | **str** | The type of the payment of the corresponding salary and wages | +**work_pattern_type** | **str** | The type of the Working Pattern of the corresponding salary and wages | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollnz/docs/WorkingWeek.md b/xero_python/payrollnz/docs/WorkingWeek.md new file mode 100644 index 00000000..58ad2b2a --- /dev/null +++ b/xero_python/payrollnz/docs/WorkingWeek.md @@ -0,0 +1,16 @@ +# WorkingWeek + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**monday** | **float** | The number of hours worked on a Monday | +**tuesday** | **float** | The number of hours worked on a Tuesday | +**wednesday** | **float** | The number of hours worked on a Wednesday | +**thursday** | **float** | The number of hours worked on a Thursday | +**friday** | **float** | The number of hours worked on a Friday | +**saturday** | **float** | The number of hours worked on a Saturday | +**sunday** | **float** | The number of hours worked on a Sunday | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollnz/models/__init__.py b/xero_python/payrollnz/models/__init__.py index dc995d81..d2798463 100644 --- a/xero_python/payrollnz/models/__init__.py +++ b/xero_python/payrollnz/models/__init__.py @@ -82,6 +82,19 @@ ) from xero_python.payrollnz.models.employee_tax import EmployeeTax from xero_python.payrollnz.models.employee_tax_object import EmployeeTaxObject +from xero_python.payrollnz.models.employee_working_pattern import EmployeeWorkingPattern +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks import ( + EmployeeWorkingPatternWithWorkingWeeks, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_object import ( + EmployeeWorkingPatternWithWorkingWeeksObject, +) +from xero_python.payrollnz.models.employee_working_pattern_with_working_weeks_request import ( + EmployeeWorkingPatternWithWorkingWeeksRequest, +) +from xero_python.payrollnz.models.employee_working_patterns_object import ( + EmployeeWorkingPatternsObject, +) from xero_python.payrollnz.models.employees import Employees from xero_python.payrollnz.models.employment import Employment from xero_python.payrollnz.models.employment_object import EmploymentObject @@ -139,3 +152,4 @@ from xero_python.payrollnz.models.timesheets import Timesheets from xero_python.payrollnz.models.tracking_categories import TrackingCategories from xero_python.payrollnz.models.tracking_category import TrackingCategory +from xero_python.payrollnz.models.working_week import WorkingWeek diff --git a/xero_python/payrollnz/models/employee.py b/xero_python/payrollnz/models/employee.py index e96d7895..2d507fb3 100644 --- a/xero_python/payrollnz/models/employee.py +++ b/xero_python/payrollnz/models/employee.py @@ -45,6 +45,8 @@ class Employee(BaseModel): "updated_date_utc": "datetime", "created_date_utc": "datetime", "job_title": "str", + "engagement_type": "str", + "fixed_term_end_date": "date", } attribute_map = { @@ -63,6 +65,8 @@ class Employee(BaseModel): "updated_date_utc": "updatedDateUTC", "created_date_utc": "createdDateUTC", "job_title": "jobTitle", + "engagement_type": "engagementType", + "fixed_term_end_date": "fixedTermEndDate", } def __init__( @@ -82,6 +86,8 @@ def __init__( updated_date_utc=None, created_date_utc=None, job_title=None, + engagement_type=None, + fixed_term_end_date=None, ): # noqa: E501 """Employee - a model defined in OpenAPI""" # noqa: E501 @@ -100,6 +106,8 @@ def __init__( self._updated_date_utc = None self._created_date_utc = None self._job_title = None + self._engagement_type = None + self._fixed_term_end_date = None self.discriminator = None if employee_id is not None: @@ -132,6 +140,10 @@ def __init__( self.created_date_utc = created_date_utc if job_title is not None: self.job_title = job_title + if engagement_type is not None: + self.engagement_type = engagement_type + if fixed_term_end_date is not None: + self.fixed_term_end_date = fixed_term_end_date @property def employee_id(self): @@ -484,3 +496,49 @@ def job_title(self, job_title): """ self._job_title = job_title + + @property + def engagement_type(self): + """Gets the engagement_type of this Employee. # noqa: E501 + + Engagement type of the employee # noqa: E501 + + :return: The engagement_type of this Employee. # noqa: E501 + :rtype: str + """ + return self._engagement_type + + @engagement_type.setter + def engagement_type(self, engagement_type): + """Sets the engagement_type of this Employee. + + Engagement type of the employee # noqa: E501 + + :param engagement_type: The engagement_type of this Employee. # noqa: E501 + :type: str + """ + + self._engagement_type = engagement_type + + @property + def fixed_term_end_date(self): + """Gets the fixed_term_end_date of this Employee. # noqa: E501 + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :return: The fixed_term_end_date of this Employee. # noqa: E501 + :rtype: date + """ + return self._fixed_term_end_date + + @fixed_term_end_date.setter + def fixed_term_end_date(self, fixed_term_end_date): + """Sets the fixed_term_end_date of this Employee. + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :param fixed_term_end_date: The fixed_term_end_date of this Employee. # noqa: E501 + :type: date + """ + + self._fixed_term_end_date = fixed_term_end_date diff --git a/xero_python/payrollnz/models/employee_leave_setup.py b/xero_python/payrollnz/models/employee_leave_setup.py index 2a63a0bd..1e197d54 100644 --- a/xero_python/payrollnz/models/employee_leave_setup.py +++ b/xero_python/payrollnz/models/employee_leave_setup.py @@ -37,6 +37,8 @@ class EmployeeLeaveSetup(BaseModel): "sick_leave_hours_to_accrue_annually": "float", "sick_leave_maximum_hours_to_accrue": "float", "sick_leave_opening_balance": "float", + "sick_leave_schedule_of_accrual": "str", + "sick_leave_anniversary_date": "date", } attribute_map = { @@ -47,6 +49,8 @@ class EmployeeLeaveSetup(BaseModel): "sick_leave_hours_to_accrue_annually": "sickLeaveHoursToAccrueAnnually", "sick_leave_maximum_hours_to_accrue": "sickLeaveMaximumHoursToAccrue", "sick_leave_opening_balance": "sickLeaveOpeningBalance", + "sick_leave_schedule_of_accrual": "SickLeaveScheduleOfAccrual", + "sick_leave_anniversary_date": "SickLeaveAnniversaryDate", } def __init__( @@ -58,6 +62,8 @@ def __init__( sick_leave_hours_to_accrue_annually=None, sick_leave_maximum_hours_to_accrue=None, sick_leave_opening_balance=None, + sick_leave_schedule_of_accrual=None, + sick_leave_anniversary_date=None, ): # noqa: E501 """EmployeeLeaveSetup - a model defined in OpenAPI""" # noqa: E501 @@ -68,6 +74,8 @@ def __init__( self._sick_leave_hours_to_accrue_annually = None self._sick_leave_maximum_hours_to_accrue = None self._sick_leave_opening_balance = None + self._sick_leave_schedule_of_accrual = None + self._sick_leave_anniversary_date = None self.discriminator = None if include_holiday_pay is not None: @@ -88,6 +96,10 @@ def __init__( self.sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue if sick_leave_opening_balance is not None: self.sick_leave_opening_balance = sick_leave_opening_balance + if sick_leave_schedule_of_accrual is not None: + self.sick_leave_schedule_of_accrual = sick_leave_schedule_of_accrual + if sick_leave_anniversary_date is not None: + self.sick_leave_anniversary_date = sick_leave_anniversary_date @property def include_holiday_pay(self): @@ -253,3 +265,49 @@ def sick_leave_opening_balance(self, sick_leave_opening_balance): """ self._sick_leave_opening_balance = sick_leave_opening_balance + + @property + def sick_leave_schedule_of_accrual(self): + """Gets the sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + + Set Schedule of Accrual Type for Sick Leave # noqa: E501 + + :return: The sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + :rtype: str + """ + return self._sick_leave_schedule_of_accrual + + @sick_leave_schedule_of_accrual.setter + def sick_leave_schedule_of_accrual(self, sick_leave_schedule_of_accrual): + """Sets the sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. + + Set Schedule of Accrual Type for Sick Leave # noqa: E501 + + :param sick_leave_schedule_of_accrual: The sick_leave_schedule_of_accrual of this EmployeeLeaveSetup. # noqa: E501 + :type: str + """ + + self._sick_leave_schedule_of_accrual = sick_leave_schedule_of_accrual + + @property + def sick_leave_anniversary_date(self): + """Gets the sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + + If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave # noqa: E501 + + :return: The sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :rtype: date + """ + return self._sick_leave_anniversary_date + + @sick_leave_anniversary_date.setter + def sick_leave_anniversary_date(self, sick_leave_anniversary_date): + """Sets the sick_leave_anniversary_date of this EmployeeLeaveSetup. + + If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave # noqa: E501 + + :param sick_leave_anniversary_date: The sick_leave_anniversary_date of this EmployeeLeaveSetup. # noqa: E501 + :type: date + """ + + self._sick_leave_anniversary_date = sick_leave_anniversary_date diff --git a/xero_python/payrollnz/models/employee_leave_type.py b/xero_python/payrollnz/models/employee_leave_type.py index 0a5814e7..5ccf7b9d 100644 --- a/xero_python/payrollnz/models/employee_leave_type.py +++ b/xero_python/payrollnz/models/employee_leave_type.py @@ -40,6 +40,7 @@ class EmployeeLeaveType(BaseModel): "include_holiday_pay_every_pay": "bool", "show_annual_leave_in_advance": "bool", "annual_leave_total_amount_paid": "float", + "schedule_of_accrual_date": "date", } attribute_map = { @@ -53,6 +54,7 @@ class EmployeeLeaveType(BaseModel): "include_holiday_pay_every_pay": "includeHolidayPayEveryPay", "show_annual_leave_in_advance": "showAnnualLeaveInAdvance", "annual_leave_total_amount_paid": "annualLeaveTotalAmountPaid", + "schedule_of_accrual_date": "scheduleOfAccrualDate", } def __init__( @@ -67,6 +69,7 @@ def __init__( include_holiday_pay_every_pay=None, show_annual_leave_in_advance=None, annual_leave_total_amount_paid=None, + schedule_of_accrual_date=None, ): # noqa: E501 """EmployeeLeaveType - a model defined in OpenAPI""" # noqa: E501 @@ -80,6 +83,7 @@ def __init__( self._include_holiday_pay_every_pay = None self._show_annual_leave_in_advance = None self._annual_leave_total_amount_paid = None + self._schedule_of_accrual_date = None self.discriminator = None if leave_type_id is not None: @@ -102,6 +106,8 @@ def __init__( self.show_annual_leave_in_advance = show_annual_leave_in_advance if annual_leave_total_amount_paid is not None: self.annual_leave_total_amount_paid = annual_leave_total_amount_paid + if schedule_of_accrual_date is not None: + self.schedule_of_accrual_date = schedule_of_accrual_date @property def leave_type_id(self): @@ -347,3 +353,26 @@ def annual_leave_total_amount_paid(self, annual_leave_total_amount_paid): """ self._annual_leave_total_amount_paid = annual_leave_total_amount_paid + + @property + def schedule_of_accrual_date(self): + """Gets the schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + + The date when an employee becomes entitled to their accrual. # noqa: E501 + + :return: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :rtype: date + """ + return self._schedule_of_accrual_date + + @schedule_of_accrual_date.setter + def schedule_of_accrual_date(self, schedule_of_accrual_date): + """Sets the schedule_of_accrual_date of this EmployeeLeaveType. + + The date when an employee becomes entitled to their accrual. # noqa: E501 + + :param schedule_of_accrual_date: The schedule_of_accrual_date of this EmployeeLeaveType. # noqa: E501 + :type: date + """ + + self._schedule_of_accrual_date = schedule_of_accrual_date diff --git a/xero_python/payrollnz/models/employee_working_pattern.py b/xero_python/payrollnz/models/employee_working_pattern.py new file mode 100644 index 00000000..90b742a4 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPattern(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"payee_working_pattern_id": "str", "effective_from": "date"} + + attribute_map = { + "payee_working_pattern_id": "payeeWorkingPatternID", + "effective_from": "effectiveFrom", + } + + def __init__( + self, payee_working_pattern_id=None, effective_from=None + ): # noqa: E501 + """EmployeeWorkingPattern - a model defined in OpenAPI""" # noqa: E501 + + self._payee_working_pattern_id = None + self._effective_from = None + self.discriminator = None + + self.payee_working_pattern_id = payee_working_pattern_id + self.effective_from = effective_from + + @property + def payee_working_pattern_id(self): + """Gets the payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + + The Xero identifier for for Employee working pattern # noqa: E501 + + :return: The payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + :rtype: str + """ + return self._payee_working_pattern_id + + @payee_working_pattern_id.setter + def payee_working_pattern_id(self, payee_working_pattern_id): + """Sets the payee_working_pattern_id of this EmployeeWorkingPattern. + + The Xero identifier for for Employee working pattern # noqa: E501 + + :param payee_working_pattern_id: The payee_working_pattern_id of this EmployeeWorkingPattern. # noqa: E501 + :type: str + """ + if payee_working_pattern_id is None: + raise ValueError( + "Invalid value for `payee_working_pattern_id`, must not be `None`" + ) # noqa: E501 + + self._payee_working_pattern_id = payee_working_pattern_id + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPattern. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPattern. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPattern. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPattern. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py new file mode 100644 index 00000000..c673c69f --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks.py @@ -0,0 +1,132 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeks(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "payee_working_pattern_id": "str", + "effective_from": "date", + "working_weeks": "list[WorkingWeek]", + } + + attribute_map = { + "payee_working_pattern_id": "payeeWorkingPatternID", + "effective_from": "effectiveFrom", + "working_weeks": "workingWeeks", + } + + def __init__( + self, payee_working_pattern_id=None, effective_from=None, working_weeks=None + ): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeks - a model defined in OpenAPI""" # noqa: E501 + + self._payee_working_pattern_id = None + self._effective_from = None + self._working_weeks = None + self.discriminator = None + + self.payee_working_pattern_id = payee_working_pattern_id + self.effective_from = effective_from + if working_weeks is not None: + self.working_weeks = working_weeks + + @property + def payee_working_pattern_id(self): + """Gets the payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + The Xero identifier for for Employee working pattern # noqa: E501 + + :return: The payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: str + """ + return self._payee_working_pattern_id + + @payee_working_pattern_id.setter + def payee_working_pattern_id(self, payee_working_pattern_id): + """Sets the payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. + + The Xero identifier for for Employee working pattern # noqa: E501 + + :param payee_working_pattern_id: The payee_working_pattern_id of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: str + """ + if payee_working_pattern_id is None: + raise ValueError( + "Invalid value for `payee_working_pattern_id`, must not be `None`" + ) # noqa: E501 + + self._payee_working_pattern_id = payee_working_pattern_id + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPatternWithWorkingWeeks. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from + + @property + def working_weeks(self): + """Gets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + + + :return: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :rtype: list[WorkingWeek] + """ + return self._working_weeks + + @working_weeks.setter + def working_weeks(self, working_weeks): + """Sets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. + + + :param working_weeks: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeks. # noqa: E501 + :type: list[WorkingWeek] + """ + + self._working_weeks = working_weeks diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py new file mode 100644 index 00000000..4982c6df --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeksObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "payee_working_pattern": "EmployeeWorkingPatternWithWorkingWeeks", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "payee_working_pattern": "payeeWorkingPattern", + } + + def __init__( + self, pagination=None, problem=None, payee_working_pattern=None + ): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeksObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._payee_working_pattern = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if payee_working_pattern is not None: + self.payee_working_pattern = payee_working_pattern + + @property + def pagination(self): + """Gets the pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param pagination: The pagination of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param problem: The problem of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def payee_working_pattern(self): + """Gets the payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + + + :return: The payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :rtype: EmployeeWorkingPatternWithWorkingWeeks + """ + return self._payee_working_pattern + + @payee_working_pattern.setter + def payee_working_pattern(self, payee_working_pattern): + """Sets the payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. + + + :param payee_working_pattern: The payee_working_pattern of this EmployeeWorkingPatternWithWorkingWeeksObject. # noqa: E501 + :type: EmployeeWorkingPatternWithWorkingWeeks + """ + + self._payee_working_pattern = payee_working_pattern diff --git a/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py new file mode 100644 index 00000000..c58be009 --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_pattern_with_working_weeks_request.py @@ -0,0 +1,96 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternWithWorkingWeeksRequest(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"effective_from": "date", "working_weeks": "list[WorkingWeek]"} + + attribute_map = {"effective_from": "effectiveFrom", "working_weeks": "workingWeeks"} + + def __init__(self, effective_from=None, working_weeks=None): # noqa: E501 + """EmployeeWorkingPatternWithWorkingWeeksRequest - a model defined in OpenAPI""" # noqa: E501 + + self._effective_from = None + self._working_weeks = None + self.discriminator = None + + self.effective_from = effective_from + self.working_weeks = working_weeks + + @property + def effective_from(self): + """Gets the effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + + The effective date of the corresponding salary and wages # noqa: E501 + + :return: The effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :rtype: date + """ + return self._effective_from + + @effective_from.setter + def effective_from(self, effective_from): + """Sets the effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. + + The effective date of the corresponding salary and wages # noqa: E501 + + :param effective_from: The effective_from of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :type: date + """ + if effective_from is None: + raise ValueError( + "Invalid value for `effective_from`, must not be `None`" + ) # noqa: E501 + + self._effective_from = effective_from + + @property + def working_weeks(self): + """Gets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + + + :return: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :rtype: list[WorkingWeek] + """ + return self._working_weeks + + @working_weeks.setter + def working_weeks(self, working_weeks): + """Sets the working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. + + + :param working_weeks: The working_weeks of this EmployeeWorkingPatternWithWorkingWeeksRequest. # noqa: E501 + :type: list[WorkingWeek] + """ + if working_weeks is None: + raise ValueError( + "Invalid value for `working_weeks`, must not be `None`" + ) # noqa: E501 + + self._working_weeks = working_weeks diff --git a/xero_python/payrollnz/models/employee_working_patterns_object.py b/xero_python/payrollnz/models/employee_working_patterns_object.py new file mode 100644 index 00000000..9a3281ad --- /dev/null +++ b/xero_python/payrollnz/models/employee_working_patterns_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class EmployeeWorkingPatternsObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "payee_working_patterns": "list[EmployeeWorkingPattern]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "payee_working_patterns": "payeeWorkingPatterns", + } + + def __init__( + self, pagination=None, problem=None, payee_working_patterns=None + ): # noqa: E501 + """EmployeeWorkingPatternsObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._payee_working_patterns = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if payee_working_patterns is not None: + self.payee_working_patterns = payee_working_patterns + + @property + def pagination(self): + """Gets the pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this EmployeeWorkingPatternsObject. + + + :param pagination: The pagination of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The problem of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this EmployeeWorkingPatternsObject. + + + :param problem: The problem of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def payee_working_patterns(self): + """Gets the payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + + + :return: The payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + :rtype: list[EmployeeWorkingPattern] + """ + return self._payee_working_patterns + + @payee_working_patterns.setter + def payee_working_patterns(self, payee_working_patterns): + """Sets the payee_working_patterns of this EmployeeWorkingPatternsObject. + + + :param payee_working_patterns: The payee_working_patterns of this EmployeeWorkingPatternsObject. # noqa: E501 + :type: list[EmployeeWorkingPattern] + """ + + self._payee_working_patterns = payee_working_patterns diff --git a/xero_python/payrollnz/models/employment.py b/xero_python/payrollnz/models/employment.py index da83247b..d520d46e 100644 --- a/xero_python/payrollnz/models/employment.py +++ b/xero_python/payrollnz/models/employment.py @@ -33,22 +33,33 @@ class Employment(BaseModel): "payroll_calendar_id": "str", "pay_run_calendar_id": "str", "start_date": "date", + "engagement_type": "str", + "fixed_term_end_date": "date", } attribute_map = { "payroll_calendar_id": "payrollCalendarID", "pay_run_calendar_id": "payRunCalendarID", "start_date": "startDate", + "engagement_type": "engagementType", + "fixed_term_end_date": "fixedTermEndDate", } def __init__( - self, payroll_calendar_id=None, pay_run_calendar_id=None, start_date=None + self, + payroll_calendar_id=None, + pay_run_calendar_id=None, + start_date=None, + engagement_type=None, + fixed_term_end_date=None, ): # noqa: E501 """Employment - a model defined in OpenAPI""" # noqa: E501 self._payroll_calendar_id = None self._pay_run_calendar_id = None self._start_date = None + self._engagement_type = None + self._fixed_term_end_date = None self.discriminator = None if payroll_calendar_id is not None: @@ -57,6 +68,10 @@ def __init__( self.pay_run_calendar_id = pay_run_calendar_id if start_date is not None: self.start_date = start_date + if engagement_type is not None: + self.engagement_type = engagement_type + if fixed_term_end_date is not None: + self.fixed_term_end_date = fixed_term_end_date @property def payroll_calendar_id(self): @@ -126,3 +141,49 @@ def start_date(self, start_date): """ self._start_date = start_date + + @property + def engagement_type(self): + """Gets the engagement_type of this Employment. # noqa: E501 + + Engagement type of the employee # noqa: E501 + + :return: The engagement_type of this Employment. # noqa: E501 + :rtype: str + """ + return self._engagement_type + + @engagement_type.setter + def engagement_type(self, engagement_type): + """Sets the engagement_type of this Employment. + + Engagement type of the employee # noqa: E501 + + :param engagement_type: The engagement_type of this Employment. # noqa: E501 + :type: str + """ + + self._engagement_type = engagement_type + + @property + def fixed_term_end_date(self): + """Gets the fixed_term_end_date of this Employment. # noqa: E501 + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :return: The fixed_term_end_date of this Employment. # noqa: E501 + :rtype: date + """ + return self._fixed_term_end_date + + @fixed_term_end_date.setter + def fixed_term_end_date(self, fixed_term_end_date): + """Sets the fixed_term_end_date of this Employment. + + End date for an employee with a fixed-term engagement type # noqa: E501 + + :param fixed_term_end_date: The fixed_term_end_date of this Employment. # noqa: E501 + :type: date + """ + + self._fixed_term_end_date = fixed_term_end_date diff --git a/xero_python/payrollnz/models/salary_and_wage.py b/xero_python/payrollnz/models/salary_and_wage.py index 8034e143..5259d1c1 100644 --- a/xero_python/payrollnz/models/salary_and_wage.py +++ b/xero_python/payrollnz/models/salary_and_wage.py @@ -40,6 +40,7 @@ class SalaryAndWage(BaseModel): "annual_salary": "float", "status": "str", "payment_type": "str", + "work_pattern_type": "str", } attribute_map = { @@ -53,6 +54,7 @@ class SalaryAndWage(BaseModel): "annual_salary": "annualSalary", "status": "status", "payment_type": "paymentType", + "work_pattern_type": "workPatternType", } def __init__( @@ -67,6 +69,7 @@ def __init__( annual_salary=None, status=None, payment_type=None, + work_pattern_type=None, ): # noqa: E501 """SalaryAndWage - a model defined in OpenAPI""" # noqa: E501 @@ -80,6 +83,7 @@ def __init__( self._annual_salary = None self._status = None self._payment_type = None + self._work_pattern_type = None self.discriminator = None if salary_and_wages_id is not None: @@ -95,6 +99,8 @@ def __init__( self.annual_salary = annual_salary self.status = status self.payment_type = payment_type + if work_pattern_type is not None: + self.work_pattern_type = work_pattern_type @property def salary_and_wages_id(self): @@ -371,3 +377,35 @@ def payment_type(self, payment_type): ) self._payment_type = payment_type + + @property + def work_pattern_type(self): + """Gets the work_pattern_type of this SalaryAndWage. # noqa: E501 + + The type of the Working Pattern of the corresponding salary and wages # noqa: E501 + + :return: The work_pattern_type of this SalaryAndWage. # noqa: E501 + :rtype: str + """ + return self._work_pattern_type + + @work_pattern_type.setter + def work_pattern_type(self, work_pattern_type): + """Sets the work_pattern_type of this SalaryAndWage. + + The type of the Working Pattern of the corresponding salary and wages # noqa: E501 + + :param work_pattern_type: The work_pattern_type of this SalaryAndWage. # noqa: E501 + :type: str + """ + allowed_values = ["DaysAndHours", "RegularWeek", "None"] # noqa: E501 + + if work_pattern_type: + if work_pattern_type not in allowed_values: + raise ValueError( + "Invalid value for `work_pattern_type` ({0}), must be one of {1}".format( # noqa: E501 + work_pattern_type, allowed_values + ) + ) + + self._work_pattern_type = work_pattern_type diff --git a/xero_python/payrollnz/models/working_week.py b/xero_python/payrollnz/models/working_week.py new file mode 100644 index 00000000..bc047e1e --- /dev/null +++ b/xero_python/payrollnz/models/working_week.py @@ -0,0 +1,268 @@ +# coding: utf-8 + +""" + Xero Payroll NZ + + This is the Xero Payroll API for orgs in the NZ region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class WorkingWeek(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "monday": "float", + "tuesday": "float", + "wednesday": "float", + "thursday": "float", + "friday": "float", + "saturday": "float", + "sunday": "float", + } + + attribute_map = { + "monday": "monday", + "tuesday": "tuesday", + "wednesday": "wednesday", + "thursday": "thursday", + "friday": "friday", + "saturday": "saturday", + "sunday": "sunday", + } + + def __init__( + self, + monday=None, + tuesday=None, + wednesday=None, + thursday=None, + friday=None, + saturday=None, + sunday=None, + ): # noqa: E501 + """WorkingWeek - a model defined in OpenAPI""" # noqa: E501 + + self._monday = None + self._tuesday = None + self._wednesday = None + self._thursday = None + self._friday = None + self._saturday = None + self._sunday = None + self.discriminator = None + + self.monday = monday + self.tuesday = tuesday + self.wednesday = wednesday + self.thursday = thursday + self.friday = friday + self.saturday = saturday + self.sunday = sunday + + @property + def monday(self): + """Gets the monday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Monday # noqa: E501 + + :return: The monday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._monday + + @monday.setter + def monday(self, monday): + """Sets the monday of this WorkingWeek. + + The number of hours worked on a Monday # noqa: E501 + + :param monday: The monday of this WorkingWeek. # noqa: E501 + :type: float + """ + if monday is None: + raise ValueError( + "Invalid value for `monday`, must not be `None`" + ) # noqa: E501 + + self._monday = monday + + @property + def tuesday(self): + """Gets the tuesday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Tuesday # noqa: E501 + + :return: The tuesday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._tuesday + + @tuesday.setter + def tuesday(self, tuesday): + """Sets the tuesday of this WorkingWeek. + + The number of hours worked on a Tuesday # noqa: E501 + + :param tuesday: The tuesday of this WorkingWeek. # noqa: E501 + :type: float + """ + if tuesday is None: + raise ValueError( + "Invalid value for `tuesday`, must not be `None`" + ) # noqa: E501 + + self._tuesday = tuesday + + @property + def wednesday(self): + """Gets the wednesday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Wednesday # noqa: E501 + + :return: The wednesday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._wednesday + + @wednesday.setter + def wednesday(self, wednesday): + """Sets the wednesday of this WorkingWeek. + + The number of hours worked on a Wednesday # noqa: E501 + + :param wednesday: The wednesday of this WorkingWeek. # noqa: E501 + :type: float + """ + if wednesday is None: + raise ValueError( + "Invalid value for `wednesday`, must not be `None`" + ) # noqa: E501 + + self._wednesday = wednesday + + @property + def thursday(self): + """Gets the thursday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Thursday # noqa: E501 + + :return: The thursday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._thursday + + @thursday.setter + def thursday(self, thursday): + """Sets the thursday of this WorkingWeek. + + The number of hours worked on a Thursday # noqa: E501 + + :param thursday: The thursday of this WorkingWeek. # noqa: E501 + :type: float + """ + if thursday is None: + raise ValueError( + "Invalid value for `thursday`, must not be `None`" + ) # noqa: E501 + + self._thursday = thursday + + @property + def friday(self): + """Gets the friday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Friday # noqa: E501 + + :return: The friday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._friday + + @friday.setter + def friday(self, friday): + """Sets the friday of this WorkingWeek. + + The number of hours worked on a Friday # noqa: E501 + + :param friday: The friday of this WorkingWeek. # noqa: E501 + :type: float + """ + if friday is None: + raise ValueError( + "Invalid value for `friday`, must not be `None`" + ) # noqa: E501 + + self._friday = friday + + @property + def saturday(self): + """Gets the saturday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Saturday # noqa: E501 + + :return: The saturday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._saturday + + @saturday.setter + def saturday(self, saturday): + """Sets the saturday of this WorkingWeek. + + The number of hours worked on a Saturday # noqa: E501 + + :param saturday: The saturday of this WorkingWeek. # noqa: E501 + :type: float + """ + if saturday is None: + raise ValueError( + "Invalid value for `saturday`, must not be `None`" + ) # noqa: E501 + + self._saturday = saturday + + @property + def sunday(self): + """Gets the sunday of this WorkingWeek. # noqa: E501 + + The number of hours worked on a Sunday # noqa: E501 + + :return: The sunday of this WorkingWeek. # noqa: E501 + :rtype: float + """ + return self._sunday + + @sunday.setter + def sunday(self, sunday): + """Sets the sunday of this WorkingWeek. + + The number of hours worked on a Sunday # noqa: E501 + + :param sunday: The sunday of this WorkingWeek. # noqa: E501 + :type: float + """ + if sunday is None: + raise ValueError( + "Invalid value for `sunday`, must not be `None`" + ) # noqa: E501 + + self._sunday = sunday diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 9cee8e90..d689d230 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index b9d03183..e83edf2e 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -10,7 +10,7 @@ """ """ - OpenAPI spec version: 6.0.0 + OpenAPI spec version: 6.0.1 """ import importlib From 66f318940edd3055ab6ae40151a22fd42b82da78 Mon Sep 17 00:00:00 2001 From: sangeet-joy_xero Date: Tue, 30 Jul 2024 11:41:52 +0530 Subject: [PATCH 38/79] schema issue changes --- xero_python/payrollnz/api/payroll_nz_api.py | 4 ++-- xero_python/payrollnz/docs/PayrollNZApi.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 9d547e43..93fe8328 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -1074,7 +1074,7 @@ def create_employee_working_pattern( :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response - :return: EmployeeWorkingPatternWithWorkingWeeks + :return: EmployeeWorkingPatternWithWorkingWeeksObject """ # verify the required parameter 'xero_tenant_id' is set @@ -1138,7 +1138,7 @@ def create_employee_working_pattern( body=body_params, post_params=form_params, files=local_var_files, - response_type="EmployeeWorkingPatternWithWorkingWeeks", + response_type="EmployeeWorkingPatternWithWorkingWeeksObject", response_model_finder=self.get_model_finder(), auth_settings=auth_settings, _return_http_data_only=_return_http_data_only, diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index f0f47485..1c205d76 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -808,7 +808,7 @@ Name | Type | Description | Notes [[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) # **create_employee_working_pattern** -> EmployeeWorkingPatternWithWorkingWeeks create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) +> EmployeeWorkingPatternWithWorkingWeeksObject create_employee_working_pattern(xero_tenant_id, employee_id, employee_working_pattern_with_working_weeks_request, idempotency_key=idempotency_key) Creates an employee working pattern @@ -861,7 +861,7 @@ Name | Type | Description | Notes ### Return type -[**EmployeeWorkingPatternWithWorkingWeeks**](EmployeeWorkingPatternWithWorkingWeeks.md) +[**EmployeeWorkingPatternWithWorkingWeeksObject**](EmployeeWorkingPatternWithWorkingWeeksObject.md) ### Authorization From b3be9fff763f0b6a883cf6a99821d0b9d30e1ad0 Mon Sep 17 00:00:00 2001 From: sangeet-joy_xero Date: Sun, 4 Aug 2024 19:01:57 +0530 Subject: [PATCH 39/79] updated the minor version --- docs/v1/accounting/index.html | 2 +- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- xero_python/docs/README.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index aeeeea08..c0128a39 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -6216,7 +6216,7 @@

+ + + direction + + + +

+ + String + + +

+sort direction +

+ diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 7d7bca65..97957c74 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2716,7 +2716,7 @@

updatePayRun

Updates a pay run

-
-

/PayRuns/{PayRunID}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_pay_run():
-    api_instance = PayrollNzApi(api_client)
-    xero_tenant_id = 'xeroTenantId_example'
-    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-    idempotency_key = 'KEY_VALUE'
-    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
-    payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
-
-    pay_run_calendar = PayRunCalendar(
-        calendar_type = calendar_type.WEEKLY,
-        period_start_date = start_date,
-        payment_date = payment_date)
-    
-    try:
-        api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, payRun, idempotency_key)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling PayrollNzApi->updatePayRun: %s\n" % e)

Scopes

- - - - - - - -

payroll.payruns

Grant read-write access to payroll payruns

Parameters

Path parameters

- - - - - - - - - -

Name	Description
PayRunID*	- - - - - - - UUID - - - (uuid) - - - -Identifier for the pay run - - - - Required - - - -

Header parameters

- - - - - - - - - - - - - -

Name	Description
Xero-Tenant-Id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
Idempotency-Key	- - - - - - - String - - - -This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - - - -

Body parameters

- - - - - - - -

Name	Description
payRun *	- - - - PayRun - - - - - - - Required - - -

diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index d837394a..fef6c4c8 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3600,7 +3600,7 @@

Parameters

updatePayRun

Updates a specific pay run

-
-

/PayRuns/{PayRunID}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_pay_run():
-    api_instance = PayrollUkApi(api_client)
-    xero_tenant_id = 'xeroTenantId_example'
-    pay_run_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
-    idempotency_key = 'KEY_VALUE'
-    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
-    payment_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
-
-    pay_run_calendar = PayRunCalendar(
-        calendar_type = calendar_type.WEEKLY,
-        period_start_date = start_date,
-        payment_date = payment_date)
-    
-    try:
-        api_response = api_instance.update_pay_run(xero_tenant_id, pay_run_id, payRun, idempotency_key)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling PayrollUkApi->updatePayRun: %s\n" % e)

Scopes

- - - - - - - -

payroll.payruns

Grant read-write access to payroll payruns

Parameters

Path parameters

- - - - - - - - - -

Name	Description
PayRunID*	- - - - - - - UUID - - - (uuid) - - - -Identifier for the pay run - - - - Required - - - -

Header parameters

- - - - - - - - - - - - - -

Name	Description
Xero-Tenant-Id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
Idempotency-Key	- - - - - - - String - - - -This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - - - -

Body parameters

- - - - - - - -

Name	Description
payRun *	- - - - PayRun - - - - - - - Required - - -

diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 09eba840..e83e2303 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

+ + array[String] + + +

+Filter by a comma-separated list of References +

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index cdbe4fca..951d2061 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1419,7 +1419,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index 86e1ccb4..b9149441 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1170,7 +1170,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 85621be5..512d23f0 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2716,7 +2716,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

getAccountingActivityAccountUsage diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 427f4bc1..0d0b41ed 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3412,7 +3412,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index 01c42e9c..a54e4c63 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -1682,20 +1682,6 @@ "example" : 10.0, "x-is-money" : true }, - "sickLeaveHoursToAccrueAnnually" : { - "type" : "number", - "description" : "Deprecated use SickLeaveToAccrueAnnually", - "format" : "double", - "example" : 100.5, - "x-is-money" : true - }, - "sickLeaveMaximumHoursToAccrue" : { - "type" : "number", - "description" : "Deprecated use SickLeaveMaximumToAccrue", - "format" : "double", - "example" : 200.5, - "x-is-money" : true - }, "SickLeaveToAccrueAnnually" : { "type" : "number", "description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type", @@ -1769,13 +1755,7 @@ "description" : "The schedule of accrual", "enum" : [ "AnnuallyAfter6Months", "OnAnniversaryDate", "PercentageOfGrossEarnings", "NoAccruals" ] }, - "hoursAccruedAnnually" : { - "type" : "number", - "description" : "Deprecated use UnitsAccruedAnnually", - "format" : "double", - "x-is-money" : true - }, - "UnitsAccruedAnnually" : { + "unitsAccruedAnnually" : { "type" : "number", "description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"", "format" : "double", @@ -1803,7 +1783,7 @@ }, "rateAccruedHourly" : { "type" : "number", - "description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"", + "description" : "not supported in Payroll NZ", "format" : "double", "x-is-money" : true }, @@ -4087,7 +4067,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

approveTimesheet @@ -5390,8 +5370,6 @@

Usage and SDK Samples

include_holiday_pay = false, holiday_pay_opening_balance = 10.5, annual_leave_opening_balance = 25.89, - sick_leave_hours_to_accrue_annually = 100.0, - sick_leave_maximum_hours_to_accrue = 200.0, sick_leave_opening_balance = 10.5, sick_leave_to_accrue_annually = 100.0, sick_leave_maximum_to_accrue = 200.0, @@ -5531,7 +5509,6 @@

Parameters

"example" : { "holidayPayOpeningBalance" : 10, "annualLeaveOpeningBalance" : 100, - "sickLeaveHoursToAccrueAnnually" : 20, "sickLeaveToAccrueAnnually" : 20, "sickLeaveOpeningBalance" : 10, "sickLeaveScheduleOfAccrual" : "OnAnniversaryDate", @@ -5727,13 +5704,12 @@

Parameters

"example" : { "leaveTypeID" : "35da97ae-05b9-427f-9a98-69157ba42cec", "scheduleOfAccrual" : "AnnuallyAfter6Months", - "hoursAccruedAnnually" : 10, "unitsAccruedAnnually" : 10, "typeOfUnitsToAccrue" : "Hours", "openingBalanceTypeOfUnits" : "Hours", "maximumToAccrue" : 80, "openingBalance" : 100, - "rateAccruedHourly" : 3.5 + "rateAccruedHourly" : null } } }, diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index a01e4de5..43cfb205 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3700,7 +3700,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 1f318d41..d8768dbb 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1462,7 +1462,7 @@

SDK:
VSN: 9.3.0
VSN: 9.4.0
Methods

createProject diff --git a/setup.py b/setup.py index 8e16e76c..59a56b5a 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="9.3.0", + version="9.4.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 2934e6ca..3944cae5 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "9.3.0" +__version__ = "9.4.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 2f908e32..027afc5b 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ @@ -12854,6 +12854,7 @@ def get_overpayments( page=empty, unitdp=empty, page_size=empty, + references=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -12867,6 +12868,7 @@ def get_overpayments( :param int page: e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts :param int page_size: Number of records to retrieve per page + :param list[str] references: Filter by a comma-separated list of References :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -12880,7 +12882,9 @@ def get_overpayments( "when calling `get_overpayments`" ) - collection_formats = {} + collection_formats = { + "References": "csv", + } path_params = {} query_params = [] @@ -12900,6 +12904,9 @@ def get_overpayments( if page_size is not empty: query_params.append(("pageSize", page_size)) + if references is not empty: + query_params.append(("References", references)) + header_params = { "xero-tenant-id": xero_tenant_id, } diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index ec9ffa14..79630049 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -9887,7 +9887,7 @@ Name | Type | Description | Notes [[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) # **get_overpayments** -> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) +> Overpayments get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) Retrieves overpayments @@ -9924,9 +9924,10 @@ order = 'Status ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) page_size = 100 # int | Number of records to retrieve per page (optional) +references = ['"Ref1", "Ref2"'] # list[str] | Filter by a comma-separated list of References (optional) try: # Retrieves overpayments - api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) + api_response = api_instance.get_overpayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, references=references) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_overpayments: %s\n" % e) @@ -9943,6 +9944,7 @@ Name | Type | Description | Notes **page** | **int**| e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] **page_size** | **int**| Number of records to retrieve per page | [optional] + **references** | [**list[str]**](str.md)| Filter by a comma-separated list of References | [optional] ### Return type diff --git a/xero_python/accounting/docs/Overpayment.md b/xero_python/accounting/docs/Overpayment.md index d5f7f095..170c07ae 100644 --- a/xero_python/accounting/docs/Overpayment.md +++ b/xero_python/accounting/docs/Overpayment.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **applied_amount** | **float** | The amount of applied to an invoice | [optional] **payments** | [**list[Payment]**](Payment.md) | See Payments | [optional] **has_attachments** | **bool** | boolean to indicate if a overpayment has an attachment | [optional] [default to False] +**reference** | **str** | An optional description for Overpayment | [optional] **attachments** | [**list[Attachment]**](Attachment.md) | See Attachments | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/accounting/models/overpayment.py b/xero_python/accounting/models/overpayment.py index e96f6e56..8c3d4685 100644 --- a/xero_python/accounting/models/overpayment.py +++ b/xero_python/accounting/models/overpayment.py @@ -48,6 +48,7 @@ class Overpayment(BaseModel): "applied_amount": "float", "payments": "list[Payment]", "has_attachments": "bool", + "reference": "str", "attachments": "list[Attachment]", } @@ -70,6 +71,7 @@ class Overpayment(BaseModel): "applied_amount": "AppliedAmount", "payments": "Payments", "has_attachments": "HasAttachments", + "reference": "Reference", "attachments": "Attachments", } @@ -93,6 +95,7 @@ def __init__( applied_amount=None, payments=None, has_attachments=False, + reference=None, attachments=None, ): # noqa: E501 """Overpayment - a model defined in OpenAPI""" # noqa: E501 @@ -115,6 +118,7 @@ def __init__( self._applied_amount = None self._payments = None self._has_attachments = None + self._reference = None self._attachments = None self.discriminator = None @@ -154,6 +158,8 @@ def __init__( self.payments = payments if has_attachments is not None: self.has_attachments = has_attachments + if reference is not None: + self.reference = reference if attachments is not None: self.attachments = attachments @@ -588,6 +594,29 @@ def has_attachments(self, has_attachments): self._has_attachments = has_attachments + @property + def reference(self): + """Gets the reference of this Overpayment. # noqa: E501 + + An optional description for Overpayment # noqa: E501 + + :return: The reference of this Overpayment. # noqa: E501 + :rtype: str + """ + return self._reference + + @reference.setter + def reference(self, reference): + """Sets the reference of this Overpayment. + + An optional description for Overpayment # noqa: E501 + + :param reference: The reference of this Overpayment. # noqa: E501 + :type: str + """ + + self._reference = reference + @property def attachments(self): """Gets the attachments of this Overpayment. # noqa: E501 diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index 07440aaf..d86269b2 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 5f161168..22b5cf63 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 0dc2ac55..6b4fa8d2 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 9.3.0 -- Package version: 9.3.0 +- API version: 10.1.0 +- Package version: 9.4.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 35c76e36..4a45311a 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index c064d9d9..2b53c652 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 245f518f..d6251e09 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index e37062d3..0b1eca68 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 0f3aa8ef..372571b3 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md index bafe190a..ef05ec62 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveSetup.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveSetup.md @@ -7,8 +7,6 @@ Name | Type | Description | Notes **holiday_pay_opening_balance** | **float** | Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. | [optional] **annual_leave_opening_balance** | **float** | Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. | [optional] **negative_annual_leave_balance_paid_amount** | **float** | The dollar value of annual leave opening balance if negative. | [optional] -**sick_leave_hours_to_accrue_annually** | **float** | Deprecated use SickLeaveToAccrueAnnually | [optional] -**sick_leave_maximum_hours_to_accrue** | **float** | Deprecated use SickLeaveMaximumToAccrue | [optional] **sick_leave_to_accrue_annually** | **float** | Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type | [optional] **sick_leave_maximum_to_accrue** | **float** | Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type | [optional] **sick_leave_opening_balance** | **float** | Initial sick leave balance. This will be positive unless they've taken sick leave in advance | [optional] diff --git a/xero_python/payrollnz/docs/EmployeeLeaveType.md b/xero_python/payrollnz/docs/EmployeeLeaveType.md index aa9f9d2a..d5769bec 100644 --- a/xero_python/payrollnz/docs/EmployeeLeaveType.md +++ b/xero_python/payrollnz/docs/EmployeeLeaveType.md @@ -5,13 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **leave_type_id** | **str** | The Xero identifier for leave type | [optional] **schedule_of_accrual** | **str** | The schedule of accrual | [optional] -**hours_accrued_annually** | **float** | Deprecated use UnitsAccruedAnnually | [optional] **units_accrued_annually** | **float** | The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\" | [optional] **type_of_units_to_accrue** | **str** | The type of units accrued for the leave annually | [optional] **maximum_to_accrue** | **float** | The maximum number of units that can be accrued for the leave | [optional] **opening_balance** | **float** | The initial number of units assigned when the leave was added to the employee | [optional] **opening_balance_type_of_units** | **str** | The type of units for the opening balance | [optional] -**rate_accrued_hourly** | **float** | The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" | [optional] +**rate_accrued_hourly** | **float** | not supported in Payroll NZ | [optional] **percentage_of_gross_earnings** | **float** | Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. | [optional] **include_holiday_pay_every_pay** | **bool** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] **show_annual_leave_in_advance** | **bool** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional] diff --git a/xero_python/payrollnz/docs/PayrollNZApi.md b/xero_python/payrollnz/docs/PayrollNZApi.md index 75512755..6eb5aa9f 100644 --- a/xero_python/payrollnz/docs/PayrollNZApi.md +++ b/xero_python/payrollnz/docs/PayrollNZApi.md @@ -504,7 +504,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_setup = {"holidayPayOpeningBalance":10,"annualLeaveOpeningBalance":100,"sickLeaveHoursToAccrueAnnually":20,"sickLeaveToAccrueAnnually":20,"sickLeaveOpeningBalance":10,"sickLeaveScheduleOfAccrual":"OnAnniversaryDate","sickLeaveAnniversaryDate":"2023-12-31","annualLeaveAnniversaryDate":"2023-12-31"} # EmployeeLeaveSetup | +employee_leave_setup = {"holidayPayOpeningBalance":10,"annualLeaveOpeningBalance":100,"sickLeaveToAccrueAnnually":20,"sickLeaveOpeningBalance":10,"sickLeaveScheduleOfAccrual":"OnAnniversaryDate","sickLeaveAnniversaryDate":"2023-12-31","annualLeaveAnniversaryDate":"2023-12-31"} # EmployeeLeaveSetup | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a leave set-up for a specific employee. This is required before viewing, configuring and requesting leave for an employee @@ -571,7 +571,7 @@ api_instance = PayrollNzApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Employee id for single object -employee_leave_type = {"leaveTypeID":"35da97ae-05b9-427f-9a98-69157ba42cec","scheduleOfAccrual":"AnnuallyAfter6Months","hoursAccruedAnnually":10,"unitsAccruedAnnually":10,"typeOfUnitsToAccrue":"Hours","openingBalanceTypeOfUnits":"Hours","maximumToAccrue":80,"openingBalance":100,"rateAccruedHourly":3.5} # EmployeeLeaveType | +employee_leave_type = {"leaveTypeID":"35da97ae-05b9-427f-9a98-69157ba42cec","scheduleOfAccrual":"AnnuallyAfter6Months","unitsAccruedAnnually":10,"typeOfUnitsToAccrue":"Hours","openingBalanceTypeOfUnits":"Hours","maximumToAccrue":80,"openingBalance":100,"rateAccruedHourly":null} # EmployeeLeaveType | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates leave type records for a specific employee diff --git a/xero_python/payrollnz/models/employee_leave_setup.py b/xero_python/payrollnz/models/employee_leave_setup.py index 24e336e9..0258b8c6 100644 --- a/xero_python/payrollnz/models/employee_leave_setup.py +++ b/xero_python/payrollnz/models/employee_leave_setup.py @@ -34,8 +34,6 @@ class EmployeeLeaveSetup(BaseModel): "holiday_pay_opening_balance": "float", "annual_leave_opening_balance": "float", "negative_annual_leave_balance_paid_amount": "float", - "sick_leave_hours_to_accrue_annually": "float", - "sick_leave_maximum_hours_to_accrue": "float", "sick_leave_to_accrue_annually": "float", "sick_leave_maximum_to_accrue": "float", "sick_leave_opening_balance": "float", @@ -49,8 +47,6 @@ class EmployeeLeaveSetup(BaseModel): "holiday_pay_opening_balance": "holidayPayOpeningBalance", "annual_leave_opening_balance": "annualLeaveOpeningBalance", "negative_annual_leave_balance_paid_amount": "negativeAnnualLeaveBalancePaidAmount", - "sick_leave_hours_to_accrue_annually": "sickLeaveHoursToAccrueAnnually", - "sick_leave_maximum_hours_to_accrue": "sickLeaveMaximumHoursToAccrue", "sick_leave_to_accrue_annually": "SickLeaveToAccrueAnnually", "sick_leave_maximum_to_accrue": "SickLeaveMaximumToAccrue", "sick_leave_opening_balance": "sickLeaveOpeningBalance", @@ -65,8 +61,6 @@ def __init__( holiday_pay_opening_balance=None, annual_leave_opening_balance=None, negative_annual_leave_balance_paid_amount=None, - sick_leave_hours_to_accrue_annually=None, - sick_leave_maximum_hours_to_accrue=None, sick_leave_to_accrue_annually=None, sick_leave_maximum_to_accrue=None, sick_leave_opening_balance=None, @@ -80,8 +74,6 @@ def __init__( self._holiday_pay_opening_balance = None self._annual_leave_opening_balance = None self._negative_annual_leave_balance_paid_amount = None - self._sick_leave_hours_to_accrue_annually = None - self._sick_leave_maximum_hours_to_accrue = None self._sick_leave_to_accrue_annually = None self._sick_leave_maximum_to_accrue = None self._sick_leave_opening_balance = None @@ -100,12 +92,6 @@ def __init__( self.negative_annual_leave_balance_paid_amount = ( negative_annual_leave_balance_paid_amount ) - if sick_leave_hours_to_accrue_annually is not None: - self.sick_leave_hours_to_accrue_annually = ( - sick_leave_hours_to_accrue_annually - ) - if sick_leave_maximum_hours_to_accrue is not None: - self.sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue if sick_leave_to_accrue_annually is not None: self.sick_leave_to_accrue_annually = sick_leave_to_accrue_annually if sick_leave_maximum_to_accrue is not None: @@ -215,52 +201,6 @@ def negative_annual_leave_balance_paid_amount( negative_annual_leave_balance_paid_amount ) - @property - def sick_leave_hours_to_accrue_annually(self): - """Gets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 - - Deprecated use SickLeaveToAccrueAnnually # noqa: E501 - - :return: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 - :rtype: float - """ - return self._sick_leave_hours_to_accrue_annually - - @sick_leave_hours_to_accrue_annually.setter - def sick_leave_hours_to_accrue_annually(self, sick_leave_hours_to_accrue_annually): - """Sets the sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. - - Deprecated use SickLeaveToAccrueAnnually # noqa: E501 - - :param sick_leave_hours_to_accrue_annually: The sick_leave_hours_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 - :type: float - """ - - self._sick_leave_hours_to_accrue_annually = sick_leave_hours_to_accrue_annually - - @property - def sick_leave_maximum_hours_to_accrue(self): - """Gets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 - - Deprecated use SickLeaveMaximumToAccrue # noqa: E501 - - :return: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 - :rtype: float - """ - return self._sick_leave_maximum_hours_to_accrue - - @sick_leave_maximum_hours_to_accrue.setter - def sick_leave_maximum_hours_to_accrue(self, sick_leave_maximum_hours_to_accrue): - """Sets the sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. - - Deprecated use SickLeaveMaximumToAccrue # noqa: E501 - - :param sick_leave_maximum_hours_to_accrue: The sick_leave_maximum_hours_to_accrue of this EmployeeLeaveSetup. # noqa: E501 - :type: float - """ - - self._sick_leave_maximum_hours_to_accrue = sick_leave_maximum_hours_to_accrue - @property def sick_leave_to_accrue_annually(self): """Gets the sick_leave_to_accrue_annually of this EmployeeLeaveSetup. # noqa: E501 diff --git a/xero_python/payrollnz/models/employee_leave_type.py b/xero_python/payrollnz/models/employee_leave_type.py index db2a783e..b4bf4c2e 100644 --- a/xero_python/payrollnz/models/employee_leave_type.py +++ b/xero_python/payrollnz/models/employee_leave_type.py @@ -32,7 +32,6 @@ class EmployeeLeaveType(BaseModel): openapi_types = { "leave_type_id": "str", "schedule_of_accrual": "str", - "hours_accrued_annually": "float", "units_accrued_annually": "float", "type_of_units_to_accrue": "str", "maximum_to_accrue": "float", @@ -49,8 +48,7 @@ class EmployeeLeaveType(BaseModel): attribute_map = { "leave_type_id": "leaveTypeID", "schedule_of_accrual": "scheduleOfAccrual", - "hours_accrued_annually": "hoursAccruedAnnually", - "units_accrued_annually": "UnitsAccruedAnnually", + "units_accrued_annually": "unitsAccruedAnnually", "type_of_units_to_accrue": "typeOfUnitsToAccrue", "maximum_to_accrue": "maximumToAccrue", "opening_balance": "openingBalance", @@ -67,7 +65,6 @@ def __init__( self, leave_type_id=None, schedule_of_accrual=None, - hours_accrued_annually=None, units_accrued_annually=None, type_of_units_to_accrue=None, maximum_to_accrue=None, @@ -84,7 +81,6 @@ def __init__( self._leave_type_id = None self._schedule_of_accrual = None - self._hours_accrued_annually = None self._units_accrued_annually = None self._type_of_units_to_accrue = None self._maximum_to_accrue = None @@ -102,8 +98,6 @@ def __init__( self.leave_type_id = leave_type_id if schedule_of_accrual is not None: self.schedule_of_accrual = schedule_of_accrual - if hours_accrued_annually is not None: - self.hours_accrued_annually = hours_accrued_annually if units_accrued_annually is not None: self.units_accrued_annually = units_accrued_annually if type_of_units_to_accrue is not None: @@ -188,29 +182,6 @@ def schedule_of_accrual(self, schedule_of_accrual): self._schedule_of_accrual = schedule_of_accrual - @property - def hours_accrued_annually(self): - """Gets the hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 - - Deprecated use UnitsAccruedAnnually # noqa: E501 - - :return: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 - :rtype: float - """ - return self._hours_accrued_annually - - @hours_accrued_annually.setter - def hours_accrued_annually(self, hours_accrued_annually): - """Sets the hours_accrued_annually of this EmployeeLeaveType. - - Deprecated use UnitsAccruedAnnually # noqa: E501 - - :param hours_accrued_annually: The hours_accrued_annually of this EmployeeLeaveType. # noqa: E501 - :type: float - """ - - self._hours_accrued_annually = hours_accrued_annually - @property def units_accrued_annually(self): """Gets the units_accrued_annually of this EmployeeLeaveType. # noqa: E501 @@ -330,7 +301,7 @@ def opening_balance_type_of_units(self, opening_balance_type_of_units): def rate_accrued_hourly(self): """Gets the rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 - The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + not supported in Payroll NZ # noqa: E501 :return: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 :rtype: float @@ -341,7 +312,7 @@ def rate_accrued_hourly(self): def rate_accrued_hourly(self, rate_accrued_hourly): """Sets the rate_accrued_hourly of this EmployeeLeaveType. - The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\" # noqa: E501 + not supported in Payroll NZ # noqa: E501 :param rate_accrued_hourly: The rate_accrued_hourly of this EmployeeLeaveType. # noqa: E501 :type: float diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index cc8d1812..d7b7c3d4 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index ecf04843..97d1d784 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 9.3.0 + OpenAPI spec version: 10.1.0 """ From bf07569ffe43dbfaefda4356249d73e9d0f732ba Mon Sep 17 00:00:00 2001 From: Github Actions Date: Wed, 4 Mar 2026 04:21:29 +0000 Subject: [PATCH 68/79] Releasing 10.0.0 (OAS: 11.1.0) --- docs/v1/accounting/index.html | 3 +- docs/v1/appstore/index.html | 3 +- docs/v1/assets/index.html | 3 +- docs/v1/files/index.html | 3 +- docs/v1/finance/index.html | 868 +--- docs/v1/payroll-au-v2/index.html | 4468 +++++++++++++++++ docs/v1/payroll-au/index.html | 55 +- docs/v1/payroll-nz/index.html | 3 +- docs/v1/payroll-uk/index.html | 3 +- docs/v1/projects/index.html | 3 +- xero_python/accounting/api/accounting_api.py | 2 +- xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/finance/__init__.py | 10 - xero_python/finance/api/finance_api.py | 303 +- xero_python/finance/docs/FinanceApi.md | 266 - xero_python/finance/models/__init__.py | 10 - xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/__init__.py | 3 + xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollau/docs/EarningsRate.md | 1 + xero_python/payrollau/docs/Employee.md | 1 - xero_python/payrollau/docs/LeaveLine.md | 1 + xero_python/payrollau/docs/LeaveType.md | 1 + .../payrollau/docs/OpeningBalanceLeaveLine.md | 11 + xero_python/payrollau/docs/OpeningBalances.md | 2 +- xero_python/payrollau/docs/PayrollAuApi.md | 2 +- xero_python/payrollau/docs/TaxDeclaration.md | 1 + xero_python/payrollau/models/__init__.py | 3 + xero_python/payrollau/models/earnings_rate.py | 29 + xero_python/payrollau/models/employee.py | 27 - xero_python/payrollau/models/leave_line.py | 29 + xero_python/payrollau/models/leave_type.py | 29 + .../models/opening_balance_leave_line.py | 92 + .../payrollau/models/opening_balances.py | 6 +- .../payrollau/models/tax_declaration.py | 35 + xero_python/payrollauv2/__init__.py | 27 + xero_python/payrollauv2/api/__init__.py | 4 + .../payrollauv2/api/payroll_au_v2_api.py | 833 +++ xero_python/payrollauv2/docs/InvalidField.md | 11 + xero_python/payrollauv2/docs/Pagination.md | 13 + .../payrollauv2/docs/PayrollAuV2Api.md | 612 +++ xero_python/payrollauv2/docs/Problem.md | 15 + xero_python/payrollauv2/docs/Timesheet.md | 18 + xero_python/payrollauv2/docs/TimesheetLine.md | 14 + .../payrollauv2/docs/TimesheetLineObject.md | 12 + .../payrollauv2/docs/TimesheetObject.md | 12 + xero_python/payrollauv2/docs/Timesheets.md | 12 + xero_python/payrollauv2/models/__init__.py | 22 + .../payrollauv2/models/invalid_field.py | 92 + xero_python/payrollauv2/models/pagination.py | 148 + xero_python/payrollauv2/models/problem.py | 214 + xero_python/payrollauv2/models/timesheet.py | 324 ++ .../payrollauv2/models/timesheet_line.py | 198 + .../models/timesheet_line_object.py | 122 + .../payrollauv2/models/timesheet_object.py | 120 + xero_python/payrollauv2/models/timesheets.py | 120 + xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 62 files changed, 7725 insertions(+), 1514 deletions(-) create mode 100644 docs/v1/payroll-au-v2/index.html create mode 100644 xero_python/payrollau/docs/OpeningBalanceLeaveLine.md create mode 100644 xero_python/payrollau/models/opening_balance_leave_line.py create mode 100644 xero_python/payrollauv2/__init__.py create mode 100644 xero_python/payrollauv2/api/__init__.py create mode 100644 xero_python/payrollauv2/api/payroll_au_v2_api.py create mode 100644 xero_python/payrollauv2/docs/InvalidField.md create mode 100644 xero_python/payrollauv2/docs/Pagination.md create mode 100644 xero_python/payrollauv2/docs/PayrollAuV2Api.md create mode 100644 xero_python/payrollauv2/docs/Problem.md create mode 100644 xero_python/payrollauv2/docs/Timesheet.md create mode 100644 xero_python/payrollauv2/docs/TimesheetLine.md create mode 100644 xero_python/payrollauv2/docs/TimesheetLineObject.md create mode 100644 xero_python/payrollauv2/docs/TimesheetObject.md create mode 100644 xero_python/payrollauv2/docs/Timesheets.md create mode 100644 xero_python/payrollauv2/models/__init__.py create mode 100644 xero_python/payrollauv2/models/invalid_field.py create mode 100644 xero_python/payrollauv2/models/pagination.py create mode 100644 xero_python/payrollauv2/models/problem.py create mode 100644 xero_python/payrollauv2/models/timesheet.py create mode 100644 xero_python/payrollauv2/models/timesheet_line.py create mode 100644 xero_python/payrollauv2/models/timesheet_line_object.py create mode 100644 xero_python/payrollauv2/models/timesheet_object.py create mode 100644 xero_python/payrollauv2/models/timesheets.py diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index af968792..c6415660 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -6305,6 +6305,7 @@ + @@ -6349,7 +6350,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

createAccount diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index 865928c6..f38c5843 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1197,6 +1197,7 @@ + @@ -1241,7 +1242,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index 951d2061..dcea4beb 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1375,6 +1375,7 @@ + @@ -1419,7 +1420,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index b9149441..284eab7f 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1126,6 +1126,7 @@ + @@ -1170,7 +1171,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 512d23f0..761b2c20 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -862,104 +862,6 @@ + + + + + + + + + + + + +

+ +

Xero Payroll AU API 2.0

+ +

PayrollAuV2

approveTimesheet

Approves a specific timesheet

+
+

/Timesheets/{TimesheetID}/Approve

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_approve_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->approveTimesheet: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

createTimesheet

Creates a new timesheet

+
+

/Timesheets

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    idempotency_key = 'KEY_VALUE'
+    start_date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+    end_date = dateutil.parser.parse('2020-10-30T00:00:00Z')
+
+    timesheet = Timesheet(
+        payroll_calendar_id = "00000000-0000-0000-0000-000000000000",
+        employee_id = "00000000-0000-0000-0000-000000000000",
+        start_date = start_date,
+        end_date = end_date)
+    
+    try:
+        api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->createTimesheet: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
timesheet *	+ + + + Timesheet + + + + + + + Required + + + +

createTimesheetLine

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

+
+

/Timesheets/{TimesheetID}/Lines

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_create_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->createTimesheetLine: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
timesheetLine *	+ + + + TimesheetLine + + + + + + + Required + + + +

deleteTimesheet

Deletes a specific timesheet

+
+

/Timesheets/{TimesheetID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->deleteTimesheet: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

deleteTimesheetLine

Deletes a specific timesheet line

+
+

/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->deleteTimesheetLine: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +
TimesheetLineID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet line + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getTimesheet

Retrieve a specific timesheet by using a unique timesheet ID

+
+

/Timesheets/{TimesheetID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    
+    try:
+        api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->getTimesheet: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

payroll.timesheets	Grant read-write access to payroll timesheets
payroll.timesheets.read	Grant read-only access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

getTimesheets

Retrieves timesheets

+
+

/Timesheets

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_get_timesheets():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000'
+    status = 'Draft'
+    start_date = '2019-01-02'
+    end_date = '2020-01-02'
+    sort = 'startDate'
+    
+    try:
+        api_response = api_instance.get_timesheets(xero_tenant_id, page, filter, status, start_date, end_date, sort)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->getTimesheets: %s\n" % e)

Scopes

+ + + + + + + + + + + + +

payroll.timesheets	Grant read-write access to payroll timesheets
payroll.timesheets.read	Grant read-only access to payroll timesheets

Parameters

Header parameters

+ + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +

Query parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Description
page	+ + + + + + + Integer + + + +Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + + + + +
filter	+ + + + + + + String + + + +Filter by employeeId and/or payrollCalendarId + + + + +
status	+ + + + + + + String + + + +filter results by any timesheets with a matching timesheet status + + + + +
startDate	+ + + + + + + String + + + +filter results by any timesheets with a startDate on or after the provided date + + + + +
endDate	+ + + + + + + String + + + +filter results by any timesheets with a endDate on or before the provided date + + + + +
sort	+ + + + + + + String + + + +sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. + + + + +

revertTimesheet

Reverts a specific timesheet to draft

+
+

/Timesheets/{TimesheetID}/RevertToDraft

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_revert_timesheet():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    
+    try:
+        api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->revertTimesheet: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

updateTimesheetLine

Updates a specific timesheet line for a specific timesheet

+
+

/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_update_timesheet_line():
+    api_instance = PayrollAuV2Api(api_client)
+    xero_tenant_id = 'xeroTenantId_example'
+    timesheet_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    timesheet_line_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d'
+    idempotency_key = 'KEY_VALUE'
+    date = dateutil.parser.parse('2020-10-28T00:00:00Z')
+
+    timesheet_line = TimesheetLine(
+        timesheet_line_id = "00000000-0000-0000-0000-000000000000",
+        date = date,
+        earnings_rate_id = "00000000-0000-0000-0000-000000000000",
+        tracking_item_id = "00000000-0000-0000-0000-000000000000",
+        number_of_units = 6)
+    
+    try:
+        api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheetLine, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling PayrollAuV2Api->updateTimesheetLine: %s\n" % e)

Scopes

+ + + + + + + +

payroll.timesheets

Grant read-write access to payroll timesheets

Parameters

Path parameters

+ + + + + + + + + + + + + +

Name	Description
TimesheetID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet + + + + Required + + + +
TimesheetLineID*	+ + + + + + + UUID + + + (uuid) + + + +Identifier for the timesheet line + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
Xero-Tenant-Id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
timesheetLine *	+ + + + TimesheetLine + + + + + + + Required + + + +

+ +

+ + + + + + + + + + + + + + diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 0d0b41ed..de393ff9 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -1182,6 +1182,11 @@ "description" : "Boolean to determine if the earnings rate is reportable or exempt from W1", "example" : false }, + "IsQualifyingEarnings" : { + "type" : "boolean", + "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings", + "example" : true + }, "AllowanceContributesToAnnualLeaveRate" : { "type" : "boolean", "description" : "Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT", @@ -1419,12 +1424,6 @@ "$ref" : "#/components/schemas/LeaveBalance" } }, - "LeaveLines" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LeaveLine" - } - }, "SuperMemberships" : { "type" : "array", "items" : { @@ -1736,6 +1735,11 @@ "description" : "amount of leave line", "example" : true }, + "IsQualifyingEarnings" : { + "type" : "boolean", + "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings", + "example" : true + }, "NumberOfUnits" : { "type" : "number", "description" : "Number of units for leave line.", @@ -1877,6 +1881,11 @@ "type" : "boolean", "description" : "Set this to indicate that the leave type is exempt from superannuation guarantee contribution", "example" : true + }, + "IsQualifyingEarnings" : { + "type" : "boolean", + "description" : "Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings", + "example" : true } }, "description" : "" @@ -1892,6 +1901,26 @@ "type" : "string", "description" : "", "enum" : [ "PAYGMANUAL", "ETPOMANUAL", "ETPRMANUAL", "SCHEDULE5MANUAL", "SCHEDULE5STSLMANUAL", "SCHEDULE4MANUAL" ] +}; + defs["OpeningBalanceLeaveLine"] = { + "title" : "", + "type" : "object", + "properties" : { + "LeaveTypeID" : { + "type" : "string", + "description" : "Xero leave type identifier", + "format" : "uuid", + "example" : "742998cb-7584-4ecf-aa88-d694f59c50f9" + }, + "NumberOfUnits" : { + "type" : "number", + "description" : "Number of units for leave line.", + "format" : "double", + "example" : 2.5, + "x-is-money" : true + } + }, + "description" : "" }; defs["OpeningBalances"] = { "title" : "", @@ -1935,7 +1964,7 @@ "LeaveLines" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/LeaveLine" + "$ref" : "#/components/schemas/OpeningBalanceLeaveLine" } }, "PaidLeaveEarningsLines" : { @@ -3137,6 +3166,11 @@ "readOnly" : true, "example" : "/Date(1583967733054+0000)/", "x-is-msdate-time" : true + }, + "IncludeLeaveLoadingInQualifyingEarnings" : { + "type" : "boolean", + "description" : "Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations", + "example" : true } }, "description" : "" @@ -3368,6 +3402,7 @@ + @@ -3412,7 +3447,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

approveLeaveApplication @@ -4042,6 +4077,7 @@

Usage and SDK Samples

type_of_units = "Hours", is_exempt_from_tax = true, is_exempt_from_super = true, + is_qualifying_earnings = false, earningsType = "OVERTIMEEARNINGS") deduction_type = DeductionType( @@ -4178,9 +4214,10 @@

Parameters

"Name" : "MyRate", "AccountCode" : "400", "TypeOfUnits" : "4.00", - "IsExemptFromTax" : true, + "IsExemptFromTax" : false, "IsExemptFromSuper" : true, "IsReportableAsW1" : false, + "IsQualifyingEarnings" : true, "AllowanceContributesToAnnualLeaveRate" : false, "AllowanceContributesToOvertimeRate" : false, "EarningsType" : "ORDINARYTIMEEARNINGS", diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index a54e4c63..39efa086 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -4023,6 +4023,7 @@ + @@ -4067,7 +4068,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 43cfb205..7cc3f569 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3656,6 +3656,7 @@ + @@ -3700,7 +3701,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index d8768dbb..a7bcb8ff 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1418,6 +1418,7 @@ + @@ -1462,7 +1463,7 @@

SDK:
VSN: 9.4.0
VSN: 10.0.0
Methods

createProject diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 027afc5b..24cec18a 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index d86269b2..f4e27251 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 22b5cf63..12f86873 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 6b4fa8d2..3a2bc986 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 10.1.0 -- Package version: 9.4.0 +- API version: 11.1.0 +- Package version: 10.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 4a45311a..8e30b51b 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/finance/__init__.py b/xero_python/finance/__init__.py index ba9ad6f1..771c301b 100644 --- a/xero_python/finance/__init__.py +++ b/xero_python/finance/__init__.py @@ -17,8 +17,6 @@ # import models into sdk package -from xero_python.finance.models.account_usage import AccountUsage -from xero_python.finance.models.account_usage_response import AccountUsageResponse from xero_python.finance.models.balance_sheet_account_detail import ( BalanceSheetAccountDetail, ) @@ -50,27 +48,21 @@ CurrentStatementResponse, ) from xero_python.finance.models.data_source_response import DataSourceResponse -from xero_python.finance.models.history_record_response import HistoryRecordResponse from xero_python.finance.models.income_by_contact_response import ( IncomeByContactResponse, ) from xero_python.finance.models.invoice_response import InvoiceResponse from xero_python.finance.models.line_item_response import LineItemResponse -from xero_python.finance.models.lock_history_model import LockHistoryModel -from xero_python.finance.models.lock_history_response import LockHistoryResponse from xero_python.finance.models.manual_journal_total import ManualJournalTotal from xero_python.finance.models.overpayment_response import OverpaymentResponse from xero_python.finance.models.payment_response import PaymentResponse from xero_python.finance.models.pnl_account import PnlAccount from xero_python.finance.models.pnl_account_class import PnlAccountClass from xero_python.finance.models.pnl_account_type import PnlAccountType -from xero_python.finance.models.practice_response import PracticeResponse from xero_python.finance.models.prepayment_response import PrepaymentResponse from xero_python.finance.models.problem import Problem from xero_python.finance.models.problem_type import ProblemType from xero_python.finance.models.profit_and_loss_response import ProfitAndLossResponse -from xero_python.finance.models.report_history_model import ReportHistoryModel -from xero_python.finance.models.report_history_response import ReportHistoryResponse from xero_python.finance.models.statement_balance_response import ( StatementBalanceResponse, ) @@ -83,5 +75,3 @@ from xero_python.finance.models.trial_balance_entry import TrialBalanceEntry from xero_python.finance.models.trial_balance_movement import TrialBalanceMovement from xero_python.finance.models.trial_balance_response import TrialBalanceResponse -from xero_python.finance.models.user_activities_response import UserActivitiesResponse -from xero_python.finance.models.user_response import UserResponse diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index 2b53c652..7a2f37fb 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ @@ -56,307 +56,6 @@ def get_resource_url(self, resource_path): def get_model_finder(self): return ModelFinder(self.models_module) - def get_accounting_activity_account_usage( - self, - xero_tenant_id, - start_month=empty, - end_month=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get account usage # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str start_month: date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. - :param str end_month: date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: AccountUsageResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_account_usage`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if start_month is not empty: - query_params.append(("startMonth", start_month)) - - if end_month is not empty: - query_params.append(("endMonth", end_month)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/AccountUsage") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="AccountUsageResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_account_usage" - ) - - def get_accounting_activity_lock_history( - self, - xero_tenant_id, - end_date=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get lock history # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str end_date: date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: LockHistoryResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_lock_history`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if end_date is not empty: - query_params.append(("endDate", end_date)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/LockHistory") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="LockHistoryResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_lock_history" - ) - - def get_accounting_activity_report_history( - self, - xero_tenant_id, - end_date=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get report history # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str end_date: date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: ReportHistoryResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_report_history`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if end_date is not empty: - query_params.append(("endDate", end_date)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/ReportHistory") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="ReportHistoryResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_report_history" - ) - - def get_accounting_activity_user_activities( - self, - xero_tenant_id, - data_month=empty, - _return_http_data_only=True, - _preload_content=True, - _request_timeout=None, - ): - """Get user activities # noqa: E501 - OAuth2 scope: finance.accountingactivity.read - For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. # noqa: E501 - :param str xero_tenant_id: Xero identifier for Tenant (required) - :param str data_month: date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. - :param bool _return_http_data_only: return received data only - :param bool _preload_content: load received data in models - :param bool _request_timeout: maximum wait time for response - :return: UserActivitiesResponse - """ - - # verify the required parameter 'xero_tenant_id' is set - if xero_tenant_id is None: - raise ValueError( - "Missing the required parameter `xero_tenant_id` " - "when calling `get_accounting_activity_user_activities`" - ) - - collection_formats = {} - path_params = {} - - query_params = [] - - if data_month is not empty: - query_params.append(("dataMonth", data_month)) - - header_params = { - "xero-tenant-id": xero_tenant_id, - } - - local_var_files = {} - form_params = [] - - body_params = None - # HTTP header `Accept` - header_params["Accept"] = self.api_client.select_header_accept( - ["application/json"] - ) - - # Authentication setting - auth_settings = ["OAuth2"] - url = self.get_resource_url("/AccountingActivities/UserActivities") - - try: - return self.api_client.call_api( - url, - "GET", - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type="UserActivitiesResponse", - response_model_finder=self.get_model_finder(), - auth_settings=auth_settings, - _return_http_data_only=_return_http_data_only, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - collection_formats=collection_formats, - ) - except exceptions.HTTPStatusException as error: - raise translate_status_exception( - error, self, "get_accounting_activity_user_activities" - ) - def get_bank_statement_accounting( self, xero_tenant_id, diff --git a/xero_python/finance/docs/FinanceApi.md b/xero_python/finance/docs/FinanceApi.md index 1ff2db75..5b1c5667 100644 --- a/xero_python/finance/docs/FinanceApi.md +++ b/xero_python/finance/docs/FinanceApi.md @@ -4,10 +4,6 @@ All URIs are relative to *https://api.xero.com/finance.xro/1.0* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_accounting_activity_account_usage**](FinanceApi.md#get_accounting_activity_account_usage) | **GET** /AccountingActivities/AccountUsage | Get account usage -[**get_accounting_activity_lock_history**](FinanceApi.md#get_accounting_activity_lock_history) | **GET** /AccountingActivities/LockHistory | Get lock history -[**get_accounting_activity_report_history**](FinanceApi.md#get_accounting_activity_report_history) | **GET** /AccountingActivities/ReportHistory | Get report history -[**get_accounting_activity_user_activities**](FinanceApi.md#get_accounting_activity_user_activities) | **GET** /AccountingActivities/UserActivities | Get user activities [**get_bank_statement_accounting**](FinanceApi.md#get_bank_statement_accounting) | **GET** /BankStatementsPlus/statements | Get Bank Statement Accounting [**get_cash_validation**](FinanceApi.md#get_cash_validation) | **GET** /CashValidation | Get cash validation [**get_financial_statement_balance_sheet**](FinanceApi.md#get_financial_statement_balance_sheet) | **GET** /FinancialStatements/BalanceSheet | Get Balance Sheet report @@ -18,268 +14,6 @@ Method | HTTP request | Description [**get_financial_statement_trial_balance**](FinanceApi.md#get_financial_statement_trial_balance) | **GET** /FinancialStatements/TrialBalance | Get Trial Balance report -# **get_accounting_activity_account_usage** -> AccountUsageResponse get_accounting_activity_account_usage(xero_tenant_id, start_month=start_month, end_month=end_month) - -Get account usage - -A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -start_month = '2020-09' # str | date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. (optional) -end_month = '2021-09' # str | date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. (optional) -try: - # Get account usage - api_response = api_instance.get_accounting_activity_account_usage(xero_tenant_id, start_month=start_month, end_month=end_month) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_account_usage: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **start_month** | **str**| date, yyyy-MM If no parameter is provided, the month 12 months prior to the end month will be used. Account usage for up to 12 months from this date will be returned. | [optional] - **end_month** | **str**| date, yyyy-MM If no parameter is provided, the current month will be used. Account usage for up to 12 months prior to this date will be returned. | [optional] - -### Return type - -[**AccountUsageResponse**](AccountUsageResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **get_accounting_activity_lock_history** -> LockHistoryResponse get_accounting_activity_lock_history(xero_tenant_id, end_date=end_date) - -Get lock history - -Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -end_date = '2021-09-15' # str | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. (optional) -try: - # Get lock history - api_response = api_instance.get_accounting_activity_lock_history(xero_tenant_id, end_date=end_date) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_lock_history: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **end_date** | **str**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a change is visible from this API. | [optional] - -### Return type - -[**LockHistoryResponse**](LockHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **get_accounting_activity_report_history** -> ReportHistoryResponse get_accounting_activity_report_history(xero_tenant_id, end_date=end_date) - -Get report history - -For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -end_date = '2021-09-15' # str | date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. (optional) -try: - # Get report history - api_response = api_instance.get_accounting_activity_report_history(xero_tenant_id, end_date=end_date) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_report_history: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **end_date** | **str**| date, yyyy-MM-dd If no parameter is provided, the current date will be used. Any reports that were published within the period up to 12 months before this date will be returned. Please be aware that there may be a delay of up to 3 days before a published report is visible from this API. | [optional] - -### Return type - -[**ReportHistoryResponse**](ReportHistoryResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - -# **get_accounting_activity_user_activities** -> UserActivitiesResponse get_accounting_activity_user_activities(xero_tenant_id, data_month=data_month) - -Get user activities - -For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. - -### Example - -* OAuth Authentication (OAuth2): -```python -from xero_python.api_client import Configuration, ApiClient -from xero_python.api_client.oauth2 import OAuth2Token -from xero_python.exceptions import ApiException -from xero_python.finance import FinanceApi -from pprint import pprint - -# Configure OAuth2 access token for authorization: OAuth2 -# simplified version, `xero_oauth2_token` represents permanent global token storage -xero_oauth2_token = {} # set to valid xero oauth2 token dictionary -# create client configuration with client id and client secret for automatic token refresh -api_config = Configuration(oauth2_token=OAuth2Token( - client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" -)) -# configure xero-python sdk client -api_client = ApiClient( - api_config, - oauth2_token_saver=lambda x: xero_oauth2_token.update(x), - oauth2_token_getter=lambda : xero_oauth2_token -) -# create an instance of the API class -api_instance = FinanceApi(api_client) - -xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant -data_month = '2021-09' # str | date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. (optional) -try: - # Get user activities - api_response = api_instance.get_accounting_activity_user_activities(xero_tenant_id, data_month=data_month) - pprint(api_response) -except ApiException as e: - print("Exception when calling FinanceApi->get_accounting_activity_user_activities: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **xero_tenant_id** | **str**| Xero identifier for Tenant | - **data_month** | **str**| date, yyyy-MM The specified month must be complete (in the past); The current month cannot be specified since it is not complete. If no parameter is provided, the month immediately previous to the current month will be used. Any user activities occurring within the specified month will be returned. Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API. | [optional] - -### Return type - -[**UserActivitiesResponse**](UserActivitiesResponse.md) - -### Authorization - -[OAuth2](../README.md#OAuth2) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[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) - # **get_bank_statement_accounting** > BankStatementAccountingResponse get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, summary_only=summary_only) diff --git a/xero_python/finance/models/__init__.py b/xero_python/finance/models/__init__.py index 5996ef66..01631ae4 100644 --- a/xero_python/finance/models/__init__.py +++ b/xero_python/finance/models/__init__.py @@ -12,8 +12,6 @@ # import models into model package -from xero_python.finance.models.account_usage import AccountUsage -from xero_python.finance.models.account_usage_response import AccountUsageResponse from xero_python.finance.models.balance_sheet_account_detail import ( BalanceSheetAccountDetail, ) @@ -45,27 +43,21 @@ CurrentStatementResponse, ) from xero_python.finance.models.data_source_response import DataSourceResponse -from xero_python.finance.models.history_record_response import HistoryRecordResponse from xero_python.finance.models.income_by_contact_response import ( IncomeByContactResponse, ) from xero_python.finance.models.invoice_response import InvoiceResponse from xero_python.finance.models.line_item_response import LineItemResponse -from xero_python.finance.models.lock_history_model import LockHistoryModel -from xero_python.finance.models.lock_history_response import LockHistoryResponse from xero_python.finance.models.manual_journal_total import ManualJournalTotal from xero_python.finance.models.overpayment_response import OverpaymentResponse from xero_python.finance.models.payment_response import PaymentResponse from xero_python.finance.models.pnl_account import PnlAccount from xero_python.finance.models.pnl_account_class import PnlAccountClass from xero_python.finance.models.pnl_account_type import PnlAccountType -from xero_python.finance.models.practice_response import PracticeResponse from xero_python.finance.models.prepayment_response import PrepaymentResponse from xero_python.finance.models.problem import Problem from xero_python.finance.models.problem_type import ProblemType from xero_python.finance.models.profit_and_loss_response import ProfitAndLossResponse -from xero_python.finance.models.report_history_model import ReportHistoryModel -from xero_python.finance.models.report_history_response import ReportHistoryResponse from xero_python.finance.models.statement_balance_response import ( StatementBalanceResponse, ) @@ -78,5 +70,3 @@ from xero_python.finance.models.trial_balance_entry import TrialBalanceEntry from xero_python.finance.models.trial_balance_movement import TrialBalanceMovement from xero_python.finance.models.trial_balance_response import TrialBalanceResponse -from xero_python.finance.models.user_activities_response import UserActivitiesResponse -from xero_python.finance.models.user_response import UserResponse diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index d6251e09..90458d9a 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/payrollau/__init__.py b/xero_python/payrollau/__init__.py index c5c31356..029594ca 100644 --- a/xero_python/payrollau/__init__.py +++ b/xero_python/payrollau/__init__.py @@ -67,6 +67,9 @@ LeaveTypeContributionType, ) from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balance_leave_line import ( + OpeningBalanceLeaveLine, +) from xero_python.payrollau.models.opening_balances import OpeningBalances from xero_python.payrollau.models.paid_leave_earnings_line import PaidLeaveEarningsLine from xero_python.payrollau.models.pay_item import PayItem diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 0b1eca68..23c6d5f0 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/payrollau/docs/EarningsRate.md b/xero_python/payrollau/docs/EarningsRate.md index 6dcc4788..0756cb0a 100644 --- a/xero_python/payrollau/docs/EarningsRate.md +++ b/xero_python/payrollau/docs/EarningsRate.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **is_exempt_from_tax** | **bool** | Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding | [optional] **is_exempt_from_super** | **bool** | See the ATO website for details of which payments are exempt from SGC | [optional] **is_reportable_as_w1** | **bool** | Boolean to determine if the earnings rate is reportable or exempt from W1 | [optional] +**is_qualifying_earnings** | **bool** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings | [optional] **allowance_contributes_to_annual_leave_rate** | **bool** | Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] **allowance_contributes_to_overtime_rate** | **bool** | Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT | [optional] **earnings_type** | [**EarningsType**](EarningsType.md) | | [optional] diff --git a/xero_python/payrollau/docs/Employee.md b/xero_python/payrollau/docs/Employee.md index fe0c991d..0e754a22 100644 --- a/xero_python/payrollau/docs/Employee.md +++ b/xero_python/payrollau/docs/Employee.md @@ -34,7 +34,6 @@ Name | Type | Description | Notes **country_of_residence** | [**CountryOfResidence**](CountryOfResidence.md) | | [optional] **is_stp2_qualified** | **bool** | Indicates if the employee has been updated for STP Phase 2 compliance. Doesn't indicate that the employee is payable. | [optional] **leave_balances** | [**list[LeaveBalance]**](LeaveBalance.md) | | [optional] -**leave_lines** | [**list[LeaveLine]**](LeaveLine.md) | | [optional] **super_memberships** | [**list[SuperMembership]**](SuperMembership.md) | | [optional] **status** | [**EmployeeStatus**](EmployeeStatus.md) | | [optional] **updated_date_utc** | **datetime** | Last modified timestamp | [optional] diff --git a/xero_python/payrollau/docs/LeaveLine.md b/xero_python/payrollau/docs/LeaveLine.md index 18387baa..6986b42b 100644 --- a/xero_python/payrollau/docs/LeaveLine.md +++ b/xero_python/payrollau/docs/LeaveLine.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **entitlement_final_pay_payout_type** | [**EntitlementFinalPayPayoutType**](EntitlementFinalPayPayoutType.md) | | [optional] **employment_termination_payment_type** | [**EmploymentTerminationPaymentType**](EmploymentTerminationPaymentType.md) | | [optional] **include_superannuation_guarantee_contribution** | **bool** | amount of leave line | [optional] +**is_qualifying_earnings** | **bool** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings | [optional] **number_of_units** | **float** | Number of units for leave line. | [optional] **annual_number_of_units** | **float** | Hours of leave accrued each year | [optional] **full_time_number_of_units_per_period** | **float** | Normal ordinary earnings number of units for leave line. | [optional] diff --git a/xero_python/payrollau/docs/LeaveType.md b/xero_python/payrollau/docs/LeaveType.md index c0c89f5b..48c229e0 100644 --- a/xero_python/payrollau/docs/LeaveType.md +++ b/xero_python/payrollau/docs/LeaveType.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **current_record** | **bool** | Is the current record | [optional] **leave_category_code** | [**LeaveCategoryCode**](LeaveCategoryCode.md) | | [optional] **sgc_exempt** | **bool** | Set this to indicate that the leave type is exempt from superannuation guarantee contribution | [optional] +**is_qualifying_earnings** | **bool** | Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/OpeningBalanceLeaveLine.md b/xero_python/payrollau/docs/OpeningBalanceLeaveLine.md new file mode 100644 index 00000000..d9850130 --- /dev/null +++ b/xero_python/payrollau/docs/OpeningBalanceLeaveLine.md @@ -0,0 +1,11 @@ +# OpeningBalanceLeaveLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leave_type_id** | **str** | Xero leave type identifier | [optional] +**number_of_units** | **float** | Number of units for leave line. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollau/docs/OpeningBalances.md b/xero_python/payrollau/docs/OpeningBalances.md index aeaa55ba..14243bcb 100644 --- a/xero_python/payrollau/docs/OpeningBalances.md +++ b/xero_python/payrollau/docs/OpeningBalances.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **deduction_lines** | [**list[DeductionLine]**](DeductionLine.md) | | [optional] **super_lines** | [**list[SuperLine]**](SuperLine.md) | | [optional] **reimbursement_lines** | [**list[ReimbursementLine]**](ReimbursementLine.md) | | [optional] -**leave_lines** | [**list[LeaveLine]**](LeaveLine.md) | | [optional] +**leave_lines** | [**list[OpeningBalanceLeaveLine]**](OpeningBalanceLeaveLine.md) | | [optional] **paid_leave_earnings_lines** | [**list[PaidLeaveEarningsLine]**](PaidLeaveEarningsLine.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/docs/PayrollAuApi.md b/xero_python/payrollau/docs/PayrollAuApi.md index e23f5727..31b742f2 100644 --- a/xero_python/payrollau/docs/PayrollAuApi.md +++ b/xero_python/payrollau/docs/PayrollAuApi.md @@ -265,7 +265,7 @@ api_client = ApiClient( api_instance = PayrollAuApi(api_client) xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant -pay_item = {"EarningsRates":[{"Name":"MyRate","AccountCode":"400","TypeOfUnits":"4.00","IsExemptFromTax":true,"IsExemptFromSuper":true,"IsReportableAsW1":false,"AllowanceContributesToAnnualLeaveRate":false,"AllowanceContributesToOvertimeRate":false,"EarningsType":"ORDINARYTIMEEARNINGS","EarningsRateID":"1fa4e226-b711-46ba-a8a7-4344c9c5fb87","RateType":"MULTIPLE","RatePerUnit":"10.0","Multiplier":1.5,"Amount":5,"EmploymentTerminationPaymentType":"O"}]} # PayItem | +pay_item = {"EarningsRates":[{"Name":"MyRate","AccountCode":"400","TypeOfUnits":"4.00","IsExemptFromTax":false,"IsExemptFromSuper":true,"IsReportableAsW1":false,"IsQualifyingEarnings":true,"AllowanceContributesToAnnualLeaveRate":false,"AllowanceContributesToOvertimeRate":false,"EarningsType":"ORDINARYTIMEEARNINGS","EarningsRateID":"1fa4e226-b711-46ba-a8a7-4344c9c5fb87","RateType":"MULTIPLE","RatePerUnit":"10.0","Multiplier":1.5,"Amount":5,"EmploymentTerminationPaymentType":"O"}]} # PayItem | idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) try: # Creates a pay item diff --git a/xero_python/payrollau/docs/TaxDeclaration.md b/xero_python/payrollau/docs/TaxDeclaration.md index 69844487..cc8fc18b 100644 --- a/xero_python/payrollau/docs/TaxDeclaration.md +++ b/xero_python/payrollau/docs/TaxDeclaration.md @@ -24,6 +24,7 @@ Name | Type | Description | Notes **has_student_startup_loan** | **bool** | If the employee is eligible for student startup loan rules | [optional] **has_loan_or_student_debt** | **bool** | If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL) | [optional] **updated_date_utc** | **datetime** | Last modified timestamp | [optional] +**include_leave_loading_in_qualifying_earnings** | **bool** | Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/xero_python/payrollau/models/__init__.py b/xero_python/payrollau/models/__init__.py index a178a22d..a534bc59 100644 --- a/xero_python/payrollau/models/__init__.py +++ b/xero_python/payrollau/models/__init__.py @@ -62,6 +62,9 @@ LeaveTypeContributionType, ) from xero_python.payrollau.models.manual_tax_type import ManualTaxType +from xero_python.payrollau.models.opening_balance_leave_line import ( + OpeningBalanceLeaveLine, +) from xero_python.payrollau.models.opening_balances import OpeningBalances from xero_python.payrollau.models.paid_leave_earnings_line import PaidLeaveEarningsLine from xero_python.payrollau.models.pay_item import PayItem diff --git a/xero_python/payrollau/models/earnings_rate.py b/xero_python/payrollau/models/earnings_rate.py index 876eec5d..16cebf50 100644 --- a/xero_python/payrollau/models/earnings_rate.py +++ b/xero_python/payrollau/models/earnings_rate.py @@ -36,6 +36,7 @@ class EarningsRate(BaseModel): "is_exempt_from_tax": "bool", "is_exempt_from_super": "bool", "is_reportable_as_w1": "bool", + "is_qualifying_earnings": "bool", "allowance_contributes_to_annual_leave_rate": "bool", "allowance_contributes_to_overtime_rate": "bool", "earnings_type": "EarningsType", @@ -59,6 +60,7 @@ class EarningsRate(BaseModel): "is_exempt_from_tax": "IsExemptFromTax", "is_exempt_from_super": "IsExemptFromSuper", "is_reportable_as_w1": "IsReportableAsW1", + "is_qualifying_earnings": "IsQualifyingEarnings", "allowance_contributes_to_annual_leave_rate": "AllowanceContributesToAnnualLeaveRate", "allowance_contributes_to_overtime_rate": "AllowanceContributesToOvertimeRate", "earnings_type": "EarningsType", @@ -83,6 +85,7 @@ def __init__( is_exempt_from_tax=None, is_exempt_from_super=None, is_reportable_as_w1=None, + is_qualifying_earnings=None, allowance_contributes_to_annual_leave_rate=None, allowance_contributes_to_overtime_rate=None, earnings_type=None, @@ -106,6 +109,7 @@ def __init__( self._is_exempt_from_tax = None self._is_exempt_from_super = None self._is_reportable_as_w1 = None + self._is_qualifying_earnings = None self._allowance_contributes_to_annual_leave_rate = None self._allowance_contributes_to_overtime_rate = None self._earnings_type = None @@ -134,6 +138,8 @@ def __init__( self.is_exempt_from_super = is_exempt_from_super if is_reportable_as_w1 is not None: self.is_reportable_as_w1 = is_reportable_as_w1 + if is_qualifying_earnings is not None: + self.is_qualifying_earnings = is_qualifying_earnings if allowance_contributes_to_annual_leave_rate is not None: self.allowance_contributes_to_annual_leave_rate = ( allowance_contributes_to_annual_leave_rate @@ -317,6 +323,29 @@ def is_reportable_as_w1(self, is_reportable_as_w1): self._is_reportable_as_w1 = is_reportable_as_w1 + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this EarningsRate. # noqa: E501 + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings # noqa: E501 + + :return: The is_qualifying_earnings of this EarningsRate. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this EarningsRate. + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this EarningsRate. # noqa: E501 + :type: bool + """ + + self._is_qualifying_earnings = is_qualifying_earnings + @property def allowance_contributes_to_annual_leave_rate(self): """Gets the allowance_contributes_to_annual_leave_rate of this EarningsRate. # noqa: E501 diff --git a/xero_python/payrollau/models/employee.py b/xero_python/payrollau/models/employee.py index 57d352e9..b432faf8 100644 --- a/xero_python/payrollau/models/employee.py +++ b/xero_python/payrollau/models/employee.py @@ -61,7 +61,6 @@ class Employee(BaseModel): "country_of_residence": "CountryOfResidence", "is_stp2_qualified": "bool", "leave_balances": "list[LeaveBalance]", - "leave_lines": "list[LeaveLine]", "super_memberships": "list[SuperMembership]", "status": "EmployeeStatus", "updated_date_utc": "datetime[ms-format]", @@ -100,7 +99,6 @@ class Employee(BaseModel): "country_of_residence": "CountryOfResidence", "is_stp2_qualified": "IsSTP2Qualified", "leave_balances": "LeaveBalances", - "leave_lines": "LeaveLines", "super_memberships": "SuperMemberships", "status": "Status", "updated_date_utc": "UpdatedDateUTC", @@ -140,7 +138,6 @@ def __init__( country_of_residence=None, is_stp2_qualified=None, leave_balances=None, - leave_lines=None, super_memberships=None, status=None, updated_date_utc=None, @@ -179,7 +176,6 @@ def __init__( self._country_of_residence = None self._is_stp2_qualified = None self._leave_balances = None - self._leave_lines = None self._super_memberships = None self._status = None self._updated_date_utc = None @@ -247,8 +243,6 @@ def __init__( self.is_stp2_qualified = is_stp2_qualified if leave_balances is not None: self.leave_balances = leave_balances - if leave_lines is not None: - self.leave_lines = leave_lines if super_memberships is not None: self.super_memberships = super_memberships if status is not None: @@ -983,27 +977,6 @@ def leave_balances(self, leave_balances): self._leave_balances = leave_balances - @property - def leave_lines(self): - """Gets the leave_lines of this Employee. # noqa: E501 - - - :return: The leave_lines of this Employee. # noqa: E501 - :rtype: list[LeaveLine] - """ - return self._leave_lines - - @leave_lines.setter - def leave_lines(self, leave_lines): - """Sets the leave_lines of this Employee. - - - :param leave_lines: The leave_lines of this Employee. # noqa: E501 - :type: list[LeaveLine] - """ - - self._leave_lines = leave_lines - @property def super_memberships(self): """Gets the super_memberships of this Employee. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_line.py b/xero_python/payrollau/models/leave_line.py index 35335795..390ddfa3 100644 --- a/xero_python/payrollau/models/leave_line.py +++ b/xero_python/payrollau/models/leave_line.py @@ -35,6 +35,7 @@ class LeaveLine(BaseModel): "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", "employment_termination_payment_type": "EmploymentTerminationPaymentType", "include_superannuation_guarantee_contribution": "bool", + "is_qualifying_earnings": "bool", "number_of_units": "float", "annual_number_of_units": "float", "full_time_number_of_units_per_period": "float", @@ -46,6 +47,7 @@ class LeaveLine(BaseModel): "entitlement_final_pay_payout_type": "EntitlementFinalPayPayoutType", "employment_termination_payment_type": "EmploymentTerminationPaymentType", "include_superannuation_guarantee_contribution": "IncludeSuperannuationGuaranteeContribution", + "is_qualifying_earnings": "IsQualifyingEarnings", "number_of_units": "NumberOfUnits", "annual_number_of_units": "AnnualNumberOfUnits", "full_time_number_of_units_per_period": "FullTimeNumberOfUnitsPerPeriod", @@ -58,6 +60,7 @@ def __init__( entitlement_final_pay_payout_type=None, employment_termination_payment_type=None, include_superannuation_guarantee_contribution=None, + is_qualifying_earnings=None, number_of_units=None, annual_number_of_units=None, full_time_number_of_units_per_period=None, @@ -69,6 +72,7 @@ def __init__( self._entitlement_final_pay_payout_type = None self._employment_termination_payment_type = None self._include_superannuation_guarantee_contribution = None + self._is_qualifying_earnings = None self._number_of_units = None self._annual_number_of_units = None self._full_time_number_of_units_per_period = None @@ -88,6 +92,8 @@ def __init__( self.include_superannuation_guarantee_contribution = ( include_superannuation_guarantee_contribution ) + if is_qualifying_earnings is not None: + self.is_qualifying_earnings = is_qualifying_earnings if number_of_units is not None: self.number_of_units = number_of_units if annual_number_of_units is not None: @@ -210,6 +216,29 @@ def include_superannuation_guarantee_contribution( include_superannuation_guarantee_contribution ) + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this LeaveLine. # noqa: E501 + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings # noqa: E501 + + :return: The is_qualifying_earnings of this LeaveLine. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this LeaveLine. + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this LeaveLine. # noqa: E501 + :type: bool + """ + + self._is_qualifying_earnings = is_qualifying_earnings + @property def number_of_units(self): """Gets the number_of_units of this LeaveLine. # noqa: E501 diff --git a/xero_python/payrollau/models/leave_type.py b/xero_python/payrollau/models/leave_type.py index c1333ce4..9c38cc1b 100644 --- a/xero_python/payrollau/models/leave_type.py +++ b/xero_python/payrollau/models/leave_type.py @@ -41,6 +41,7 @@ class LeaveType(BaseModel): "current_record": "bool", "leave_category_code": "LeaveCategoryCode", "sgc_exempt": "bool", + "is_qualifying_earnings": "bool", } attribute_map = { @@ -55,6 +56,7 @@ class LeaveType(BaseModel): "current_record": "CurrentRecord", "leave_category_code": "LeaveCategoryCode", "sgc_exempt": "SGCExempt", + "is_qualifying_earnings": "IsQualifyingEarnings", } def __init__( @@ -70,6 +72,7 @@ def __init__( current_record=None, leave_category_code=None, sgc_exempt=None, + is_qualifying_earnings=None, ): # noqa: E501 """LeaveType - a model defined in OpenAPI""" # noqa: E501 @@ -84,6 +87,7 @@ def __init__( self._current_record = None self._leave_category_code = None self._sgc_exempt = None + self._is_qualifying_earnings = None self.discriminator = None if name is not None: @@ -108,6 +112,8 @@ def __init__( self.leave_category_code = leave_category_code if sgc_exempt is not None: self.sgc_exempt = sgc_exempt + if is_qualifying_earnings is not None: + self.is_qualifying_earnings = is_qualifying_earnings @property def name(self): @@ -364,3 +370,26 @@ def sgc_exempt(self, sgc_exempt): """ self._sgc_exempt = sgc_exempt + + @property + def is_qualifying_earnings(self): + """Gets the is_qualifying_earnings of this LeaveType. # noqa: E501 + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings # noqa: E501 + + :return: The is_qualifying_earnings of this LeaveType. # noqa: E501 + :rtype: bool + """ + return self._is_qualifying_earnings + + @is_qualifying_earnings.setter + def is_qualifying_earnings(self, is_qualifying_earnings): + """Sets the is_qualifying_earnings of this LeaveType. + + Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings # noqa: E501 + + :param is_qualifying_earnings: The is_qualifying_earnings of this LeaveType. # noqa: E501 + :type: bool + """ + + self._is_qualifying_earnings = is_qualifying_earnings diff --git a/xero_python/payrollau/models/opening_balance_leave_line.py b/xero_python/payrollau/models/opening_balance_leave_line.py new file mode 100644 index 00000000..781c85f4 --- /dev/null +++ b/xero_python/payrollau/models/opening_balance_leave_line.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" +Xero Payroll AU API + +This is the Xero Payroll API for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class OpeningBalanceLeaveLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"leave_type_id": "str", "number_of_units": "float"} + + attribute_map = {"leave_type_id": "LeaveTypeID", "number_of_units": "NumberOfUnits"} + + def __init__(self, leave_type_id=None, number_of_units=None): # noqa: E501 + """OpeningBalanceLeaveLine - a model defined in OpenAPI""" # noqa: E501 + + self._leave_type_id = None + self._number_of_units = None + self.discriminator = None + + if leave_type_id is not None: + self.leave_type_id = leave_type_id + if number_of_units is not None: + self.number_of_units = number_of_units + + @property + def leave_type_id(self): + """Gets the leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + + Xero leave type identifier # noqa: E501 + + :return: The leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + :rtype: str + """ + return self._leave_type_id + + @leave_type_id.setter + def leave_type_id(self, leave_type_id): + """Sets the leave_type_id of this OpeningBalanceLeaveLine. + + Xero leave type identifier # noqa: E501 + + :param leave_type_id: The leave_type_id of this OpeningBalanceLeaveLine. # noqa: E501 + :type: str + """ + + self._leave_type_id = leave_type_id + + @property + def number_of_units(self): + """Gets the number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + + Number of units for leave line. # noqa: E501 + + :return: The number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this OpeningBalanceLeaveLine. + + Number of units for leave line. # noqa: E501 + + :param number_of_units: The number_of_units of this OpeningBalanceLeaveLine. # noqa: E501 + :type: float + """ + + self._number_of_units = number_of_units diff --git a/xero_python/payrollau/models/opening_balances.py b/xero_python/payrollau/models/opening_balances.py index ec7478b9..eb455ec7 100644 --- a/xero_python/payrollau/models/opening_balances.py +++ b/xero_python/payrollau/models/opening_balances.py @@ -36,7 +36,7 @@ class OpeningBalances(BaseModel): "deduction_lines": "list[DeductionLine]", "super_lines": "list[SuperLine]", "reimbursement_lines": "list[ReimbursementLine]", - "leave_lines": "list[LeaveLine]", + "leave_lines": "list[OpeningBalanceLeaveLine]", "paid_leave_earnings_lines": "list[PaidLeaveEarningsLine]", } @@ -227,7 +227,7 @@ def leave_lines(self): :return: The leave_lines of this OpeningBalances. # noqa: E501 - :rtype: list[LeaveLine] + :rtype: list[OpeningBalanceLeaveLine] """ return self._leave_lines @@ -237,7 +237,7 @@ def leave_lines(self, leave_lines): :param leave_lines: The leave_lines of this OpeningBalances. # noqa: E501 - :type: list[LeaveLine] + :type: list[OpeningBalanceLeaveLine] """ self._leave_lines = leave_lines diff --git a/xero_python/payrollau/models/tax_declaration.py b/xero_python/payrollau/models/tax_declaration.py index 765b0bac..adad9565 100644 --- a/xero_python/payrollau/models/tax_declaration.py +++ b/xero_python/payrollau/models/tax_declaration.py @@ -51,6 +51,7 @@ class TaxDeclaration(BaseModel): "has_student_startup_loan": "bool", "has_loan_or_student_debt": "bool", "updated_date_utc": "datetime[ms-format]", + "include_leave_loading_in_qualifying_earnings": "bool", } attribute_map = { @@ -75,6 +76,7 @@ class TaxDeclaration(BaseModel): "has_student_startup_loan": "HasStudentStartupLoan", "has_loan_or_student_debt": "HasLoanOrStudentDebt", "updated_date_utc": "UpdatedDateUTC", + "include_leave_loading_in_qualifying_earnings": "IncludeLeaveLoadingInQualifyingEarnings", } def __init__( @@ -100,6 +102,7 @@ def __init__( has_student_startup_loan=None, has_loan_or_student_debt=None, updated_date_utc=None, + include_leave_loading_in_qualifying_earnings=None, ): # noqa: E501 """TaxDeclaration - a model defined in OpenAPI""" # noqa: E501 @@ -124,6 +127,7 @@ def __init__( self._has_student_startup_loan = None self._has_loan_or_student_debt = None self._updated_date_utc = None + self._include_leave_loading_in_qualifying_earnings = None self.discriminator = None if employee_id is not None: @@ -174,6 +178,10 @@ def __init__( self.has_loan_or_student_debt = has_loan_or_student_debt if updated_date_utc is not None: self.updated_date_utc = updated_date_utc + if include_leave_loading_in_qualifying_earnings is not None: + self.include_leave_loading_in_qualifying_earnings = ( + include_leave_loading_in_qualifying_earnings + ) @property def employee_id(self): @@ -657,3 +665,30 @@ def updated_date_utc(self, updated_date_utc): """ self._updated_date_utc = updated_date_utc + + @property + def include_leave_loading_in_qualifying_earnings(self): + """Gets the include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + + Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :return: The include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + :rtype: bool + """ + return self._include_leave_loading_in_qualifying_earnings + + @include_leave_loading_in_qualifying_earnings.setter + def include_leave_loading_in_qualifying_earnings( + self, include_leave_loading_in_qualifying_earnings + ): + """Sets the include_leave_loading_in_qualifying_earnings of this TaxDeclaration. + + Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations # noqa: E501 + + :param include_leave_loading_in_qualifying_earnings: The include_leave_loading_in_qualifying_earnings of this TaxDeclaration. # noqa: E501 + :type: bool + """ + + self._include_leave_loading_in_qualifying_earnings = ( + include_leave_loading_in_qualifying_earnings + ) diff --git a/xero_python/payrollauv2/__init__.py b/xero_python/payrollauv2/__init__.py new file mode 100644 index 00000000..22b36f7f --- /dev/null +++ b/xero_python/payrollauv2/__init__.py @@ -0,0 +1,27 @@ +# coding: utf-8 + +# flake8: noqa + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +# import apis into sdk package +from xero_python.payrollauv2.api.payroll_au_v2_api import PayrollAuV2Api + + +# import models into sdk package +from xero_python.payrollauv2.models.invalid_field import InvalidField +from xero_python.payrollauv2.models.pagination import Pagination +from xero_python.payrollauv2.models.problem import Problem +from xero_python.payrollauv2.models.timesheet import Timesheet +from xero_python.payrollauv2.models.timesheet_line import TimesheetLine +from xero_python.payrollauv2.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollauv2.models.timesheet_object import TimesheetObject +from xero_python.payrollauv2.models.timesheets import Timesheets diff --git a/xero_python/payrollauv2/api/__init__.py b/xero_python/payrollauv2/api/__init__.py new file mode 100644 index 00000000..f65c04e7 --- /dev/null +++ b/xero_python/payrollauv2/api/__init__.py @@ -0,0 +1,4 @@ +# flake8: noqa + +# import apis into api package +from xero_python.payrollauv2.api.payroll_au_v2_api import PayrollAuV2Api diff --git a/xero_python/payrollauv2/api/payroll_au_v2_api.py b/xero_python/payrollauv2/api/payroll_au_v2_api.py new file mode 100644 index 00000000..ff92e6bc --- /dev/null +++ b/xero_python/payrollauv2/api/payroll_au_v2_api.py @@ -0,0 +1,833 @@ +# coding: utf-8 + +import importlib +import re # noqa: F401 + +from xero_python import exceptions +from xero_python.api_client import ApiClient, ModelFinder + +try: + from .exception_handler import translate_status_exception +except ImportError: + translate_status_exception = exceptions.translate_status_exception + +""" + Xero Payroll AU API 2.0 + + This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + + Contact: api@xero.com + Generated by: https://openapi-generator.tech +""" + +""" + OpenAPI spec version: 11.1.0 +""" + + +class empty: + """empty object to mark optional parameter not set""" + + +class PayrollAuV2Api(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + base_url = "https://api.xero.com/payroll.xro/2.0" + models_module = importlib.import_module("xero_python.payrollauv2.models") + + def __init__(self, api_client=None, base_url=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.base_url = base_url or self.base_url + + def get_resource_url(self, resource_path): + """ + Combine API base url with resource specific path + :param str resource_path: API endpoint specific path + :return: str full resource path + """ + return self.base_url + resource_path + + def get_model_finder(self): + return ModelFinder(self.models_module) + + def approve_timesheet( + self, + xero_tenant_id, + timesheet_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Approves a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `approve_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `approve_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Approve") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "approve_timesheet") + + def create_timesheet( + self, + xero_tenant_id, + timesheet, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates a new timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param Timesheet timesheet: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet`" + ) + # verify the required parameter 'timesheet' is set + if timesheet is None: + raise ValueError( + "Missing the required parameter `timesheet` " + "when calling `create_timesheet`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet") + + def create_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Creates a new timesheet line for a specific timesheet using a unique timesheet ID # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `create_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `create_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "create_timesheet_line") + + def delete_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet") + + def delete_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Deletes a specific timesheet line # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLine + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `delete_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `delete_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "DELETE", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLine", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "delete_timesheet_line") + + def get_timesheet( + self, + xero_tenant_id, + timesheet_id, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieve a specific timesheet by using a unique timesheet ID # noqa: E501 + OAuth2 scope: payroll.timesheets, payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `get_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheet") + + def get_timesheets( + self, + xero_tenant_id, + page=empty, + filter=empty, + status=empty, + start_date=empty, + end_date=empty, + sort=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Retrieves timesheets # noqa: E501 + OAuth2 scope: payroll.timesheets, payroll.timesheets.read + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param int page: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. + :param str filter: Filter by employeeId and/or payrollCalendarId + :param str status: filter results by any timesheets with a matching timesheet status + :param str start_date: filter results by any timesheets with a startDate on or after the provided date + :param str end_date: filter results by any timesheets with a endDate on or before the provided date + :param str sort: sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: Timesheets + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `get_timesheets`" + ) + + collection_formats = {} + path_params = {} + + query_params = [] + + if page is not empty: + query_params.append(("page", page)) + + if filter is not empty: + query_params.append(("filter", filter)) + + if status is not empty: + query_params.append(("status", status)) + + if start_date is not empty: + query_params.append(("startDate", start_date)) + + if end_date is not empty: + query_params.append(("endDate", end_date)) + + if sort is not empty: + query_params.append(("sort", sort)) + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets") + + try: + return self.api_client.call_api( + url, + "GET", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="Timesheets", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "get_timesheets") + + def revert_timesheet( + self, + xero_tenant_id, + timesheet_id, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Reverts a specific timesheet to draft # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `revert_timesheet`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `revert_timesheet`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = None + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/RevertToDraft") + + try: + return self.api_client.call_api( + url, + "POST", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "revert_timesheet") + + def update_timesheet_line( + self, + xero_tenant_id, + timesheet_id, + timesheet_line_id, + timesheet_line, + idempotency_key=empty, + _return_http_data_only=True, + _preload_content=True, + _request_timeout=None, + ): + """Updates a specific timesheet line for a specific timesheet # noqa: E501 + OAuth2 scope: payroll.timesheets + :param str xero_tenant_id: Xero identifier for Tenant (required) + :param str timesheet_id: Identifier for the timesheet (required) + :param str timesheet_line_id: Identifier for the timesheet line (required) + :param TimesheetLine timesheet_line: (required) + :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + :param bool _return_http_data_only: return received data only + :param bool _preload_content: load received data in models + :param bool _request_timeout: maximum wait time for response + :return: TimesheetLineObject + """ + + # verify the required parameter 'xero_tenant_id' is set + if xero_tenant_id is None: + raise ValueError( + "Missing the required parameter `xero_tenant_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_id' is set + if timesheet_id is None: + raise ValueError( + "Missing the required parameter `timesheet_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line_id' is set + if timesheet_line_id is None: + raise ValueError( + "Missing the required parameter `timesheet_line_id` " + "when calling `update_timesheet_line`" + ) + # verify the required parameter 'timesheet_line' is set + if timesheet_line is None: + raise ValueError( + "Missing the required parameter `timesheet_line` " + "when calling `update_timesheet_line`" + ) + + collection_formats = {} + path_params = { + "TimesheetID": timesheet_id, + "TimesheetLineID": timesheet_line_id, + } + + query_params = [] + + header_params = { + "Xero-Tenant-Id": xero_tenant_id, + } + + if idempotency_key is not empty: + header_params["Idempotency-Key"] = idempotency_key + + local_var_files = {} + form_params = [] + + body_params = timesheet_line + # HTTP header `Accept` + header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # HTTP header `Content-Type` + header_params["Content-Type"] = self.api_client.select_header_content_type( + ["application/json"] + ) + + # Authentication setting + auth_settings = ["OAuth2"] + url = self.get_resource_url("/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}") + + try: + return self.api_client.call_api( + url, + "PUT", + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type="TimesheetLineObject", + response_model_finder=self.get_model_finder(), + auth_settings=auth_settings, + _return_http_data_only=_return_http_data_only, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + collection_formats=collection_formats, + ) + except exceptions.HTTPStatusException as error: + raise translate_status_exception(error, self, "update_timesheet_line") diff --git a/xero_python/payrollauv2/docs/InvalidField.md b/xero_python/payrollauv2/docs/InvalidField.md new file mode 100644 index 00000000..fbb1b5b2 --- /dev/null +++ b/xero_python/payrollauv2/docs/InvalidField.md @@ -0,0 +1,11 @@ +# InvalidField + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the field that caused the error | [optional] +**reason** | **str** | The reason the error occurred | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/Pagination.md b/xero_python/payrollauv2/docs/Pagination.md new file mode 100644 index 00000000..7d4aa488 --- /dev/null +++ b/xero_python/payrollauv2/docs/Pagination.md @@ -0,0 +1,13 @@ +# Pagination + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **int** | | [optional] +**page_size** | **int** | | [optional] +**page_count** | **int** | | [optional] +**item_count** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/PayrollAuV2Api.md b/xero_python/payrollauv2/docs/PayrollAuV2Api.md new file mode 100644 index 00000000..582d0794 --- /dev/null +++ b/xero_python/payrollauv2/docs/PayrollAuV2Api.md @@ -0,0 +1,612 @@ +# xero_python.payrollauv2.PayrollAuV2Api + +All URIs are relative to *https://api.xero.com/payroll.xro/2.0* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve_timesheet**](PayrollAuV2Api.md#approve_timesheet) | **POST** /Timesheets/{TimesheetID}/Approve | Approves a specific timesheet +[**create_timesheet**](PayrollAuV2Api.md#create_timesheet) | **POST** /Timesheets | Creates a new timesheet +[**create_timesheet_line**](PayrollAuV2Api.md#create_timesheet_line) | **POST** /Timesheets/{TimesheetID}/Lines | Creates a new timesheet line for a specific timesheet using a unique timesheet ID +[**delete_timesheet**](PayrollAuV2Api.md#delete_timesheet) | **DELETE** /Timesheets/{TimesheetID} | Deletes a specific timesheet +[**delete_timesheet_line**](PayrollAuV2Api.md#delete_timesheet_line) | **DELETE** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Deletes a specific timesheet line +[**get_timesheet**](PayrollAuV2Api.md#get_timesheet) | **GET** /Timesheets/{TimesheetID} | Retrieve a specific timesheet by using a unique timesheet ID +[**get_timesheets**](PayrollAuV2Api.md#get_timesheets) | **GET** /Timesheets | Retrieves timesheets +[**revert_timesheet**](PayrollAuV2Api.md#revert_timesheet) | **POST** /Timesheets/{TimesheetID}/RevertToDraft | Reverts a specific timesheet to draft +[**update_timesheet_line**](PayrollAuV2Api.md#update_timesheet_line) | **PUT** /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} | Updates a specific timesheet line for a specific timesheet + + +# **approve_timesheet** +> TimesheetObject approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + +Approves a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Approves a specific timesheet + api_response = api_instance.approve_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->approve_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **create_timesheet** +> TimesheetObject create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) + +Creates a new timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet = {"payrollCalendarID":"216d80e6-af55-47b1-b718-9457c3f5d2fe","employeeID":"aad6b292-7b94-408b-93f6-e489867e3fb0","startDate":"2020-04-13","endDate":"2020-04-19","timesheetLines":[{"date":"2020-04-13","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":8},{"date":"2020-04-15","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":6}]} # Timesheet | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates a new timesheet + api_response = api_instance.create_timesheet(xero_tenant_id, timesheet, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->create_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet** | [**Timesheet**](Timesheet.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[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) + +# **create_timesheet_line** +> TimesheetLineObject create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) + +Creates a new timesheet line for a specific timesheet using a unique timesheet ID + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":1} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Creates a new timesheet line for a specific timesheet using a unique timesheet ID + api_response = api_instance.create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->create_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[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) + +# **delete_timesheet** +> TimesheetLine delete_timesheet(xero_tenant_id, timesheet_id) + +Deletes a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # Deletes a specific timesheet + api_response = api_instance.delete_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->delete_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **delete_timesheet_line** +> TimesheetLine delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + +Deletes a specific timesheet line + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +try: + # Deletes a specific timesheet line + api_response = api_instance.delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->delete_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + +### Return type + +[**TimesheetLine**](TimesheetLine.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **get_timesheet** +> TimesheetObject get_timesheet(xero_tenant_id, timesheet_id) + +Retrieve a specific timesheet by using a unique timesheet ID + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +try: + # Retrieve a specific timesheet by using a unique timesheet ID + api_response = api_instance.get_timesheet(xero_tenant_id, timesheet_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->get_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **get_timesheets** +> Timesheets get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) + +Retrieves timesheets + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +page = 5 # int | Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. (optional) +filter = 'employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000' # str | Filter by employeeId and/or payrollCalendarId (optional) +status = 'Draft' # str | filter results by any timesheets with a matching timesheet status (optional) +start_date = '2019-01-02' # str | filter results by any timesheets with a startDate on or after the provided date (optional) +end_date = '2020-01-02' # str | filter results by any timesheets with a endDate on or before the provided date (optional) +sort = 'startDate' # str | sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. (optional) +try: + # Retrieves timesheets + api_response = api_instance.get_timesheets(xero_tenant_id, page=page, filter=filter, status=status, start_date=start_date, end_date=end_date, sort=sort) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->get_timesheets: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **page** | **int**| Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. | [optional] + **filter** | **str**| Filter by employeeId and/or payrollCalendarId | [optional] + **status** | **str**| filter results by any timesheets with a matching timesheet status | [optional] + **start_date** | **str**| filter results by any timesheets with a startDate on or after the provided date | [optional] + **end_date** | **str**| filter results by any timesheets with a endDate on or before the provided date | [optional] + **sort** | **str**| sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest. | [optional] + +### Return type + +[**Timesheets**](Timesheets.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **revert_timesheet** +> TimesheetObject revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + +Reverts a specific timesheet to draft + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Reverts a specific timesheet to draft + api_response = api_instance.revert_timesheet(xero_tenant_id, timesheet_id, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->revert_timesheet: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetObject**](TimesheetObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[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) + +# **update_timesheet_line** +> TimesheetLineObject update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) + +Updates a specific timesheet line for a specific timesheet + +### Example + +* OAuth Authentication (OAuth2): +```python +from xero_python.api_client import Configuration, ApiClient +from xero_python.api_client.oauth2 import OAuth2Token +from xero_python.exceptions import ApiException +from xero_python.payrollauv2 import PayrollAuV2Api +from pprint import pprint + +# Configure OAuth2 access token for authorization: OAuth2 +# simplified version, `xero_oauth2_token` represents permanent global token storage +xero_oauth2_token = {} # set to valid xero oauth2 token dictionary +# create client configuration with client id and client secret for automatic token refresh +api_config = Configuration(oauth2_token=OAuth2Token( + client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET" +)) +# configure xero-python sdk client +api_client = ApiClient( + api_config, + oauth2_token_saver=lambda x: xero_oauth2_token.update(x), + oauth2_token_getter=lambda : xero_oauth2_token +) +# create an instance of the API class +api_instance = PayrollAuV2Api(api_client) + +xero_tenant_id = 'xero_tenant_id_example' # str | Xero identifier for Tenant +timesheet_id = 'timesheet_id_example' # str | Identifier for the timesheet +timesheet_line_id = 'timesheet_line_id_example' # str | Identifier for the timesheet line +timesheet_line = {"date":"2020-04-14","earningsRateID":"87f5b43a-cf51-4b74-92de-94c819e82d27","numberOfUnits":2} # TimesheetLine | +idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional) +try: + # Updates a specific timesheet line for a specific timesheet + api_response = api_instance.update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, idempotency_key=idempotency_key) + pprint(api_response) +except ApiException as e: + print("Exception when calling PayrollAuV2Api->update_timesheet_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **str**| Xero identifier for Tenant | + **timesheet_id** | [**str**](.md)| Identifier for the timesheet | + **timesheet_line_id** | [**str**](.md)| Identifier for the timesheet line | + **timesheet_line** | [**TimesheetLine**](TimesheetLine.md)| | + **idempotency_key** | **str**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] + +### Return type + +[**TimesheetLineObject**](TimesheetLineObject.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[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) + diff --git a/xero_python/payrollauv2/docs/Problem.md b/xero_python/payrollauv2/docs/Problem.md new file mode 100644 index 00000000..edbdda5b --- /dev/null +++ b/xero_python/payrollauv2/docs/Problem.md @@ -0,0 +1,15 @@ +# Problem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of error format | [optional] +**title** | **str** | The type of the error | [optional] +**status** | **str** | The error status code | [optional] +**detail** | **str** | A description of the error | [optional] +**instance** | **str** | | [optional] +**invalid_fields** | [**list[InvalidField]**](InvalidField.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/Timesheet.md b/xero_python/payrollauv2/docs/Timesheet.md new file mode 100644 index 00000000..ee693b86 --- /dev/null +++ b/xero_python/payrollauv2/docs/Timesheet.md @@ -0,0 +1,18 @@ +# Timesheet + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_id** | **str** | The Xero identifier for a Timesheet | [optional] +**payroll_calendar_id** | **str** | The Xero identifier for the Payroll Calendar that the Timesheet applies to | +**employee_id** | **str** | The Xero identifier for the Employee that the Timesheet is for | +**start_date** | **date** | The Start Date of the Timesheet period (YYYY-MM-DD) | +**end_date** | **date** | The End Date of the Timesheet period (YYYY-MM-DD) | +**status** | **str** | Status of the timesheet | [optional] +**total_hours** | **float** | The Total Hours of the Timesheet | [optional] +**updated_date_utc** | **datetime** | The UTC date time that the Timesheet was last updated | [optional] +**timesheet_lines** | [**list[TimesheetLine]**](TimesheetLine.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/TimesheetLine.md b/xero_python/payrollauv2/docs/TimesheetLine.md new file mode 100644 index 00000000..c5124b94 --- /dev/null +++ b/xero_python/payrollauv2/docs/TimesheetLine.md @@ -0,0 +1,14 @@ +# TimesheetLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timesheet_line_id** | **str** | The Xero identifier for a Timesheet Line | [optional] +**date** | **date** | The Date that this Timesheet Line is for (YYYY-MM-DD) | +**earnings_rate_id** | **str** | The Xero identifier for the Earnings Rate that the Timesheet is for | +**tracking_item_id** | **str** | The Xero identifier for the Tracking Item that the Timesheet is for | [optional] +**number_of_units** | **float** | The Number of Units of the Timesheet Line | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/TimesheetLineObject.md b/xero_python/payrollauv2/docs/TimesheetLineObject.md new file mode 100644 index 00000000..a6d06d1e --- /dev/null +++ b/xero_python/payrollauv2/docs/TimesheetLineObject.md @@ -0,0 +1,12 @@ +# TimesheetLineObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet_line** | [**TimesheetLine**](TimesheetLine.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/TimesheetObject.md b/xero_python/payrollauv2/docs/TimesheetObject.md new file mode 100644 index 00000000..4ab9cc40 --- /dev/null +++ b/xero_python/payrollauv2/docs/TimesheetObject.md @@ -0,0 +1,12 @@ +# TimesheetObject + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheet** | [**Timesheet**](Timesheet.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/docs/Timesheets.md b/xero_python/payrollauv2/docs/Timesheets.md new file mode 100644 index 00000000..ae42a3b6 --- /dev/null +++ b/xero_python/payrollauv2/docs/Timesheets.md @@ -0,0 +1,12 @@ +# Timesheets + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] +**problem** | [**Problem**](Problem.md) | | [optional] +**timesheets** | [**list[Timesheet]**](Timesheet.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/xero_python/payrollauv2/models/__init__.py b/xero_python/payrollauv2/models/__init__.py new file mode 100644 index 00000000..3251186f --- /dev/null +++ b/xero_python/payrollauv2/models/__init__.py @@ -0,0 +1,22 @@ +# coding: utf-8 + +# flake8: noqa +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +# import models into model package +from xero_python.payrollauv2.models.invalid_field import InvalidField +from xero_python.payrollauv2.models.pagination import Pagination +from xero_python.payrollauv2.models.problem import Problem +from xero_python.payrollauv2.models.timesheet import Timesheet +from xero_python.payrollauv2.models.timesheet_line import TimesheetLine +from xero_python.payrollauv2.models.timesheet_line_object import TimesheetLineObject +from xero_python.payrollauv2.models.timesheet_object import TimesheetObject +from xero_python.payrollauv2.models.timesheets import Timesheets diff --git a/xero_python/payrollauv2/models/invalid_field.py b/xero_python/payrollauv2/models/invalid_field.py new file mode 100644 index 00000000..8de56365 --- /dev/null +++ b/xero_python/payrollauv2/models/invalid_field.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class InvalidField(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = {"name": "str", "reason": "str"} + + attribute_map = {"name": "name", "reason": "reason"} + + def __init__(self, name=None, reason=None): # noqa: E501 + """InvalidField - a model defined in OpenAPI""" # noqa: E501 + + self._name = None + self._reason = None + self.discriminator = None + + if name is not None: + self.name = name + if reason is not None: + self.reason = reason + + @property + def name(self): + """Gets the name of this InvalidField. # noqa: E501 + + The name of the field that caused the error # noqa: E501 + + :return: The name of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this InvalidField. + + The name of the field that caused the error # noqa: E501 + + :param name: The name of this InvalidField. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def reason(self): + """Gets the reason of this InvalidField. # noqa: E501 + + The reason the error occurred # noqa: E501 + + :return: The reason of this InvalidField. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this InvalidField. + + The reason the error occurred # noqa: E501 + + :param reason: The reason of this InvalidField. # noqa: E501 + :type: str + """ + + self._reason = reason diff --git a/xero_python/payrollauv2/models/pagination.py b/xero_python/payrollauv2/models/pagination.py new file mode 100644 index 00000000..483e873c --- /dev/null +++ b/xero_python/payrollauv2/models/pagination.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Pagination(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "page": "int", + "page_size": "int", + "page_count": "int", + "item_count": "int", + } + + attribute_map = { + "page": "page", + "page_size": "pageSize", + "page_count": "pageCount", + "item_count": "itemCount", + } + + def __init__( + self, page=None, page_size=None, page_count=None, item_count=None + ): # noqa: E501 + """Pagination - a model defined in OpenAPI""" # noqa: E501 + + self._page = None + self._page_size = None + self._page_count = None + self._item_count = None + self.discriminator = None + + if page is not None: + self.page = page + if page_size is not None: + self.page_size = page_size + if page_count is not None: + self.page_count = page_count + if item_count is not None: + self.item_count = item_count + + @property + def page(self): + """Gets the page of this Pagination. # noqa: E501 + + + :return: The page of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page + + @page.setter + def page(self, page): + """Sets the page of this Pagination. + + + :param page: The page of this Pagination. # noqa: E501 + :type: int + """ + + self._page = page + + @property + def page_size(self): + """Gets the page_size of this Pagination. # noqa: E501 + + + :return: The page_size of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_size + + @page_size.setter + def page_size(self, page_size): + """Sets the page_size of this Pagination. + + + :param page_size: The page_size of this Pagination. # noqa: E501 + :type: int + """ + + self._page_size = page_size + + @property + def page_count(self): + """Gets the page_count of this Pagination. # noqa: E501 + + + :return: The page_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._page_count + + @page_count.setter + def page_count(self, page_count): + """Sets the page_count of this Pagination. + + + :param page_count: The page_count of this Pagination. # noqa: E501 + :type: int + """ + + self._page_count = page_count + + @property + def item_count(self): + """Gets the item_count of this Pagination. # noqa: E501 + + + :return: The item_count of this Pagination. # noqa: E501 + :rtype: int + """ + return self._item_count + + @item_count.setter + def item_count(self, item_count): + """Sets the item_count of this Pagination. + + + :param item_count: The item_count of this Pagination. # noqa: E501 + :type: int + """ + + self._item_count = item_count diff --git a/xero_python/payrollauv2/models/problem.py b/xero_python/payrollauv2/models/problem.py new file mode 100644 index 00000000..d9f0e2a4 --- /dev/null +++ b/xero_python/payrollauv2/models/problem.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Problem(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "type": "str", + "title": "str", + "status": "str", + "detail": "str", + "instance": "str", + "invalid_fields": "list[InvalidField]", + } + + attribute_map = { + "type": "type", + "title": "title", + "status": "status", + "detail": "detail", + "instance": "instance", + "invalid_fields": "invalidFields", + } + + def __init__( + self, + type=None, + title=None, + status=None, + detail=None, + instance=None, + invalid_fields=None, + ): # noqa: E501 + """Problem - a model defined in OpenAPI""" # noqa: E501 + + self._type = None + self._title = None + self._status = None + self._detail = None + self._instance = None + self._invalid_fields = None + self.discriminator = None + + if type is not None: + self.type = type + if title is not None: + self.title = title + if status is not None: + self.status = status + if detail is not None: + self.detail = detail + if instance is not None: + self.instance = instance + if invalid_fields is not None: + self.invalid_fields = invalid_fields + + @property + def type(self): + """Gets the type of this Problem. # noqa: E501 + + The type of error format # noqa: E501 + + :return: The type of this Problem. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Problem. + + The type of error format # noqa: E501 + + :param type: The type of this Problem. # noqa: E501 + :type: str + """ + + self._type = type + + @property + def title(self): + """Gets the title of this Problem. # noqa: E501 + + The type of the error # noqa: E501 + + :return: The title of this Problem. # noqa: E501 + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """Sets the title of this Problem. + + The type of the error # noqa: E501 + + :param title: The title of this Problem. # noqa: E501 + :type: str + """ + + self._title = title + + @property + def status(self): + """Gets the status of this Problem. # noqa: E501 + + The error status code # noqa: E501 + + :return: The status of this Problem. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Problem. + + The error status code # noqa: E501 + + :param status: The status of this Problem. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def detail(self): + """Gets the detail of this Problem. # noqa: E501 + + A description of the error # noqa: E501 + + :return: The detail of this Problem. # noqa: E501 + :rtype: str + """ + return self._detail + + @detail.setter + def detail(self, detail): + """Sets the detail of this Problem. + + A description of the error # noqa: E501 + + :param detail: The detail of this Problem. # noqa: E501 + :type: str + """ + + self._detail = detail + + @property + def instance(self): + """Gets the instance of this Problem. # noqa: E501 + + + :return: The instance of this Problem. # noqa: E501 + :rtype: str + """ + return self._instance + + @instance.setter + def instance(self, instance): + """Sets the instance of this Problem. + + + :param instance: The instance of this Problem. # noqa: E501 + :type: str + """ + + self._instance = instance + + @property + def invalid_fields(self): + """Gets the invalid_fields of this Problem. # noqa: E501 + + + :return: The invalid_fields of this Problem. # noqa: E501 + :rtype: list[InvalidField] + """ + return self._invalid_fields + + @invalid_fields.setter + def invalid_fields(self, invalid_fields): + """Sets the invalid_fields of this Problem. + + + :param invalid_fields: The invalid_fields of this Problem. # noqa: E501 + :type: list[InvalidField] + """ + + self._invalid_fields = invalid_fields diff --git a/xero_python/payrollauv2/models/timesheet.py b/xero_python/payrollauv2/models/timesheet.py new file mode 100644 index 00000000..6d33c001 --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheet(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_id": "str", + "payroll_calendar_id": "str", + "employee_id": "str", + "start_date": "date", + "end_date": "date", + "status": "str", + "total_hours": "float", + "updated_date_utc": "datetime", + "timesheet_lines": "list[TimesheetLine]", + } + + attribute_map = { + "timesheet_id": "timesheetID", + "payroll_calendar_id": "payrollCalendarID", + "employee_id": "employeeID", + "start_date": "startDate", + "end_date": "endDate", + "status": "status", + "total_hours": "totalHours", + "updated_date_utc": "updatedDateUTC", + "timesheet_lines": "timesheetLines", + } + + def __init__( + self, + timesheet_id=None, + payroll_calendar_id=None, + employee_id=None, + start_date=None, + end_date=None, + status=None, + total_hours=None, + updated_date_utc=None, + timesheet_lines=None, + ): # noqa: E501 + """Timesheet - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_id = None + self._payroll_calendar_id = None + self._employee_id = None + self._start_date = None + self._end_date = None + self._status = None + self._total_hours = None + self._updated_date_utc = None + self._timesheet_lines = None + self.discriminator = None + + if timesheet_id is not None: + self.timesheet_id = timesheet_id + self.payroll_calendar_id = payroll_calendar_id + self.employee_id = employee_id + self.start_date = start_date + self.end_date = end_date + if status is not None: + self.status = status + if total_hours is not None: + self.total_hours = total_hours + if updated_date_utc is not None: + self.updated_date_utc = updated_date_utc + if timesheet_lines is not None: + self.timesheet_lines = timesheet_lines + + @property + def timesheet_id(self): + """Gets the timesheet_id of this Timesheet. # noqa: E501 + + The Xero identifier for a Timesheet # noqa: E501 + + :return: The timesheet_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._timesheet_id + + @timesheet_id.setter + def timesheet_id(self, timesheet_id): + """Sets the timesheet_id of this Timesheet. + + The Xero identifier for a Timesheet # noqa: E501 + + :param timesheet_id: The timesheet_id of this Timesheet. # noqa: E501 + :type: str + """ + + self._timesheet_id = timesheet_id + + @property + def payroll_calendar_id(self): + """Gets the payroll_calendar_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 + + :return: The payroll_calendar_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._payroll_calendar_id + + @payroll_calendar_id.setter + def payroll_calendar_id(self, payroll_calendar_id): + """Sets the payroll_calendar_id of this Timesheet. + + The Xero identifier for the Payroll Calendar that the Timesheet applies to # noqa: E501 + + :param payroll_calendar_id: The payroll_calendar_id of this Timesheet. # noqa: E501 + :type: str + """ + if payroll_calendar_id is None: + raise ValueError( + "Invalid value for `payroll_calendar_id`, must not be `None`" + ) # noqa: E501 + + self._payroll_calendar_id = payroll_calendar_id + + @property + def employee_id(self): + """Gets the employee_id of this Timesheet. # noqa: E501 + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :return: The employee_id of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._employee_id + + @employee_id.setter + def employee_id(self, employee_id): + """Sets the employee_id of this Timesheet. + + The Xero identifier for the Employee that the Timesheet is for # noqa: E501 + + :param employee_id: The employee_id of this Timesheet. # noqa: E501 + :type: str + """ + if employee_id is None: + raise ValueError( + "Invalid value for `employee_id`, must not be `None`" + ) # noqa: E501 + + self._employee_id = employee_id + + @property + def start_date(self): + """Gets the start_date of this Timesheet. # noqa: E501 + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The start_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this Timesheet. + + The Start Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param start_date: The start_date of this Timesheet. # noqa: E501 + :type: date + """ + if start_date is None: + raise ValueError( + "Invalid value for `start_date`, must not be `None`" + ) # noqa: E501 + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this Timesheet. # noqa: E501 + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :return: The end_date of this Timesheet. # noqa: E501 + :rtype: date + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this Timesheet. + + The End Date of the Timesheet period (YYYY-MM-DD) # noqa: E501 + + :param end_date: The end_date of this Timesheet. # noqa: E501 + :type: date + """ + if end_date is None: + raise ValueError( + "Invalid value for `end_date`, must not be `None`" + ) # noqa: E501 + + self._end_date = end_date + + @property + def status(self): + """Gets the status of this Timesheet. # noqa: E501 + + Status of the timesheet # noqa: E501 + + :return: The status of this Timesheet. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this Timesheet. + + Status of the timesheet # noqa: E501 + + :param status: The status of this Timesheet. # noqa: E501 + :type: str + """ + allowed_values = ["Draft", "Approved", "Completed", "None"] # noqa: E501 + + if status: + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}".format( # noqa: E501 + status, allowed_values + ) + ) + + self._status = status + + @property + def total_hours(self): + """Gets the total_hours of this Timesheet. # noqa: E501 + + The Total Hours of the Timesheet # noqa: E501 + + :return: The total_hours of this Timesheet. # noqa: E501 + :rtype: float + """ + return self._total_hours + + @total_hours.setter + def total_hours(self, total_hours): + """Sets the total_hours of this Timesheet. + + The Total Hours of the Timesheet # noqa: E501 + + :param total_hours: The total_hours of this Timesheet. # noqa: E501 + :type: float + """ + + self._total_hours = total_hours + + @property + def updated_date_utc(self): + """Gets the updated_date_utc of this Timesheet. # noqa: E501 + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :return: The updated_date_utc of this Timesheet. # noqa: E501 + :rtype: datetime + """ + return self._updated_date_utc + + @updated_date_utc.setter + def updated_date_utc(self, updated_date_utc): + """Sets the updated_date_utc of this Timesheet. + + The UTC date time that the Timesheet was last updated # noqa: E501 + + :param updated_date_utc: The updated_date_utc of this Timesheet. # noqa: E501 + :type: datetime + """ + + self._updated_date_utc = updated_date_utc + + @property + def timesheet_lines(self): + """Gets the timesheet_lines of this Timesheet. # noqa: E501 + + + :return: The timesheet_lines of this Timesheet. # noqa: E501 + :rtype: list[TimesheetLine] + """ + return self._timesheet_lines + + @timesheet_lines.setter + def timesheet_lines(self, timesheet_lines): + """Sets the timesheet_lines of this Timesheet. + + + :param timesheet_lines: The timesheet_lines of this Timesheet. # noqa: E501 + :type: list[TimesheetLine] + """ + + self._timesheet_lines = timesheet_lines diff --git a/xero_python/payrollauv2/models/timesheet_line.py b/xero_python/payrollauv2/models/timesheet_line.py new file mode 100644 index 00000000..eb2406ed --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_line.py @@ -0,0 +1,198 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLine(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "timesheet_line_id": "str", + "date": "date", + "earnings_rate_id": "str", + "tracking_item_id": "str", + "number_of_units": "float", + } + + attribute_map = { + "timesheet_line_id": "timesheetLineID", + "date": "date", + "earnings_rate_id": "earningsRateID", + "tracking_item_id": "trackingItemID", + "number_of_units": "numberOfUnits", + } + + def __init__( + self, + timesheet_line_id=None, + date=None, + earnings_rate_id=None, + tracking_item_id=None, + number_of_units=None, + ): # noqa: E501 + """TimesheetLine - a model defined in OpenAPI""" # noqa: E501 + + self._timesheet_line_id = None + self._date = None + self._earnings_rate_id = None + self._tracking_item_id = None + self._number_of_units = None + self.discriminator = None + + if timesheet_line_id is not None: + self.timesheet_line_id = timesheet_line_id + self.date = date + self.earnings_rate_id = earnings_rate_id + if tracking_item_id is not None: + self.tracking_item_id = tracking_item_id + self.number_of_units = number_of_units + + @property + def timesheet_line_id(self): + """Gets the timesheet_line_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for a Timesheet Line # noqa: E501 + + :return: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._timesheet_line_id + + @timesheet_line_id.setter + def timesheet_line_id(self, timesheet_line_id): + """Sets the timesheet_line_id of this TimesheetLine. + + The Xero identifier for a Timesheet Line # noqa: E501 + + :param timesheet_line_id: The timesheet_line_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._timesheet_line_id = timesheet_line_id + + @property + def date(self): + """Gets the date of this TimesheetLine. # noqa: E501 + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :return: The date of this TimesheetLine. # noqa: E501 + :rtype: date + """ + return self._date + + @date.setter + def date(self, date): + """Sets the date of this TimesheetLine. + + The Date that this Timesheet Line is for (YYYY-MM-DD) # noqa: E501 + + :param date: The date of this TimesheetLine. # noqa: E501 + :type: date + """ + if date is None: + raise ValueError( + "Invalid value for `date`, must not be `None`" + ) # noqa: E501 + + self._date = date + + @property + def earnings_rate_id(self): + """Gets the earnings_rate_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :return: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._earnings_rate_id + + @earnings_rate_id.setter + def earnings_rate_id(self, earnings_rate_id): + """Sets the earnings_rate_id of this TimesheetLine. + + The Xero identifier for the Earnings Rate that the Timesheet is for # noqa: E501 + + :param earnings_rate_id: The earnings_rate_id of this TimesheetLine. # noqa: E501 + :type: str + """ + if earnings_rate_id is None: + raise ValueError( + "Invalid value for `earnings_rate_id`, must not be `None`" + ) # noqa: E501 + + self._earnings_rate_id = earnings_rate_id + + @property + def tracking_item_id(self): + """Gets the tracking_item_id of this TimesheetLine. # noqa: E501 + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :return: The tracking_item_id of this TimesheetLine. # noqa: E501 + :rtype: str + """ + return self._tracking_item_id + + @tracking_item_id.setter + def tracking_item_id(self, tracking_item_id): + """Sets the tracking_item_id of this TimesheetLine. + + The Xero identifier for the Tracking Item that the Timesheet is for # noqa: E501 + + :param tracking_item_id: The tracking_item_id of this TimesheetLine. # noqa: E501 + :type: str + """ + + self._tracking_item_id = tracking_item_id + + @property + def number_of_units(self): + """Gets the number_of_units of this TimesheetLine. # noqa: E501 + + The Number of Units of the Timesheet Line # noqa: E501 + + :return: The number_of_units of this TimesheetLine. # noqa: E501 + :rtype: float + """ + return self._number_of_units + + @number_of_units.setter + def number_of_units(self, number_of_units): + """Sets the number_of_units of this TimesheetLine. + + The Number of Units of the Timesheet Line # noqa: E501 + + :param number_of_units: The number_of_units of this TimesheetLine. # noqa: E501 + :type: float + """ + if number_of_units is None: + raise ValueError( + "Invalid value for `number_of_units`, must not be `None`" + ) # noqa: E501 + + self._number_of_units = number_of_units diff --git a/xero_python/payrollauv2/models/timesheet_line_object.py b/xero_python/payrollauv2/models/timesheet_line_object.py new file mode 100644 index 00000000..d4e77f1a --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_line_object.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetLineObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet_line": "TimesheetLine", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet_line": "timesheetLine", + } + + def __init__( + self, pagination=None, problem=None, timesheet_line=None + ): # noqa: E501 + """TimesheetLineObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet_line = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet_line is not None: + self.timesheet_line = timesheet_line + + @property + def pagination(self): + """Gets the pagination of this TimesheetLineObject. # noqa: E501 + + + :return: The pagination of this TimesheetLineObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetLineObject. + + + :param pagination: The pagination of this TimesheetLineObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetLineObject. # noqa: E501 + + + :return: The problem of this TimesheetLineObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetLineObject. + + + :param problem: The problem of this TimesheetLineObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet_line(self): + """Gets the timesheet_line of this TimesheetLineObject. # noqa: E501 + + + :return: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :rtype: TimesheetLine + """ + return self._timesheet_line + + @timesheet_line.setter + def timesheet_line(self, timesheet_line): + """Sets the timesheet_line of this TimesheetLineObject. + + + :param timesheet_line: The timesheet_line of this TimesheetLineObject. # noqa: E501 + :type: TimesheetLine + """ + + self._timesheet_line = timesheet_line diff --git a/xero_python/payrollauv2/models/timesheet_object.py b/xero_python/payrollauv2/models/timesheet_object.py new file mode 100644 index 00000000..6c6cd97c --- /dev/null +++ b/xero_python/payrollauv2/models/timesheet_object.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class TimesheetObject(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheet": "Timesheet", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheet": "timesheet", + } + + def __init__(self, pagination=None, problem=None, timesheet=None): # noqa: E501 + """TimesheetObject - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheet = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheet is not None: + self.timesheet = timesheet + + @property + def pagination(self): + """Gets the pagination of this TimesheetObject. # noqa: E501 + + + :return: The pagination of this TimesheetObject. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this TimesheetObject. + + + :param pagination: The pagination of this TimesheetObject. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this TimesheetObject. # noqa: E501 + + + :return: The problem of this TimesheetObject. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this TimesheetObject. + + + :param problem: The problem of this TimesheetObject. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheet(self): + """Gets the timesheet of this TimesheetObject. # noqa: E501 + + + :return: The timesheet of this TimesheetObject. # noqa: E501 + :rtype: Timesheet + """ + return self._timesheet + + @timesheet.setter + def timesheet(self, timesheet): + """Sets the timesheet of this TimesheetObject. + + + :param timesheet: The timesheet of this TimesheetObject. # noqa: E501 + :type: Timesheet + """ + + self._timesheet = timesheet diff --git a/xero_python/payrollauv2/models/timesheets.py b/xero_python/payrollauv2/models/timesheets.py new file mode 100644 index 00000000..51481a6e --- /dev/null +++ b/xero_python/payrollauv2/models/timesheets.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" +Xero Payroll AU API 2.0 + +This is the Xero Payroll API 2.0 for orgs in Australia region. # noqa: E501 + +Contact: api@xero.com +Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 + +from xero_python.models import BaseModel + + +class Timesheets(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + "pagination": "Pagination", + "problem": "Problem", + "timesheets": "list[Timesheet]", + } + + attribute_map = { + "pagination": "pagination", + "problem": "problem", + "timesheets": "timesheets", + } + + def __init__(self, pagination=None, problem=None, timesheets=None): # noqa: E501 + """Timesheets - a model defined in OpenAPI""" # noqa: E501 + + self._pagination = None + self._problem = None + self._timesheets = None + self.discriminator = None + + if pagination is not None: + self.pagination = pagination + if problem is not None: + self.problem = problem + if timesheets is not None: + self.timesheets = timesheets + + @property + def pagination(self): + """Gets the pagination of this Timesheets. # noqa: E501 + + + :return: The pagination of this Timesheets. # noqa: E501 + :rtype: Pagination + """ + return self._pagination + + @pagination.setter + def pagination(self, pagination): + """Sets the pagination of this Timesheets. + + + :param pagination: The pagination of this Timesheets. # noqa: E501 + :type: Pagination + """ + + self._pagination = pagination + + @property + def problem(self): + """Gets the problem of this Timesheets. # noqa: E501 + + + :return: The problem of this Timesheets. # noqa: E501 + :rtype: Problem + """ + return self._problem + + @problem.setter + def problem(self, problem): + """Sets the problem of this Timesheets. + + + :param problem: The problem of this Timesheets. # noqa: E501 + :type: Problem + """ + + self._problem = problem + + @property + def timesheets(self): + """Gets the timesheets of this Timesheets. # noqa: E501 + + + :return: The timesheets of this Timesheets. # noqa: E501 + :rtype: list[Timesheet] + """ + return self._timesheets + + @timesheets.setter + def timesheets(self, timesheets): + """Sets the timesheets of this Timesheets. + + + :param timesheets: The timesheets of this Timesheets. # noqa: E501 + :type: list[Timesheet] + """ + + self._timesheets = timesheets diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 372571b3..b1eadb16 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index d7b7c3d4..41145797 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 97d1d784..0c3eba2d 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 10.1.0 + OpenAPI spec version: 11.1.0 """ From c72f8a935908415b921a41de5f09c0089b578811 Mon Sep 17 00:00:00 2001 From: Chris Mitchell Date: Thu, 5 Mar 2026 16:38:02 +1300 Subject: [PATCH 69/79] chore: bump versions --- setup.py | 2 +- xero_python/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 59a56b5a..039b349b 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="9.4.0", + version="10.0.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 3944cae5..27b29d05 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "9.4.0" +__version__ = "10.0.0" From 7aa759d31621186de1c9fcbd600d6f15b6f2de73 Mon Sep 17 00:00:00 2001 From: Github Actions Date: Thu, 2 Apr 2026 00:33:58 +0000 Subject: [PATCH 70/79] Releasing 11.0.0 (OAS: 12.0.0) --- docs/v1/accounting/index.html | 30 +++++++++++++++++-- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au-v2/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 6 ++-- docs/v1/projects/index.html | 2 +- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/api/accounting_api.py | 11 +++++-- xero_python/accounting/docs/AccountingApi.md | 6 ++-- xero_python/accounting/docs/Prepayment.md | 1 + xero_python/accounting/models/prepayment.py | 29 ++++++++++++++++++ xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +-- xero_python/file/api/files_api.py | 2 +- xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- .../payrollauv2/api/payroll_au_v2_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/payrolluk/models/earnings_rate.py | 1 + .../employee_statutory_leave_summary.py | 1 + xero_python/project/api/project_api.py | 2 +- 29 files changed, 98 insertions(+), 31 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index c6415660..d11bf35b 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -4758,6 +4758,11 @@ "description" : "Returns Invoice number field. Reference field isn't available.", "readOnly" : true }, + "InvoiceNumber" : { + "type" : "string", + "description" : "Returns Invoice number for prepayment receive document only.", + "readOnly" : true + }, "UpdatedDateUTC" : { "type" : "string", "description" : "UTC timestamp of last update to the prepayment", @@ -6350,7 +6355,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

createAccount @@ -33203,9 +33208,10 @@

Usage and SDK Samples

if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") where = 'Status=="AUTHORISED"' order = 'Reference ASC' + invoice_numbers = ["INV-001", "INV-002"] try: - api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize) + api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, invoice_numbers) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getPrepayments: %s\n" % e) @@ -33383,6 +33389,26 @@

Parameters

+ + + InvoiceNumbers + + + +

+ + array[String] + + +

+Filter by a comma-separated list of InvoiceNumbers +

+ diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index f38c5843..b9432867 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1242,7 +1242,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index dcea4beb..5c5d5e97 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1420,7 +1420,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index 284eab7f..2f79148c 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1171,7 +1171,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index 761b2c20..a5cd96ab 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2376,7 +2376,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

getBankStatementAccounting diff --git a/docs/v1/payroll-au-v2/index.html b/docs/v1/payroll-au-v2/index.html index 90d87a10..a1045479 100644 --- a/docs/v1/payroll-au-v2/index.html +++ b/docs/v1/payroll-au-v2/index.html @@ -1160,7 +1160,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index de393ff9..0daeec37 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3447,7 +3447,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index 39efa086..9a7f579d 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -4068,7 +4068,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 7cc3f569..861bf4c8 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -1460,7 +1460,7 @@ "earningsType" : { "type" : "string", "description" : "Indicates how an employee will be paid when taking this type of earning", - "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable" ] + "enum" : [ "Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable", "StatutoryBereavementPayNorthernIreland" ] }, "rateType" : { "type" : "string", @@ -2088,7 +2088,7 @@ "type" : { "type" : "string", "description" : "The category of statutory leave", - "enum" : [ "Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare" ] + "enum" : [ "Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare", "BereavementNire" ] }, "startDate" : { "type" : "string", @@ -3701,7 +3701,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index a7bcb8ff..992b3ae9 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1463,7 +1463,7 @@

SDK:
VSN: 10.0.0
VSN: 11.0.0
Methods

createProject diff --git a/setup.py b/setup.py index 039b349b..6d635c83 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="10.0.0", + version="11.0.0", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 27b29d05..912f98c3 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "10.0.0" +__version__ = "11.0.0" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index 24cec18a..d6cd0d6d 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ @@ -13418,6 +13418,7 @@ def get_prepayments( page=empty, unitdp=empty, page_size=empty, + invoice_numbers=empty, _return_http_data_only=True, _preload_content=True, _request_timeout=None, @@ -13431,6 +13432,7 @@ def get_prepayments( :param int page: e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts :param int page_size: Number of records to retrieve per page + :param list[str] invoice_numbers: Filter by a comma-separated list of InvoiceNumbers :param bool _return_http_data_only: return received data only :param bool _preload_content: load received data in models :param bool _request_timeout: maximum wait time for response @@ -13444,7 +13446,9 @@ def get_prepayments( "when calling `get_prepayments`" ) - collection_formats = {} + collection_formats = { + "InvoiceNumbers": "csv", + } path_params = {} query_params = [] @@ -13464,6 +13468,9 @@ def get_prepayments( if page_size is not empty: query_params.append(("pageSize", page_size)) + if invoice_numbers is not empty: + query_params.append(("InvoiceNumbers", invoice_numbers)) + header_params = { "xero-tenant-id": xero_tenant_id, } diff --git a/xero_python/accounting/docs/AccountingApi.md b/xero_python/accounting/docs/AccountingApi.md index 79630049..076355ef 100644 --- a/xero_python/accounting/docs/AccountingApi.md +++ b/xero_python/accounting/docs/AccountingApi.md @@ -10346,7 +10346,7 @@ Name | Type | Description | Notes [[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) # **get_prepayments** -> Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) +> Prepayments get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, invoice_numbers=invoice_numbers) Retrieves prepayments @@ -10383,9 +10383,10 @@ order = 'Reference ASC' # str | Order by an any element (optional) page = 1 # int | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment (optional) unitdp = 4 # int | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts (optional) page_size = 100 # int | Number of records to retrieve per page (optional) +invoice_numbers = ['"INV-001", "INV-002"'] # list[str] | Filter by a comma-separated list of InvoiceNumbers (optional) try: # Retrieves prepayments - api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size) + api_response = api_instance.get_prepayments(xero_tenant_id, if_modified_since=if_modified_since, where=where, order=order, page=page, unitdp=unitdp, page_size=page_size, invoice_numbers=invoice_numbers) pprint(api_response) except ApiException as e: print("Exception when calling AccountingApi->get_prepayments: %s\n" % e) @@ -10402,6 +10403,7 @@ Name | Type | Description | Notes **page** | **int**| e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment | [optional] **unitdp** | **int**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] **page_size** | **int**| Number of records to retrieve per page | [optional] + **invoice_numbers** | [**list[str]**](str.md)| Filter by a comma-separated list of InvoiceNumbers | [optional] ### Return type diff --git a/xero_python/accounting/docs/Prepayment.md b/xero_python/accounting/docs/Prepayment.md index 2168254a..850e85c9 100644 --- a/xero_python/accounting/docs/Prepayment.md +++ b/xero_python/accounting/docs/Prepayment.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **total_tax** | **float** | The total tax on the prepayment | [optional] **total** | **float** | The total of the prepayment(subtotal + total tax) | [optional] **reference** | **str** | Returns Invoice number field. Reference field isn't available. | [optional] +**invoice_number** | **str** | Returns Invoice number for prepayment receive document only. | [optional] **updated_date_utc** | **datetime** | UTC timestamp of last update to the prepayment | [optional] **currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional] **prepayment_id** | **str** | Xero generated unique identifier | [optional] diff --git a/xero_python/accounting/models/prepayment.py b/xero_python/accounting/models/prepayment.py index ea374d50..b9fb3094 100644 --- a/xero_python/accounting/models/prepayment.py +++ b/xero_python/accounting/models/prepayment.py @@ -40,6 +40,7 @@ class Prepayment(BaseModel): "total_tax": "float", "total": "float", "reference": "str", + "invoice_number": "str", "updated_date_utc": "datetime[ms-format]", "currency_code": "CurrencyCode", "prepayment_id": "str", @@ -63,6 +64,7 @@ class Prepayment(BaseModel): "total_tax": "TotalTax", "total": "Total", "reference": "Reference", + "invoice_number": "InvoiceNumber", "updated_date_utc": "UpdatedDateUTC", "currency_code": "CurrencyCode", "prepayment_id": "PrepaymentID", @@ -87,6 +89,7 @@ def __init__( total_tax=None, total=None, reference=None, + invoice_number=None, updated_date_utc=None, currency_code=None, prepayment_id=None, @@ -110,6 +113,7 @@ def __init__( self._total_tax = None self._total = None self._reference = None + self._invoice_number = None self._updated_date_utc = None self._currency_code = None self._prepayment_id = None @@ -142,6 +146,8 @@ def __init__( self.total = total if reference is not None: self.reference = reference + if invoice_number is not None: + self.invoice_number = invoice_number if updated_date_utc is not None: self.updated_date_utc = updated_date_utc if currency_code is not None: @@ -413,6 +419,29 @@ def reference(self, reference): self._reference = reference + @property + def invoice_number(self): + """Gets the invoice_number of this Prepayment. # noqa: E501 + + Returns Invoice number for prepayment receive document only. # noqa: E501 + + :return: The invoice_number of this Prepayment. # noqa: E501 + :rtype: str + """ + return self._invoice_number + + @invoice_number.setter + def invoice_number(self, invoice_number): + """Sets the invoice_number of this Prepayment. + + Returns Invoice number for prepayment receive document only. # noqa: E501 + + :param invoice_number: The invoice_number of this Prepayment. # noqa: E501 + :type: str + """ + + self._invoice_number = invoice_number + @property def updated_date_utc(self): """Gets the updated_date_utc of this Prepayment. # noqa: E501 diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index f4e27251..c339f8b5 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index 12f86873..d21e7763 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 3a2bc986..2574fc8f 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 11.1.0 -- Package version: 10.0.0 +- API version: 12.0.0 +- Package version: 11.0.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index 8e30b51b..a9e0c15e 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index 7a2f37fb..d509e977 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index 90458d9a..ab5425b9 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index 23c6d5f0..d074552a 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/payrollauv2/api/payroll_au_v2_api.py b/xero_python/payrollauv2/api/payroll_au_v2_api.py index ff92e6bc..1ee336af 100644 --- a/xero_python/payrollauv2/api/payroll_au_v2_api.py +++ b/xero_python/payrollauv2/api/payroll_au_v2_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index b1eadb16..33797d16 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index 41145797..ab60798f 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ diff --git a/xero_python/payrolluk/models/earnings_rate.py b/xero_python/payrolluk/models/earnings_rate.py index 6a3d4f04..7c4277cb 100644 --- a/xero_python/payrolluk/models/earnings_rate.py +++ b/xero_python/payrolluk/models/earnings_rate.py @@ -198,6 +198,7 @@ def earnings_type(self, earnings_type): "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable", + "StatutoryBereavementPayNorthernIreland", "None", ] # noqa: E501 diff --git a/xero_python/payrolluk/models/employee_statutory_leave_summary.py b/xero_python/payrolluk/models/employee_statutory_leave_summary.py index dcd2ecbf..4c67e810 100644 --- a/xero_python/payrolluk/models/employee_statutory_leave_summary.py +++ b/xero_python/payrolluk/models/employee_statutory_leave_summary.py @@ -159,6 +159,7 @@ def type(self, type): "Sharedparental", "Bereavement", "NeonatalCare", + "BereavementNire", "None", ] # noqa: E501 diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index 0c3eba2d..b7eb8e69 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 11.1.0 + OpenAPI spec version: 12.0.0 """ From 50239d6420533a764143cc6134eb852ea0f68ba7 Mon Sep 17 00:00:00 2001 From: "xero-public-bot[bot]" <183791422+xero-public-bot[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 10:27:14 +1200 Subject: [PATCH 71/79] Releasing 11.0.1 (OAS: 12.0.2) (#220) Co-authored-by: Github Actions --- docs/v1/accounting/index.html | 6 +++--- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 2 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au-v2/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/api/accounting_api.py | 2 +- xero_python/accounting/models/organisation.py | 16 ++++++++++++++++ xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 ++-- xero_python/file/api/files_api.py | 2 +- xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- xero_python/payrollauv2/api/payroll_au_v2_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 25 files changed, 43 insertions(+), 27 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index d11bf35b..4afa1fc4 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -4112,7 +4112,7 @@ "OrganisationType" : { "type" : "string", "description" : "Organisation Type", - "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST" ] + "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", "PERSONAL", "SINGLEMEMBERLLC", "CCORPORATIONLLC", "PARTNERSHIPLLC", "SCORPORATIONLLC", "LLC", "NOTLLC", "UNSPECIFIED" ] }, "BaseCurrency" : { "$ref" : "#/components/schemas/CurrencyCode" @@ -4189,7 +4189,7 @@ "OrganisationEntityType" : { "type" : "string", "description" : "Organisation Entity Type", - "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST" ] + "enum" : [ "ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", "PERSONAL", "SINGLEMEMBERLLC", "CCORPORATIONLLC", "PARTNERSHIPLLC", "SCORPORATIONLLC", "LLC", "NOTLLC", "UNSPECIFIED" ] }, "ShortCode" : { "type" : "string", @@ -6355,7 +6355,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

createAccount diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index b9432867..8d1b330e 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1242,7 +1242,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

getSubscription diff --git a/docs/v1/assets/index.html b/docs/v1/assets/index.html index 5c5d5e97..5a9e6618 100644 --- a/docs/v1/assets/index.html +++ b/docs/v1/assets/index.html @@ -1420,7 +1420,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

createAsset diff --git a/docs/v1/files/index.html b/docs/v1/files/index.html index 2f79148c..2201edfb 100644 --- a/docs/v1/files/index.html +++ b/docs/v1/files/index.html @@ -1171,7 +1171,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

createFileAssociation diff --git a/docs/v1/finance/index.html b/docs/v1/finance/index.html index a5cd96ab..b120c8d1 100644 --- a/docs/v1/finance/index.html +++ b/docs/v1/finance/index.html @@ -2376,7 +2376,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

getBankStatementAccounting diff --git a/docs/v1/payroll-au-v2/index.html b/docs/v1/payroll-au-v2/index.html index a1045479..4b888bc5 100644 --- a/docs/v1/payroll-au-v2/index.html +++ b/docs/v1/payroll-au-v2/index.html @@ -1160,7 +1160,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

approveTimesheet diff --git a/docs/v1/payroll-au/index.html b/docs/v1/payroll-au/index.html index 0daeec37..a1d4658e 100644 --- a/docs/v1/payroll-au/index.html +++ b/docs/v1/payroll-au/index.html @@ -3447,7 +3447,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

approveLeaveApplication diff --git a/docs/v1/payroll-nz/index.html b/docs/v1/payroll-nz/index.html index 9a7f579d..255cda1f 100644 --- a/docs/v1/payroll-nz/index.html +++ b/docs/v1/payroll-nz/index.html @@ -4068,7 +4068,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

approveTimesheet diff --git a/docs/v1/payroll-uk/index.html b/docs/v1/payroll-uk/index.html index 861bf4c8..a1192aec 100644 --- a/docs/v1/payroll-uk/index.html +++ b/docs/v1/payroll-uk/index.html @@ -3701,7 +3701,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

approveTimesheet diff --git a/docs/v1/projects/index.html b/docs/v1/projects/index.html index 992b3ae9..55f62955 100644 --- a/docs/v1/projects/index.html +++ b/docs/v1/projects/index.html @@ -1463,7 +1463,7 @@

SDK:
VSN: 11.0.0
VSN: 11.0.1
Methods

createProject diff --git a/setup.py b/setup.py index 6d635c83..50b8ece7 100644 --- a/setup.py +++ b/setup.py @@ -48,5 +48,5 @@ def read_file(filename): keywords="xero python sdk API oAuth", name="xero_python", packages=find_packages(include=["xero_python", "xero_python.*"]), - version="11.0.0", + version="11.0.1", ) diff --git a/xero_python/__init__.py b/xero_python/__init__.py index 912f98c3..c3c2995b 100644 --- a/xero_python/__init__.py +++ b/xero_python/__init__.py @@ -2,4 +2,4 @@ __author__ = """Xero Developer API""" __email__ = "api@xero.com" -__version__ = "11.0.0" +__version__ = "11.0.1" diff --git a/xero_python/accounting/api/accounting_api.py b/xero_python/accounting/api/accounting_api.py index d6cd0d6d..e89bb0fa 100644 --- a/xero_python/accounting/api/accounting_api.py +++ b/xero_python/accounting/api/accounting_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/accounting/models/organisation.py b/xero_python/accounting/models/organisation.py index 4f07c350..de9fff5d 100644 --- a/xero_python/accounting/models/organisation.py +++ b/xero_python/accounting/models/organisation.py @@ -434,6 +434,14 @@ def organisation_type(self, organisation_type): "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", + "PERSONAL", + "SINGLEMEMBERLLC", + "CCORPORATIONLLC", + "PARTNERSHIPLLC", + "SCORPORATIONLLC", + "LLC", + "NOTLLC", + "UNSPECIFIED", "None", ] # noqa: E501 @@ -911,6 +919,14 @@ def organisation_entity_type(self, organisation_entity_type): "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST", + "PERSONAL", + "SINGLEMEMBERLLC", + "CCORPORATIONLLC", + "PARTNERSHIPLLC", + "SCORPORATIONLLC", + "LLC", + "NOTLLC", + "UNSPECIFIED", "None", ] # noqa: E501 diff --git a/xero_python/appstore/api/app_store_api.py b/xero_python/appstore/api/app_store_api.py index c339f8b5..31a1b5c6 100644 --- a/xero_python/appstore/api/app_store_api.py +++ b/xero_python/appstore/api/app_store_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/assets/api/asset_api.py b/xero_python/assets/api/asset_api.py index d21e7763..027c0625 100644 --- a/xero_python/assets/api/asset_api.py +++ b/xero_python/assets/api/asset_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/docs/README.md b/xero_python/docs/README.md index 2574fc8f..fd4a2b04 100644 --- a/xero_python/docs/README.md +++ b/xero_python/docs/README.md @@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project: -- API version: 12.0.0 -- Package version: 11.0.0 +- API version: 12.0.2 +- Package version: 11.0.1 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://developer.xero.com](https://developer.xero.com) diff --git a/xero_python/file/api/files_api.py b/xero_python/file/api/files_api.py index a9e0c15e..d76a6abf 100644 --- a/xero_python/file/api/files_api.py +++ b/xero_python/file/api/files_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/finance/api/finance_api.py b/xero_python/finance/api/finance_api.py index d509e977..026935db 100644 --- a/xero_python/finance/api/finance_api.py +++ b/xero_python/finance/api/finance_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/identity/api/identity_api.py b/xero_python/identity/api/identity_api.py index ab5425b9..9ee4df18 100644 --- a/xero_python/identity/api/identity_api.py +++ b/xero_python/identity/api/identity_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/payrollau/api/payroll_au_api.py b/xero_python/payrollau/api/payroll_au_api.py index d074552a..2c866159 100644 --- a/xero_python/payrollau/api/payroll_au_api.py +++ b/xero_python/payrollau/api/payroll_au_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/payrollauv2/api/payroll_au_v2_api.py b/xero_python/payrollauv2/api/payroll_au_v2_api.py index 1ee336af..b1f8ba62 100644 --- a/xero_python/payrollauv2/api/payroll_au_v2_api.py +++ b/xero_python/payrollauv2/api/payroll_au_v2_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/payrollnz/api/payroll_nz_api.py b/xero_python/payrollnz/api/payroll_nz_api.py index 33797d16..3a6ccd13 100644 --- a/xero_python/payrollnz/api/payroll_nz_api.py +++ b/xero_python/payrollnz/api/payroll_nz_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/payrolluk/api/payroll_uk_api.py b/xero_python/payrolluk/api/payroll_uk_api.py index ab60798f..1c1e3ec5 100644 --- a/xero_python/payrolluk/api/payroll_uk_api.py +++ b/xero_python/payrolluk/api/payroll_uk_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ diff --git a/xero_python/project/api/project_api.py b/xero_python/project/api/project_api.py index b7eb8e69..86c3b315 100644 --- a/xero_python/project/api/project_api.py +++ b/xero_python/project/api/project_api.py @@ -21,7 +21,7 @@ """ """ - OpenAPI spec version: 12.0.0 + OpenAPI spec version: 12.0.2 """ From 5ad65a23e64738340c92b6c2e937326678cd599f Mon Sep 17 00:00:00 2001 From: Github Actions Date: Thu, 7 May 2026 01:21:43 +0000 Subject: [PATCH 72/79] Releasing 12.0.0 (OAS: 13.0.0) --- docs/v1/accounting/index.html | 699 +----------------- docs/v1/appstore/index.html | 2 +- docs/v1/assets/index.html | 2 +- docs/v1/files/index.html | 12 +- docs/v1/finance/index.html | 2 +- docs/v1/payroll-au-v2/index.html | 2 +- docs/v1/payroll-au/index.html | 2 +- docs/v1/payroll-nz/index.html | 2 +- docs/v1/payroll-uk/index.html | 2 +- docs/v1/projects/index.html | 2 +- setup.py | 2 +- xero_python/__init__.py | 2 +- xero_python/accounting/api/accounting_api.py | 341 +-------- xero_python/accounting/docs/AccountingApi.md | 276 ------- xero_python/accounting/docs/Prepayment.md | 1 + xero_python/accounting/models/prepayment.py | 29 + xero_python/appstore/api/app_store_api.py | 2 +- xero_python/assets/api/asset_api.py | 2 +- xero_python/docs/README.md | 4 +- xero_python/file/api/files_api.py | 2 +- xero_python/file/docs/Association.md | 2 + xero_python/file/docs/FilesApi.md | 4 +- xero_python/file/models/association.py | 58 ++ xero_python/finance/api/finance_api.py | 2 +- xero_python/identity/api/identity_api.py | 2 +- xero_python/payrollau/api/payroll_au_api.py | 2 +- .../payrollauv2/api/payroll_au_v2_api.py | 2 +- xero_python/payrollnz/api/payroll_nz_api.py | 2 +- xero_python/payrolluk/api/payroll_uk_api.py | 2 +- xero_python/project/api/project_api.py | 2 +- 30 files changed, 133 insertions(+), 1333 deletions(-) diff --git a/docs/v1/accounting/index.html b/docs/v1/accounting/index.html index 4afa1fc4..0d51922c 100644 --- a/docs/v1/accounting/index.html +++ b/docs/v1/accounting/index.html @@ -4778,6 +4778,12 @@ "description" : "Xero generated unique identifier", "format" : "uuid" }, + "BrandingThemeID" : { + "type" : "string", + "description" : "The unique identifier of the branding template applied to a receive prepayment", + "format" : "uuid", + "readOnly" : true + }, "CurrencyRate" : { "type" : "number", "description" : "The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used", @@ -6355,7 +6361,7 @@

Parameters

createEmployees

Creates new employees used in Xero payrun

This endpoint is deprecated and will be removed April 28, 2026

-
-

/Employees

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_create_employees():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    summarize_errors = 'True'
-    idempotency_key = 'KEY_VALUE'
-
-    employee = Employee(
-        first_name = "Nick",
-        last_name = "Fury")
-
-    employees = Employees( 
-        employees = [employee])
-    
-    try:
-        api_response = api_instance.create_employees(xero_tenant_id, employees, summarize_errors, idempotency_key)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->createEmployees: %s\n" % e)

Scopes

- - - - - - - -

accounting.settings

Grant read-write access to organisation and account settings

Parameters

Header parameters

- - - - - - - - - - - - - -

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
Idempotency-Key	- - - - - - - String - - - -This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - - - -

Body parameters

- - - - - - - -

Name	Description
employees *	- - - - Employees - - - Employees with array of Employee object in body of request - - - - Required - - - -

Query parameters

- - - - - - - - - -

Name	Description
summarizeErrors	- - - - - - - Boolean - - - -If false return 200 OK and mix of successfully created objects and any with validation errors - - - - -

@@ -27072,303 +26875,6 @@

Parameters

getEmployee

Retrieves a specific employee used in Xero payrun using a unique employee Id

This endpoint is deprecated and will be removed April 28, 2026

-
-

/Employees/{EmployeeID}

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_employee():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    employee_id = '00000000-0000-0000-0000-000000000000'
-    
-    try:
-        api_response = api_instance.get_employee(xero_tenant_id, employee_id)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getEmployee: %s\n" % e)

Scopes

- - - - - - - - - - - - -

accounting.settings	Grant read-write access to organisation and account settings
accounting.settings.read	Grant read-only access to organisation and account settings

Parameters

Path parameters

- - - - - - - - - -

Name	Description
EmployeeID*	- - - - - - - UUID - - - (uuid) - - - -Unique identifier for a Employee - - - - Required - - - -

Header parameters

- - - - - - - - - -

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -

getEmployees

Retrieves employees used in Xero payrun

This endpoint is deprecated and will be removed April 28, 2026

-
-

/Employees

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_get_employees():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
-    where = 'Status=="ACTIVE"'
-    order = 'LastName ASC'
-    
-    try:
-        api_response = api_instance.get_employees(xero_tenant_id, if_modified_since, where, order)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->getEmployees: %s\n" % e)

Scopes

- - - - - - - - - - - - -

accounting.settings	Grant read-write access to organisation and account settings
accounting.settings.read	Grant read-only access to organisation and account settings

Parameters

Header parameters

- - - - - - - - - - - - - -

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
If-Modified-Since	- - - - - - - Date - - - (date-time) - - - -Only records created or modified since this timestamp will be returned - - - - -

Query parameters

- - - - - - - - - - -

Name	Description
where	- - - - - - - String - - - -Filter by an any element - - - - -
order	- - - - - - - String - - - -Order by an any element - - - - -

@@ -44965,197 +44471,6 @@

Parameters

updateOrCreateEmployees

Creates a single new employees used in Xero payrun

This endpoint is deprecated and will be removed April 28, 2026

-
-

/Employees

Usage and SDK Samples

Python

- -

# configure api_client for use with xero-python sdk client
-api_client = ApiClient(
-    Configuration(
-        debug=false,
-        oauth2_token=OAuth2Token(
-            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
-        ),
-    ),
-    pool_threads=1,
-)
-
-api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
-
-def accounting_update_or_create_employees():
-    api_instance = AccountingApi(api_client)
-    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
-    summarize_errors = 'True'
-    idempotency_key = 'KEY_VALUE'
-
-    employee = Employee(
-        first_name = "Nick",
-        last_name = "Fury")
-
-    employees = Employees( 
-        employees = [employee])
-    
-    try:
-        api_response = api_instance.update_or_create_employees(xero_tenant_id, employees, summarize_errors, idempotency_key)
-        print(api_response)
-    except AccountingBadRequestException as e:
-        print("Exception when calling AccountingApi->updateOrCreateEmployees: %s\n" % e)

Scopes

- - - - - - - -

accounting.settings

Grant read-write access to organisation and account settings

Parameters

Header parameters

- - - - - - - - - - - - - -

Name	Description
xero-tenant-id*	- - - - - - - String - - - -Xero identifier for Tenant - - - - Required - - - -
Idempotency-Key	- - - - - - - String - - - -This allows you to safely retry requests without the risk of duplicate processing. 128 character max. - - - - -

Body parameters

- - - - - - - -

Name	Description
employees *	- - - - Employees - - - Employees with array of Employee object in body of request - - - - Required - - - -

Query parameters

- - - - - - -

Name	Description
summarizeErrors	- - - - - - - Boolean - - - -If false return 200 OK and mix of successfully created objects and any with validation errors - - - - -

diff --git a/docs/v1/appstore/index.html b/docs/v1/appstore/index.html index 8d1b330e..4c0c6d17 100644 --- a/docs/v1/appstore/index.html +++ b/docs/v1/appstore/index.html @@ -1242,7 +1242,7 @@

deleteBankTransfer

Deletes a specific bank transfer

+
+

/BankTransfers/{BankTransferID}

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_bank_transfer():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    bank_transfer_id = '00000000-0000-0000-0000-000000000000'
+    idempotency_key = 'KEY_VALUE'
+
+    bankTransferDeleteByUrlParam = BankTransferDeleteByUrlParam(
+        status = "DELETED")
+    
+    try:
+        api_response = api_instance.delete_bank_transfer(xero_tenant_id, bank_transfer_id, bankTransferDeleteByUrlParam, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteBankTransfer: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Path parameters

+ + + + + + + + + +

Name	Description
BankTransferID*	+ + + + + + + UUID + + + (uuid) + + + +Xero generated unique identifier for a bank transfer + + + + Required + + + +

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
bankTransferDeleteByUrlParam *	+ + + + BankTransferDeleteByUrlParam + + + + + + + Required + + + +

deleteBankTransfers

Deletes one or more bank transfers

+
+

/BankTransfers

Usage and SDK Samples

Python

+ +

# configure api_client for use with xero-python sdk client
+api_client = ApiClient(
+    Configuration(
+        debug=false,
+        oauth2_token=OAuth2Token(
+            client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET"
+        ),
+    ),
+    pool_threads=1,
+)
+
+api_client.set_oauth2_token("YOUR_ACCESS_TOKEN")
+
+def accounting_delete_bank_transfers():
+    api_instance = AccountingApi(api_client)
+    xero_tenant_id = 'YOUR_XERO_TENANT_ID'
+    summarize_errors = 'True'
+    idempotency_key = 'KEY_VALUE'
+
+    bankTransferDelete = BankTransferDelete(
+        bank_transfer_id = "00000000-0000-0000-0000-000000000000",
+        status = "DELETED")
+
+    bankTransfers = BankTransfers( 
+        bank_transfers = [bank_transfer])
+    
+    try:
+        api_response = api_instance.delete_bank_transfers(xero_tenant_id, bankTransfersDelete, summarize_errors, idempotency_key)
+        print(api_response)
+    except AccountingBadRequestException as e:
+        print("Exception when calling AccountingApi->deleteBankTransfers: %s\n" % e)

Scopes

+ + + + + + + +

accounting.transactions

Grant read-write access to bank transactions, credit notes, invoices, repeating invoices

Parameters

Header parameters

+ + + + + + + + + + + + + +

Name	Description
xero-tenant-id*	+ + + + + + + String + + + +Xero identifier for Tenant + + + + Required + + + +
Idempotency-Key	+ + + + + + + String + + + +This allows you to safely retry requests without the risk of duplicate processing. 128 character max. + + + + +

Body parameters

+ + + + + + + +

Name	Description
bankTransfersDelete *	+ + + + BankTransfersDelete + + + BankTransfers with array of BankTransfer objects in request body + + + + Required + + + +

Query parameters

+ + + + + + +

Name	Description
summarizeErrors	+ + + + + + + Boolean + + + +If false return 200 OK and mix of successfully created objects and any with validation errors + + + + +

@@ -22794,9 +23318,10 @@

Usage and SDK Samples

if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00") where = 'HasAttachments==true' order = 'Amount ASC' + include_deleted = 'True' try: - api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order) + api_response = api_instance.get_bank_transfers(xero_tenant_id, if_modified_since, where, order, include_deleted) print(api_response) except AccountingBadRequestException as e: print("Exception when calling AccountingApi->getBankTransfers: %s\n" % e) @@ -22914,6 +23439,26 @@

Parameters

+ + Boolean + + +

+e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response +