{"items":[{"type":"link","label":"Period Updates","link":"/products/class/apis/partner/period-updates","routeSlug":"/products/class/apis/partner/period-updates","content":{"contentType":"overview","meta":{"name":"Period Updates"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"period-updates.json","url":"/_bundle/products/class/apis/partner/period-updates.json?download"},{"kind":"download","label":"period-updates.yaml","url":"/_bundle/products/class/apis/partner/period-updates.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Period Updates (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" brings a fund's accounts up to date to a chosen date. It is part of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"year-end process, but it can also be run part-way through a financial year when balances need"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be confirmed and investments revalued, for example before starting a pension or paying a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lump sum."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a period update runs, Class:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"posts depreciation expense from the depreciation worksheet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completes any outstanding parcel matching"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculates profit or loss on investment disposals"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"revalues the fund's investments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"posts income tax expense"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allocates benefits to members or beneficiaries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updates the investment, member, fund and tax registers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the full product explanation, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.class.com.au/hc/en-au/articles/360001382755-Period-Update"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates run in the background"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as soon as the work has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been accepted and queued, not when it has finished. Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to follow"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"progress until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches a final value."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status when accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final status"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if processing failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (see below)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" covers both waiting in the queue and processing. There is no separate in-progress"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Straight after a rollback is accepted, the period update can still show "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"short time before it changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After a rollback, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means it has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Running a period update, in this order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": list the fund's period updates. A new period update starts the day"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the fund's latest active period update ends or, if the fund has none, on the fund's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start date. Its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be later than the end of the latest active period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Class works out the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start date and financial year. Keep the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": poll with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at a modest interval until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When it is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains what went wrong."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run one period update at a time for each fund. Do not send "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fund's latest period update is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rolling back"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fund's latest active period update can be rolled back, and only once it has finished"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing. To roll back several, start with the most recent and work backwards, waiting for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each to reach "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Class's own rollback rules also apply, and a rollback they reject"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the reason in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which funds are supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Super funds (SMSF and SAF) and other entity types (Personal, Trust, Company and Partnership)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are supported. Consolidated entities are rejected on every operation with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A fund that is not Active can still be read, but period updates"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be created or rolled back on it."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-panel","data-component-name":"EnvPanel"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-panel__header"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Servers"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-panel__body"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-row"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-name"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Partner Integration Environment (Sandbox)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-url-row"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"env-url"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://api.class-pie.com.au/api/1.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"button","attrs":{"type":"button","className":"copy-btn","data-copy":"https://api.class-pie.com.au/api/1.0","aria-label":"Copy"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"viewbox":"0 0 16 16","fill":"none","xmlns":"http://www.w3.org/2000/svg","aria-hidden":"true"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"fillRule":"evenodd","clipRule":"evenodd","d":"M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z","fill":"currentColor"}},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-row"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-name"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Production Environment"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"env-url-row"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"env-url"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"https://api.class.com.au/api/1.0"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"button","attrs":{"type":"button","className":"copy-btn","data-copy":"https://api.class.com.au/api/1.0","aria-label":"Copy"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"svg","attrs":{"viewbox":"0 0 16 16","fill":"none","xmlns":"http://www.w3.org/2000/svg","aria-hidden":"true"}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"path","attrs":{"fillRule":"evenodd","clipRule":"evenodd","d":"M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z","fill":"currentColor"}},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Fund","link":"/products/class/apis/partner/period-updates/fund","routeSlug":"/products/class/apis/partner/period-updates/fund","items":[{"label":"Period updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/period-updates/fund/getallperiodupdates","routeSlug":"/products/class/apis/partner/period-updates/fund/getallperiodupdates","metadata":{"seo":{"title":"Period updates","description":"Returns the fund's active period updates. The response is unpaginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAllPeriodUpdates","name":"Period updates","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Period updates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the fund's active period updates. The response is unpaginated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which period updates are included."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, period updates in every financial year that is not closed are returned. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied, that year's period updates are returned whether the year is open, tax finalised or closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled and errored period updates are left out."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Rolled-back ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and failed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") period updates do not appear in this list. To check one of these, use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid request with nothing to show returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. A fund that is not Active can still be listed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.details.read"],"type":"oauth2","description":"Class uses OAuth2 and OpenID for authentication and authorisation. The resource owner password credentials and authorization code flows are supported.","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_0","description":"The unique identifier code for the Class business.","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1","description":"The unique identifier code for the Class fund.","required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"year","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The financial year to list, given as its end year. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the year from 1 July 2025 to 30 June 2026. Omit to list every financial year that is not closed. Must be a single whole number. Any other value returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_PARAMETER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a year that is not one of the fund's financial years returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FINANCIAL_YEAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/f/{businessCode}/{fundCode}/period-updates","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_0"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1"}],"query":[{"name":"year","in":"query","required":false,"example":2026,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oauth2","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.details.read"]}],"responseCodes":["200","400","401","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/period-updates","href":"fund/getallperiodupdates","openApiOperationId":"GetAllPeriodUpdates","summary":"Period updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success (Ok)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeriodUpdateListEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/PeriodUpdateListEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is invalid and nothing is returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a single whole number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_PARAMETER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or is not one of the fund's financial years ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FINANCIAL_YEAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the fund is a Consolidated entity ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"404","description":"The business, fund or period update was not found, or the user does not have access to the fund.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeriodUpdateListEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeriodUpdateListEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"code":"404","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"500","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/getallperiodupdates"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/period-updates"},{"label":"New period update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/period-updates/fund/createperiodupdate","routeSlug":"/products/class/apis/partner/period-updates/fund/createperiodupdate","metadata":{"seo":{"title":"New period update","description":"Starts a new period update for the fund, ending on PeriodEndDate. Class works out the start date (the day after the fund's latest active period update ends, or the fund's start date if it has none) and the financial year, and returns them with the new PeriodUpdateId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePeriodUpdate","name":"New period update","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New period update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a new period update for the fund, ending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Class works out the start date (the day after the fund's latest active period update ends, or the fund's start date if it has none) and the financial year, and returns them with the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the period update was accepted and queued, not that it has finished."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Poll "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To process a whole financial year, send that year's end date (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-06-30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). There is no separate full-year option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run one period update at a time for each fund. A request sent while the fund's latest period update is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. The fund must be Active and must not be a Consolidated entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.maintain"],"type":"oauth2","description":"Class uses OAuth2 and OpenID for authentication and authorisation. The resource owner password credentials and authorization code flows are supported.","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_0","description":"The unique identifier code for the Class business.","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1","description":"The unique identifier code for the Class fund.","required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePeriodUpdateRequest","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"]}},"schemaId":"components/schemas/CreatePeriodUpdateRequest","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody","description":"The end date and description of the new period update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/f/{businessCode}/{fundCode}/period-updates","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_0"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oauth2","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.maintain"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePeriodUpdateRequest","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"]}},"responseCodes":["200","400","401","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/period-updates","href":"fund/createperiodupdate","openApiOperationId":"CreatePeriodUpdate","summary":"New period update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"schemaId":"components/schemas/CreatePeriodUpdateRequest","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePeriodUpdateRequest","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success (Ok). The period update was accepted and queued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was rejected and no period update was created. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why. See "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors and warnings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for every code this operation can return."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate"]}},"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"404","description":"The business, fund or period update was not found, or the user does not have access to the fund.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be queued for processing. No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned. Check "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before trying again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField","paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate"]}}},{"code":"401","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"code":"404","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"500","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/createperiodupdate"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/period-updates"},{"label":"Period update detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/period-updates/fund/getperiodupdatebyid","routeSlug":"/products/class/apis/partner/period-updates/fund/getperiodupdatebyid","metadata":{"seo":{"title":"Period update detail","description":"Returns one period update. Use this to follow a period update after New period update or Roll back period update until ProcessingStatus reaches a final value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPeriodUpdateById","name":"Period update detail","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Period update detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one period update. Use this to follow a period update after "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches a final value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this returns every period update that belongs to the fund, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ones, and those in closed or tax-finalised years."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a rollback, wait for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" moves from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It can still show "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a short time straight after the rollback is accepted, so do not treat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the end of a rollback. Warnings raised by the rollback are added to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExecutionDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keep their original values: they describe when and by whom the period update was created, not rolled back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.details.read"],"type":"oauth2","description":"Class uses OAuth2 and OpenID for authentication and authorisation. The resource owner password credentials and authorization code flows are supported.","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_0","description":"The unique identifier code for the Class business.","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1","description":"The unique identifier code for the Class fund.","required":true},{"name":"periodUpdateId","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the period update, as returned by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An id that is not a valid UUID, does not exist, or belongs to another fund returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_0"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1"},{"name":"periodUpdateId","in":"path","required":true,"example":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oauth2","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.details.read"]}],"responseCodes":["200","400","401","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","href":"fund/getperiodupdatebyid","openApiOperationId":"GetPeriodUpdateById","summary":"Period update detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success (Ok)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeriodUpdateDetailEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled"]}},"schemaId":"components/schemas/PeriodUpdateDetailEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled"]},{"code":"400","description":"The fund is a Consolidated entity, which period updates do not support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"404","description":"The business, fund or period update was not found, or the user does not have access to the fund.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeriodUpdateDetailEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeriodUpdateDetailEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled"]}}},{"code":"400","schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"code":"404","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"500","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/getperiodupdatebyid"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}"},{"label":"Roll back period update","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/period-updates/fund/rollbackperiodupdate","routeSlug":"/products/class/apis/partner/period-updates/fund/rollbackperiodupdate","metadata":{"seo":{"title":"Roll back period update","description":"Rolls back a period update, reversing what it posted. This is the API equivalent of Rollback on the Period Updates screen in Class."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RollbackPeriodUpdate","name":"Roll back period update","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roll back period update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rolls back a period update, reversing what it posted. This is the API equivalent of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollback"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the Period Updates screen in Class."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the rollback was accepted and queued, not that it has finished."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Poll "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProcessingStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It can still show "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a short time before changing to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fund's latest active period update can be rolled back, and only once it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A period update that is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_CANNOT_CANCEL_INITIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If a later active period update exists, roll that one back first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Warnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Class may report other changes the rollback will make, such as reversing a related event. These are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Warnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and later added to the period update's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repeating the request for a period update that is already "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without queuing anything new. The fund must be Active and must not be a Consolidated entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.maintain"],"type":"oauth2","description":"Class uses OAuth2 and OpenID for authentication and authorisation. The resource owner password credentials and authorization code flows are supported.","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_0","description":"The unique identifier code for the Class business.","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1","description":"The unique identifier code for the Class fund.","required":true},{"name":"periodUpdateId","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the period update, as returned by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An id that is not a valid UUID, does not exist, or belongs to another fund returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_0"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1"},{"name":"periodUpdateId","in":"path","required":true,"example":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oauth2","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.maintain"]}],"responseCodes":["200","400","401","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","href":"fund/rollbackperiodupdate","openApiOperationId":"RollbackPeriodUpdate","summary":"Roll back period update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success (Ok). The rollback was accepted and queued, or was already under way.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RollbackPeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling"]}},"schemaId":"components/schemas/RollbackPeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rollback was rejected and nothing was changed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Warnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always present (an empty array when there are none)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelopeWithWarnings","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive"]}},"schemaId":"components/schemas/ErrorEnvelopeWithWarnings","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"404","description":"The business, fund or period update was not found, or the user does not have access to the fund.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be queued for processing. No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodUpdateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned. Check "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before trying again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RollbackPeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RollbackPeriodUpdateResponseEnvelope","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling"]}}},{"code":"400","schemaId":"components/schemas/ErrorEnvelopeWithWarnings","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorEnvelopeWithWarnings","exampleIds":["paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial","paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive"]}}},{"code":"401","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"code":"404","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"500","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/rollbackperiodupdate"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}"}],"content":{"contentType":"group","meta":{"name":"Fund"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update operations within a fund ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/f/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). A period update processes a fund's accounts for a period and can be rolled back while it is the latest active period update."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/f/{businessCode}/{fundCode}/period-updates","summary":"Period updates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund/getallperiodupdates","deprecated":false},{"title":"/f/{businessCode}/{fundCode}/period-updates","summary":"New period update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fund/createperiodupdate","deprecated":false},{"title":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","summary":"Period update detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund/getperiodupdatebyid","deprecated":false},{"title":"/f/{businessCode}/{fundCode}/period-updates/{periodUpdateId}","summary":"Roll back period update","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fund/rollbackperiodupdate","deprecated":false}]}]}]}]}},{"type":"group","label":"Errors and warnings","link":"/products/class/apis/partner/period-updates/errors-and-warnings","routeSlug":"/products/class/apis/partner/period-updates/errors-and-warnings","items":[],"content":{"contentType":"group","meta":{"name":"Errors and warnings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Errors and warnings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every response carries an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also carries a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Warnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the request was rejected and nothing was created or changed. A"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not reject the request, but describes something you should know about,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"such as other Class events that a rollback will also reverse."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which operation returns what"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can return"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_PARAMETER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FINANCIAL_YEAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_PARAMETER_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_PARAMETER_TOO_LONG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and Class's period update rules (see below)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_CANNOT_CANCEL_INITIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_NOT_LAST_ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and Class's rollback rules. Warnings: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_CLASS_WARNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_ALREADY"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every operation can also return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_NOT_AUTHORISED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (401), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (404) and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INTERNAL_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (500)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request validation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Severity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raised when"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_PARAMETER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present but is not a single whole number. This includes an empty value, spaces, decimals and lists such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026,2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FINANCIAL_YEAR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period updates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a whole number but is not one of the fund's financial years."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_PARAMETER_REQUIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing, null, empty or only spaces."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_PARAMETER_TOO_LONG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is longer than 250 characters after leading and trailing spaces are removed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid calendar date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Dates with a time or time zone are rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API_INVALID_FUND_TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any operation: the fund is a Consolidated entity."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": New period update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Class also checks that the period update can run. A request is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the period would fall in a financial year that is not open for the fund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PeriodEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not later than the end of the fund's latest active period update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the fund's latest period update is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollback rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Roll back period update"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Severity"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raised when"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_CANNOT_CANCEL_INITIAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period update is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Wait until it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then try again."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_NOT_LAST_ACTIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A later active period update exists. Roll that one back first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_CLASS_WARNING"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Class reports a consequence of the rollback, for example that a related event will also be reversed. The rollback still goes ahead. The same text later appears in the period update's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERIOD_UPDATE_ALREADY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rollback of this period update is already under way or complete (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Already Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Nothing new is queued and the response is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/errors-and-warnings"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/CreatePeriodUpdateRequest":{"id":"components/schemas/CreatePeriodUpdateRequest","kind":"json-schema","title":"CreatePeriodUpdateRequest","data":{"type":"object","required":["PeriodEndDate","Description"],"properties":{"PeriodEndDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last day of the period, as a date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. It must fall in an open financial year and be later than the end of the fund's latest active period update. A time or time zone is not accepted."},"children":[]}]}]}],"example":"2025-07-31"},"Description":{"type":"string","minLength":1,"maxLength":250,"description":"A description of the period update, shown in Class. Leading and trailing spaces are removed, and the result must be between 1 and 250 characters.\n","example":"July 2025 period update"}}}},"components/schemas/CreatePeriodUpdateResponseEnvelope":{"id":"components/schemas/CreatePeriodUpdateResponseEnvelope","kind":"json-schema","title":"CreatePeriodUpdateResponseEnvelope","data":{"type":"object","required":["Data"],"properties":{"Data":{"$ref":"#/components/schemas/CreatePeriodUpdateResult"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/CreatePeriodUpdateResult":{"id":"components/schemas/CreatePeriodUpdateResult","kind":"json-schema","title":"CreatePeriodUpdateResult","data":{"type":"object","required":["PeriodUpdateId","PeriodStartDate","PeriodEndDate"],"properties":{"PeriodUpdateId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the new period update. Use it to poll "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period update detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"PeriodStartDate":{"type":"string","format":"date","description":"The first day of the period, worked out by Class: the day after the fund's latest active period update ends, or the fund's start date if it has none.\n"},"PeriodEndDate":{"type":"string","format":"date","description":"The last day of the period, as sent in the request."}}}},"components/schemas/PeriodUpdateListEnvelope":{"id":"components/schemas/PeriodUpdateListEnvelope","kind":"json-schema","title":"PeriodUpdateListEnvelope","data":{"type":"object","required":["Data"],"properties":{"Data":{"type":"array","items":{"$ref":"#/components/schemas/PeriodUpdate"}},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/PeriodUpdateDetailEnvelope":{"id":"components/schemas/PeriodUpdateDetailEnvelope","kind":"json-schema","title":"PeriodUpdateDetailEnvelope","data":{"type":"object","required":["Data"],"properties":{"Data":{"$ref":"#/components/schemas/PeriodUpdate"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/PeriodUpdate":{"id":"components/schemas/PeriodUpdate","kind":"json-schema","title":"PeriodUpdate","data":{"type":"object","description":"A period update. Every property is always returned.","required":["PeriodUpdateId","Description","FinancialYear","PeriodStartDate","PeriodEndDate","ExecutionDate","ProcessedBy","ProcessingStatus","PublishedToClientView","Messages"],"properties":{"PeriodUpdateId":{"type":"string","format":"uuid","description":"The unique identifier of the period update, in lowercase."},"Description":{"type":"string","description":"The description given when the period update was created. Never null."},"FinancialYear":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The financial year the period belongs to, given as its end year. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the year from 1 July 2025 to 30 June 2026."},"children":[]}]}]}],"example":2026},"PeriodStartDate":{"type":"string","format":"date","description":"The first day of the period."},"PeriodEndDate":{"type":"string","format":"date","description":"The last day of the period."},"ExecutionDate":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the period update was created, in Australian Eastern time (Sydney) as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with no time zone offset. Unchanged by a rollback."},"children":[]}]}]}],"example":"2025-08-04T09:15:22"},"ProcessedBy":{"type":["string","null"],"description":"The login of the user who created the period update. Unchanged by a rollback.\n","example":"partner@example.com.au"},"ProcessingStatus":{"$ref":"#/components/schemas/ProcessingStatus"},"PublishedToClientView":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the period update's results are published to the client view in Class. This becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when processing publishes them, and returns to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the period update has been rolled back."},"children":[]}]}]}]},"Messages":{"type":"array","description":"Errors and warnings recorded while processing or rolling back the period update, errors first. An empty array when there are none.\n","items":{"$ref":"#/components/schemas/PeriodUpdateMessage"}}}}},"components/schemas/ProcessingStatus":{"id":"components/schemas/ProcessingStatus","kind":"json-schema","title":"ProcessingStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the period update is up to."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted and waiting to be processed, or being processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finished successfully. Final."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Errored"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing failed. Final. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rollback accepted and in progress."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rolled back. Final."},"children":[]}]}]}]}]}]}],"enum":["Initial","Processed","Errored","Cancelling","Cancelled"]}},"components/schemas/PeriodUpdateMessage":{"id":"components/schemas/PeriodUpdateMessage","kind":"json-schema","title":"PeriodUpdateMessage","data":{"type":"object","required":["Severity","Text"],"properties":{"Severity":{"type":"string","enum":["Error","Warning","Information"],"description":"How serious the message is."},"Text":{"type":"string","description":"The message from Class."}}}},"components/schemas/RollbackPeriodUpdateResponseEnvelope":{"id":"components/schemas/RollbackPeriodUpdateResponseEnvelope","kind":"json-schema","title":"RollbackPeriodUpdateResponseEnvelope","data":{"type":"object","required":["Data","Warnings"],"properties":{"Data":{"$ref":"#/components/schemas/RollbackPeriodUpdateResult"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"Warnings":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advisory warnings about the rollback. A populated array does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" mean the rollback was rejected. An empty array when there are none."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ApiWarning"}}}}},"components/schemas/RollbackPeriodUpdateResult":{"id":"components/schemas/RollbackPeriodUpdateResult","kind":"json-schema","title":"RollbackPeriodUpdateResult","data":{"type":"object","required":["PeriodUpdateId"],"properties":{"PeriodUpdateId":{"type":"string","format":"uuid","description":"The unique identifier of the period update being rolled back."}}}},"components/schemas/ErrorEnvelope":{"id":"components/schemas/ErrorEnvelope","kind":"json-schema","title":"ErrorEnvelope","data":{"type":"object","properties":{"Data":{"type":"null"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/ErrorEnvelopeWithWarnings":{"id":"components/schemas/ErrorEnvelopeWithWarnings","kind":"json-schema","title":"ErrorEnvelopeWithWarnings","data":{"type":"object","properties":{"Data":{"type":"null"},"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}},"Warnings":{"type":"array","items":{"$ref":"#/components/schemas/ApiWarning"}}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","required":["Code","Message"],"properties":{"Code":{"type":"string","description":"The unique error code identifier."},"Message":{"type":"string","description":"A detailed human-readable message explaining the error."}}}},"components/schemas/ApiWarning":{"id":"components/schemas/ApiWarning","kind":"json-schema","title":"ApiWarning","data":{"type":"object","required":["Code","Message"],"description":"An advisory warning returned alongside a successful response. The operation went ahead; the warning describes something that needs attention.\n","properties":{"Code":{"type":"string","description":"The unique warning code identifier."},"Message":{"type":"string","description":"A detailed human-readable message explaining the warning."}}}},"components/schemas/InternalErrorCommon":{"id":"components/schemas/InternalErrorCommon","kind":"json-schema","title":"InternalErrorCommon","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INTERNAL_ERROR"},"Message":{"type":"string","example":"An unexpected error occurred on the server. Please try again later."}}}},"components/schemas/ResourceUnavailableErrorCommon":{"id":"components/schemas/ResourceUnavailableErrorCommon","kind":"json-schema","title":"ResourceUnavailableErrorCommon","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_NOT_FOUND"},"Message":{"type":"string","example":"Resource not available or user does not have access to the fund."}}}},"components/schemas/UnauthorizedErrorCommon":{"id":"components/schemas/UnauthorizedErrorCommon","kind":"json-schema","title":"UnauthorizedErrorCommon","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_NOT_AUTHORISED"},"Message":{"type":"string","example":"Not authorised"}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","example":"demo-business"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"demo-fund"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"integer","example":2026},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedErrorCommon"}}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceUnavailableErrorCommon"}}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/InternalErrorCommon"}}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13"},"id":"schema_6"}},"exampleStore":{"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows":{"value":{"Data":[{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","Description":"July 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31","ExecutionDate":"2025-08-04T09:15:22","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Processed","PublishedToClientView":true,"Messages":[]},{"PeriodUpdateId":"9c2f4e61-7a8b-4d3c-b1e0-6f5a4d3c2b19","Description":"August 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-08-01","PeriodEndDate":"2025-08-31","ExecutionDate":"2025-09-02T14:40:05","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Initial","PublishedToClientView":false,"Messages":[]}],"Errors":[]},"key":"withRows","summary":"Two period updates, one finished and one processing","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/withRows"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty":{"value":{"Data":[],"Errors":[]},"key":"empty","summary":"No active period updates","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/200/content/application~1json/examples/empty"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example":{"value":{"Data":null,"Errors":[{"Code":"API_INVALID_PARAMETER","Message":"The year parameter is invalid"}]},"id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/get/responses/400/content/application~1json/example"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month":{"value":{"PeriodEndDate":"2025-07-31","Description":"July 2025 period update"},"key":"month","summary":"One month","description":"Processes July 2025. If the fund's latest active period update ended on 30 June 2025, the new period update runs from 1 July 2025.\n","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/month"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear":{"value":{"PeriodEndDate":"2026-06-30","Description":"2026 financial year"},"key":"fullYear","summary":"Rest of the financial year","description":"Processes from the end of the latest active period update to the end of the 2025-26 financial year.\n","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/requestBody/content/application~1json/examples/fullYear"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31"},"Errors":[]},"id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/200/content/application~1json/example"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField":{"value":{"Data":null,"Errors":[{"Code":"API_PARAMETER_REQUIRED","Message":"Parameter 'PeriodEndDate' is required"}]},"key":"missingField","summary":"PeriodEndDate missing","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/missingField"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"Data":null,"Errors":[{"Code":"API_INVALID_DATE","Message":"Please specify a valid date"}]},"key":"invalidDate","summary":"PeriodEndDate not in yyyy-MM-dd format","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","Description":"July 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31","ExecutionDate":"2025-08-04T09:15:22","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Initial","PublishedToClientView":false,"Messages":[]},"Errors":[]},"key":"initial","summary":"Initial - accepted and processing","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/initial"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","Description":"July 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31","ExecutionDate":"2025-08-04T09:15:22","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Processed","PublishedToClientView":true,"Messages":[]},"Errors":[]},"key":"processed","summary":"Processed - finished successfully","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/processed"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","Description":"July 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31","ExecutionDate":"2025-08-04T09:15:22","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Cancelling","PublishedToClientView":true,"Messages":[{"Severity":"Warning","Text":"Rollback this period update will also reverse the associated Retained Earning Distribution event"}]},"Errors":[]},"key":"cancelling","summary":"Cancelling - rollback accepted","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Straight after "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roll back period update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The rollback's warning has been added to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelling"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13","Description":"July 2025 period update","FinancialYear":2026,"PeriodStartDate":"2025-07-01","PeriodEndDate":"2025-07-31","ExecutionDate":"2025-08-04T09:15:22","ProcessedBy":"partner@example.com.au","ProcessingStatus":"Cancelled","PublishedToClientView":false,"Messages":[]},"Errors":[]},"key":"cancelled","summary":"Cancelled - rolled back","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/200/content/application~1json/examples/cancelled"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example":{"value":{"Data":null,"Errors":[{"Code":"API_INVALID_FUND_TYPE","Message":"This operation is only applicable for funds of legal entity type SMSF, SAF, Personal, Trust, Company or Partnership, the requested fund is of type Consolidated"}]},"id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/get/responses/400/content/application~1json/example"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13"},"Errors":[],"Warnings":[]},"key":"acceptedNoWarnings","summary":"Rollback accepted","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/acceptedNoWarnings"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13"},"Errors":[],"Warnings":[{"Code":"PERIOD_UPDATE_CLASS_WARNING","Message":"Rollback this period update will also reverse the associated Retained Earning Distribution event"}]},"key":"accepted","summary":"Rollback accepted, with a warning","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/accepted"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling":{"value":{"Data":{"PeriodUpdateId":"5b0e7a52-3c1d-4f6e-9a8b-2d4c6e8f0a13"},"Errors":[],"Warnings":[{"Code":"PERIOD_UPDATE_CLASS_WARNING","Message":"Rollback this period update will also reverse the associated Retained Earning Distribution event"},{"Code":"PERIOD_UPDATE_ALREADY","Message":"Already Cancelling"}]},"key":"alreadyCancelling","summary":"Rollback already under way","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period update is already "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Nothing new is queued."},"children":[]}]}]}],"id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/200/content/application~1json/examples/alreadyCancelling"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial":{"value":{"Data":null,"Errors":[{"Code":"PERIOD_UPDATE_CANNOT_CANCEL_INITIAL","Message":"Cannot cancel a period update that has not started processing."}],"Warnings":[]},"key":"stillInitial","summary":"Period update has not finished processing","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/stillInitial"},"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive":{"value":{"Data":null,"Errors":[{"Code":"PERIOD_UPDATE_NOT_LAST_ACTIVE","Message":"Must be the last Active period to be Cancelled"}],"Warnings":[]},"key":"notLastActive","summary":"A later period update exists","id":"paths/~1f~1{businessCode}~1{fundCode}~1period-updates~1{periodUpdateId}/delete/responses/400/content/application~1json/examples/notLastActive"}},"securitySchemeStore":{"Class_oAuth":{"id":"Class_oAuth","type":"oauth2","description":"Class uses OAuth2 and OpenID for authentication and authorisation. The resource owner password credentials and authorization code flows are supported.","flows":{"password":{"tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}},"authorizationCode":{"authorizationUrl":"https://app.class-pie.com.au/connect/authorize","tokenUrl":"https://app.class-pie.com.au/connect/token","scopes":{"fund.details.read":"View basic fund details","fund.maintain":"View and maintain all fund information"}}}}},"specVersion":"3.2.0","servers":[{"url":"https://api.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://api.class.com.au/api/1.0","description":"Production Environment"}],"specType":"openapi"},"options":{"layout":"three-panel","hideSchemaTitles":true,"hideReplay":true,"hideInfoMetadata":true,"jsonSamplesExpandLevel":"all","mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/class/apis/partner/period-updates.json?download"},{"url":"/_bundle/products/class/apis/partner/period-updates.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Period Updates","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<div class=\"env-panel\" data-component-name=\"EnvPanel\"><div class=\"env-panel__header\">Servers</div><div class=\"env-panel__body\"><div class=\"env-row\"><div class=\"env-name\">Partner Integration Environment (Sandbox)</div><div class=\"env-url-row\"><span class=\"env-url\">https://api.class-pie.com.au/api/1.0</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://api.class-pie.com.au/api/1.0\" aria-label=\"Copy\"><svg viewBox=\"0 0 16 16\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z\" fill=\"currentColor\"/></svg></button></div></div><div class=\"env-row\"><div class=\"env-name\">Production Environment</div><div class=\"env-url-row\"><span class=\"env-url\">https://api.class.com.au/api/1.0</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://api.class.com.au/api/1.0\" aria-label=\"Copy\"><svg viewBox=\"0 0 16 16\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z\" fill=\"currentColor\"/></svg></button></div></div></div></div>","apiId":"Class Partner v1","tags":["Class Partner"]}},"baseSlug":"/products/class/apis/partner/period-updates","routesMapping":{},"apiId":"Class Partner v1"}