{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-products/class/apis/partner/period-updates.yaml","sidebar":"sidebar-sidebar.yaml__products_class_apis_partner_period-updates","current-catalog-info":"current-catalog-info-/products/class/apis/partner/period-updates"},"props":{"definitionId":"products/class/apis/partner/period-updates.yaml","settings":{"baseUrlPath":"/products/class/apis/partner/period-updates"},"disableAutoScroll":true,"seo":{"title":"Period Updates"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"Period Updates","version":"1.0","description":"A **period update** brings a fund's accounts up to date to a chosen date. It is part of the\nyear-end process, but it can also be run part-way through a financial year when balances need\nto be confirmed and investments revalued, for example before starting a pension or paying a\nlump sum.\n\nWhen a period update runs, Class:\n\n- posts depreciation expense from the depreciation worksheet\n- completes any outstanding parcel matching\n- calculates profit or loss on investment disposals\n- revalues the fund's investments\n- posts income tax expense\n- allocates benefits to members or beneficiaries\n- updates the investment, member, fund and tax registers.\n\nFor the full product explanation, see\n[Period Update](https://support.class.com.au/hc/en-au/articles/360001382755-Period-Update).\n\n---\n\n**Period updates run in the background**\n\n**New period update** and **Roll back period update** return `200` as soon as the work has\nbeen accepted and queued, not when it has finished. Use **Period update detail** to follow\nprogress until `ProcessingStatus` reaches a final value.\n\n| Operation | Status when accepted | Final status |\n|-----------|----------------------|--------------|\n| **New period update** | `Initial` | `Processed`, or `Errored` if processing failed |\n| **Roll back period update** | Usually `Cancelling` (see below) | `Cancelled` |\n\n`Initial` covers both waiting in the queue and processing. There is no separate in-progress\nstatus.\n\nStraight after a rollback is accepted, the period update can still show `Processed` for a\nshort time before it changes to `Cancelling`. After a rollback, only `Cancelled` means it has\nfinished.\n\n**Running a period update, in this order**\n\n1. **Period updates**: list the fund's period updates. A new period update starts the day\n after the fund's latest active period update ends or, if the fund has none, on the fund's\n start date. Its `PeriodEndDate` must be later than the end of the latest active period\n update.\n2. **New period update**: send the `PeriodEndDate` and a `Description`. Class works out the\n start date and financial year. Keep the returned `PeriodUpdateId`.\n3. **Period update detail**: poll with the `PeriodUpdateId` at a modest interval until `ProcessingStatus` is `Processed` or `Errored`. When it is\n `Errored`, `Messages` explains what went wrong.\n\nRun one period update at a time for each fund. Do not send **New period update** while the\nfund's latest period update is still `Initial` or `Cancelling`.\n\n**Rolling back**\n\nOnly the fund's latest active period update can be rolled back, and only once it has finished\nprocessing. To roll back several, start with the most recent and work backwards, waiting for\neach to reach `Cancelled`. Class's own rollback rules also apply, and a rollback they reject\nreturns `400` with the reason in `Errors`.\n\n**Which funds are supported**\n\nSuper funds (SMSF and SAF) and other entity types (Personal, Trust, Company and Partnership)\nare supported. Consolidated entities are rejected on every operation with\n`API_INVALID_FUND_TYPE`. A fund that is not Active can still be read, but period updates\ncannot be created or rolled back on it.\n\n\n
Servers
Partner Integration Environment (Sandbox)
https://api.class-pie.com.au/api/1.0
Production Environment
https://api.class.com.au/api/1.0
","apiId":"Class Partner v1","tags":["Class Partner"]},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"nonprod.developer.myhub.com.au","port":4000,"ipAddress":"216.73.216.208"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/class/apis/partner/period-updates","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}