Xero — Data Models
info
Auto-generated from dismantly-backend/Microservices/Xero/dependencies/models.py. Do not edit by hand.
Interaction map
How the APIs and events in this service read and write its objects, and how changes flow downstream.
tip
Click an object box (e.g. the CONTACT cylinder) to open its page, or a handler box to view its source on GitHub. Drag to pan, scroll to zoom, or use the Fullscreen button.
Stored Objects (Entities)
| Object | Discriminator | Version |
|---|---|---|
| AccountModel | — | v1.0.0 |
| ContactModel | — | v1.0.0 |
| CreditNoteModel | — | v1.0.0 |
| InvoiceModel | — | v1.0.0 |
| PaymentModel | — | v2.0.0 |
Supporting Models
| Object | Version |
|---|---|
| GetContactByAccountNumberQuery | v1.0.0 |
| GetContactByNameQuery | v1.0.0 |
| PrimaryPerson | v1.0.0 |
API Surface
Every endpoint and event in this service, with the model(s) it uses.
| Trigger | Endpoint / Source | Handler | Model(s) |
|---|---|---|---|
| Event | EventBridge | src/account/xero_account_archive.py | — |
| Event | EventBridge | src/account/xero_account_post.py | — |
| Event | EventBridge | src/account/xero_account_put.py | — |
| Event | EventBridge | src/account/xero_account_restore.py | — |
| API | GET /newxero/account | src/account/xero_account_status_get.py | — |
| API | POST /newxero/SyncAccountsToXero | src/account/xero_account_sync_account_to_xero.py | — |
| Event | EventBridge | src/cash_refund/xero_cash_refund_delete.py | — |
| Event | EventBridge | src/cash_refund/xero_cash_refund_post.py | — |
| API | GET /newxero/cashRefund | src/cash_refund/xero_cash_refund_status_get.py | — |
| Event | EventBridge | src/contact/xero_contact_archive.py | — |
| Event | EventBridge | src/contact/xero_contact_created_web_hook.py | — |
| API | GET /newxero/contact/accountNumber | src/contact/xero_contact_get_by_account_number.py | GetContactByAccountNumberQuery |
| API | GET /newxero/contact/name | src/contact/xero_contact_get_by_name.py | GetContactByNameQuery |
| Event | EventBridge | src/contact/xero_contact_post.py | — |
| Event | EventBridge | src/contact/xero_contact_put.py | — |
| API | GET /newxero/contact/validate | src/contact/xero_contact_put_validate.py | — |
| API | POST /newxero/search | src/contact/xero_contact_search.py | — |
| API | GET /newxero/contact | src/contact/xero_contact_status_get.py | — |
| API | GET /newxero/totals | src/contact/xero_contact_totals.py | — |
| Event | EventBridge | src/contact/xero_contact_updated_web_hook.py | — |
| API | GET /newxero/contact/validateAttributes | src/contact/xero_contact_validate.py | — |
| API | GET /newxero/contact/validate/email | src/contact/xero_contact_validate_email.py | — |
| API | GET /newxero/contact/dismantly | src/contact/xero_get_only_dismantly_contacts.py | — |
| API | GET /newxero/contact/xero | src/contact/xero_get_only_xero_contacts.py | — |
| API | POST /newxero/contact/reconcile | src/contact/xero_reconcile_contacts.py | — |
| Event | EventBridge | src/credit/xero_credit_allocate.py | — |
| Event | EventBridge | src/credit/xero_credit_deallocation.py | — |
| Event | EventBridge | src/credit/xero_credit_delete.py | — |
| Event | EventBridge | src/credit/xero_credit_post.py | — |
| API | GET /newxero/credit | src/credit/xero_credit_status_get.py | — |
| Event | EventBridge | src/invoice/xero_invoice_approve.py | — |
| Event | EventBridge | src/invoice/xero_invoice_delete.py | — |
| API | PUT /newxero/invoice/email | src/invoice/xero_invoice_email.py | — |
| API | POST /newxero/invoice/invoices | src/invoice/xero_invoice_get_invoices.py | — |
| Event | EventBridge | src/invoice/xero_invoice_mark_as_emailed.py | — |
| API | GET /newxero/invoice/pdf | src/invoice/xero_invoice_pdf_get.py | — |
| Event | EventBridge | src/invoice/xero_invoice_post.py | — |
| API | GET /newxero/invoice | src/invoice/xero_invoice_status_get.py | — |
| Event | EventBridge | src/invoice/xero_invoice_updated_web_hook.py | — |
| API | POST /newxero/invoice/validate | src/invoice/xero_invoice_validate.py | — |
| Event | EventBridge | src/invoice/xero_invoice_void.py | — |
| Event | EventBridge | src/invoice/xero_invoice_with_payment_update.py | — |
| Event | EventBridge | src/invoice/xero_invoice_without_payment_update.py | — |
| Event | EventBridge | src/payment/xero_payment_delete.py | — |
| Event | EventBridge | src/payment/xero_payment_post.py | — |
| API | GET /newxero/payment | src/payment/xero_payment_status_get.py | — |
| Stream | DynamoDB stream | src/xero_opensearch_sync.py | — |
| Event | EventBridge | src/xero_process_payments.py | — |