{"items":[{"type":"link","label":"Tax Lodgment Status","link":"/products/class/apis/partner/tax-lodgment","routeSlug":"/products/class/apis/partner/tax-lodgment","content":{"contentType":"overview","meta":{"name":"Tax Lodgment Status"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"tax-lodgment.json","url":"/_bundle/products/class/apis/partner/tax-lodgment.json?download"},{"kind":"download","label":"tax-lodgment.yaml","url":"/_bundle/products/class/apis/partner/tax-lodgment.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Class Partners","email":"partners@class.com.au","label":"partners@class.com.au","withCopyButton":true,"copyContent":"partners@class.com.au"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.class.com.au/api-terms"}]},{"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://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Tax Lodgment Status (1.0.0001)","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":"The Tax Lodgment Status API endpoints - temporary documentation as we transition these endpoints over to to our new API environment. The new developer portal will replace this documentation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that you use the new BASE url apigateway.class.com.au"},"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://apigateway.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://apigateway.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://apigateway.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://apigateway.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":"/products/class/apis/partner/tax-lodgment"}],"sectionId":"/products/class/apis/partner/tax-lodgment"}]}]}},{"type":"group","label":"Business","link":"/products/class/apis/partner/tax-lodgment/business","routeSlug":"/products/class/apis/partner/tax-lodgment/business","items":[{"label":"Tax lodgment status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatus","routeSlug":"/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatus","metadata":{"seo":{"title":"Tax lodgment status","description":"Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetBusinessTaxLodgementStatus","name":"Tax lodgment status","isWebhook":false,"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entityType","in":"query","schemaId":"schema_1043","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we only support "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMSF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will update the additional entities when they become available in the future"},"children":[]}]}]}],"required":true},{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"},{"name":"financialYear","in":"query","schemaId":"schema_1045","description":"Financial Year For The Tax Lodgment"},{"name":"includeSuspended","in":"query","schemaId":"schema_1046","description":"Indicates whether to include suspended entities in the results."}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b/{businessCode}/tax-lodgments/status","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"}],"query":[{"name":"entityType","in":"query","required":true,"example":"SMSF","schemaId":"schema_1043"},{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"},{"name":"financialYear","in":"query","required":false,"schemaId":"schema_1045"},{"name":"includeSuspended","in":"query","required":false,"example":true,"schemaId":"schema_1046"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/b/{businessCode}/tax-lodgments/status","href":"business/getbusinesstaxlodgementstatus","openApiOperationId":"GetBusinessTaxLodgementStatus","summary":"Tax lodgment status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.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/BusinessTaxLodgmentStatusResponse"}},"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1047"}},"schemaId":"schema_1047"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource Not Available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"}}},{"code":"400","schemaId":"schema_1047","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1047"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business/getbusinesstaxlodgementstatus"}],"panels":[]}]},"httpPath":"/b/{businessCode}/tax-lodgments/status"},{"label":"Tax lodgment status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatus","routeSlug":"/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatus","metadata":{"seo":{"title":"Tax lodgment status","description":"Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostBusinessTaxLodgementStatus","name":"Tax lodgment status","isWebhook":false,"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"},{"name":"financialYear","in":"query","schemaId":"schema_1045","description":"Financial Year For The Tax Lodgment"},{"name":"entityType","in":"query","schemaId":"schema_1043","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we only support "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMSF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will update the additional entities when they become available in the future\""},"children":[]}]}]}],"required":true},{"name":"includeSuspended","in":"query","schemaId":"schema_1046","description":"Indicates whether to include suspended entities in the results."}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"schemaId":"components/schemas/TaxLodgmentPostRequest","pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/b/{businessCode}/tax-lodgments/status","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"}],"query":[{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"},{"name":"financialYear","in":"query","required":false,"schemaId":"schema_1045"},{"name":"entityType","in":"query","required":true,"example":"SMSF","schemaId":"schema_1043"},{"name":"includeSuspended","in":"query","required":false,"example":true,"schemaId":"schema_1046"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/b/{businessCode}/tax-lodgments/status","href":"business/postbusinesstaxlodgementstatus","openApiOperationId":"PostBusinessTaxLodgementStatus","summary":"Tax lodgment status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"schemaId":"components/schemas/TaxLodgmentPostRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"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/BusinessTaxLodgmentStatusResponse"}},"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1047"}},"schemaId":"schema_1047"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource Not Available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"}}},{"code":"400","schemaId":"schema_1047","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1047"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business/postbusinesstaxlodgementstatus"}],"panels":[]}]},"httpPath":"/b/{businessCode}/tax-lodgments/status"},{"label":"Tax lodgment status history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatushistory","routeSlug":"/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatushistory","metadata":{"seo":{"title":"Tax lodgment status history","description":"Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetBusinessTaxLodgementStatusHistory","name":"Tax lodgment status history","isWebhook":false,"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entityType","in":"query","schemaId":"schema_1043","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we only support "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMSF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will update the additional entities when they become available in the future"},"children":[]}]}]}],"required":true},{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"},{"name":"fromFinancialYear","in":"query","schemaId":"schema_1045","description":"From Financial Year For The Tax Lodgment","required":true},{"name":"toFinancialYear","in":"query","schemaId":"schema_1045","description":"To Financial Year For The Tax Lodgment.","required":true},{"name":"includeSuspended","in":"query","schemaId":"schema_1046","description":"Indicates whether to include suspended entities in the results."}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b/{businessCode}/tax-lodgments/history","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"}],"query":[{"name":"entityType","in":"query","required":true,"example":"SMSF","schemaId":"schema_1043"},{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"},{"name":"fromFinancialYear","in":"query","required":true,"schemaId":"schema_1045"},{"name":"toFinancialYear","in":"query","required":true,"schemaId":"schema_1045"},{"name":"includeSuspended","in":"query","required":false,"example":true,"schemaId":"schema_1046"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/b/{businessCode}/tax-lodgments/history","href":"business/getbusinesstaxlodgementstatushistory","openApiOperationId":"GetBusinessTaxLodgementStatusHistory","summary":"Tax lodgment status history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.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/BusinessTaxLodgmentStatusResponse"}},"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1052"}},"schemaId":"schema_1052"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource Not Available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"}}},{"code":"400","schemaId":"schema_1052","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1052"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business/getbusinesstaxlodgementstatushistory"}],"panels":[]}]},"httpPath":"/b/{businessCode}/tax-lodgments/history"},{"label":"Tax lodgment status history","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatushistory","routeSlug":"/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatushistory","metadata":{"seo":{"title":"Tax lodgment status history","description":"Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostBusinessTaxLodgementStatusHistory","name":"Tax lodgment status history","isWebhook":false,"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"},{"name":"fromFinancialYear","in":"query","schemaId":"schema_1045","description":"From Financial Year For The Tax Lodgment","required":true},{"name":"toFinancialYear","in":"query","schemaId":"schema_1045","description":"To Financial Year For The Tax Lodgment.","required":true},{"name":"entityType","in":"query","schemaId":"schema_1043","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we only support "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMSF"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we will update the additional entities when they become available in the future\""},"children":[]}]}]}],"required":true},{"name":"includeSuspended","in":"query","schemaId":"schema_1046","description":"Indicates whether to include suspended entities in the results."}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"schemaId":"components/schemas/TaxLodgmentPostRequest","pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/b/{businessCode}/tax-lodgments/history","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"}],"query":[{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"},{"name":"fromFinancialYear","in":"query","required":true,"schemaId":"schema_1045"},{"name":"toFinancialYear","in":"query","required":true,"schemaId":"schema_1045"},{"name":"entityType","in":"query","required":true,"example":"SMSF","schemaId":"schema_1043"},{"name":"includeSuspended","in":"query","required":false,"example":true,"schemaId":"schema_1046"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/b/{businessCode}/tax-lodgments/history","href":"business/postbusinesstaxlodgementstatushistory","openApiOperationId":"PostBusinessTaxLodgementStatusHistory","summary":"Tax lodgment status history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"schemaId":"components/schemas/TaxLodgmentPostRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxLodgmentPostRequest"}},"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/BusinessTaxLodgmentStatusResponse"}},"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053"}},"schemaId":"schema_1053"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource Not Available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1b~1{businessCode}~1tax-lodgments~1history/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessTaxLodgmentStatusResponse"}}},{"code":"400","schemaId":"schema_1053","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1053"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business/postbusinesstaxlodgementstatushistory"}],"panels":[]}]},"httpPath":"/b/{businessCode}/tax-lodgments/history"}],"content":{"contentType":"group","meta":{"name":"Business"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business","showPageActions":true},{"nodeType":"markdoc","content":"Ability to obtain the tax lodgment status at a business level, either for a particular year or for a range of years. Allows you to filter by a specific status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/b/{businessCode}/tax-lodgments/status","summary":"Tax lodgment status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business/getbusinesstaxlodgementstatus","deprecated":false},{"title":"/b/{businessCode}/tax-lodgments/status","summary":"Tax lodgment status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business/postbusinesstaxlodgementstatus","deprecated":false},{"title":"/b/{businessCode}/tax-lodgments/history","summary":"Tax lodgment status history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business/getbusinesstaxlodgementstatushistory","deprecated":false},{"title":"/b/{businessCode}/tax-lodgments/history","summary":"Tax lodgment status history","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business/postbusinesstaxlodgementstatushistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Fund","link":"/products/class/apis/partner/tax-lodgment/fund","routeSlug":"/products/class/apis/partner/tax-lodgment/fund","items":[{"label":"Tax lodgment status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatus","routeSlug":"/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatus","metadata":{"seo":{"title":"Tax lodgment status","description":"Returns the tax lodgement status for a fund for a specific financial year. It also returns the latest period update and latest year lodged for the fund. Lodgement status include tax agent, lodgement date, amount due or refundable and audit date if available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaxLodgmentStatus","name":"Tax lodgment status","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tax lodgement status for a fund for a specific financial year. It also returns the latest period update and latest year lodged for the fund. Lodgement status include tax agent, lodgement date, amount due or refundable and audit date if available.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1054","description":"Class entity code","required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1status/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"financialYear","in":"query","schemaId":"schema_1045","description":"Financial Year For The Tax Lodgment"},{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/f/{businessCode}/{fundCode}/tax-lodgments/status","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1054"}],"query":[{"name":"financialYear","in":"query","required":false,"schemaId":"schema_1045"},{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/tax-lodgments/status","href":"fund/gettaxlodgmentstatus","openApiOperationId":"getTaxLodgmentStatus","summary":"Tax lodgment status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.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/TaxLodgmentStatusGetResponse"}},"schemaId":"components/schemas/TaxLodgmentStatusGetResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1055"}},"schemaId":"schema_1055"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource not available or user does not have access to the fund","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxLodgmentStatusGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxLodgmentStatusGetResponse"}}},{"code":"400","schemaId":"schema_1055","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1055"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/gettaxlodgmentstatus"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/tax-lodgments/status"},{"label":"Tax lodgment status history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatushistory","routeSlug":"/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatushistory","metadata":{"seo":{"title":"Tax lodgment status history","description":"Returns the tax lodgment status for a fund for a range of financial years. It also returns the latest period update and latest year lodged for the fund. Lodgment status include tax agent, lodgment date, amount due or refundable and audit date if available. History is provided from latest year through to earlier years."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaxLodgmentStatusHistory","name":"Tax lodgment status history","isWebhook":false,"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax lodgment status history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tax lodgment status for a fund for a range of financial years. It also returns the latest period update and latest year lodged for the fund. Lodgment status include tax agent, lodgment date, amount due or refundable and audit date if available. History is provided from latest year through to earlier years.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Class_oAuth","scopes":["fund.read"],"type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessCode","in":"path","schemaId":"schema_1042","description":"Class business code","required":true},{"name":"fundCode","in":"path","schemaId":"schema_1054","description":"Class entity code","required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_1044","description":"Tax lodgment status recevied for the financial year"},{"name":"fromFinancialYear","in":"query","schemaId":"schema_1045","description":"From Financial Year For The Tax Lodgment","required":true},{"name":"toFinancialYear","in":"query","schemaId":"schema_1045","description":"To Financial Year For The Tax Lodgment.","required":true}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/f/{businessCode}/{fundCode}/tax-lodgments/history","servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}],"parameters":{"path":[{"name":"businessCode","in":"path","required":true,"example":"demo-business","schemaId":"schema_1042"},{"name":"fundCode","in":"path","required":true,"example":"demo-fund","schemaId":"schema_1054"}],"query":[{"name":"status","in":"query","required":false,"example":"SubmittedToTaxAgent","schemaId":"schema_1044"},{"name":"fromFinancialYear","in":"query","required":true,"schemaId":"schema_1045"},{"name":"toFinancialYear","in":"query","required":true,"schemaId":"schema_1045"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Class_oAuth","type":"oAuth2","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}],"scopes":["fund.read"]}],"responseCodes":["200","400","401","403","404","500","default"],"pointer":"/f/{businessCode}/{fundCode}/tax-lodgments/history","href":"fund/gettaxlodgmentstatushistory","openApiOperationId":"getTaxLodgmentStatusHistory","summary":"Tax lodgment status history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.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/TaxLodgmentStatusGetResponse"}},"schemaId":"components/schemas/TaxLodgmentStatusGetResponse"},{"code":"400","description":"Error Message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1056"}},"schemaId":"schema_1056"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}},"schemaId":"schema_1048"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}},"schemaId":"schema_1049"},{"code":"404","description":"Resource not available or user does not have access to the fund","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}},"schemaId":"schema_1050"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}},"schemaId":"schema_1051"}],"pointer":"/paths/~1f~1{businessCode}~1{fundCode}~1tax-lodgments~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxLodgmentStatusGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxLodgmentStatusGetResponse"}}},{"code":"400","schemaId":"schema_1056","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1056"}}},{"code":"401","schemaId":"schema_1048","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1048"}}},{"code":"403","schemaId":"schema_1049","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1049"}}},{"code":"404","schemaId":"schema_1050","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1050"}}},{"code":"500","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}},{"code":"default","schemaId":"schema_1051","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1051"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund/gettaxlodgmentstatushistory"}],"panels":[]}]},"httpPath":"/f/{businessCode}/{fundCode}/tax-lodgments/history"}],"content":{"contentType":"group","meta":{"name":"Fund"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund","showPageActions":true},{"nodeType":"markdoc","content":"Ability to obtain the tax lodgment status at a fund level, either for a particular year or for a range of years. Allows you to filter by a specific status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/f/{businessCode}/{fundCode}/tax-lodgments/status","summary":"Tax lodgment status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund/gettaxlodgmentstatus","deprecated":false},{"title":"/f/{businessCode}/{fundCode}/tax-lodgments/history","summary":"Tax lodgment status history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund/gettaxlodgmentstatushistory","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"type":"object","properties":{"Code":{"type":"string","nullable":true,"description":"Error code identifying the type of error.","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","nullable":true,"description":"Human-readable description of the error.","example":"An error occurred while processing your request."}},"additionalProperties":false}},"components/schemas/TaxLodgmentStatus_ParamError":{"id":"components/schemas/TaxLodgmentStatus_ParamError","kind":"json-schema","title":"TaxLodgmentStatus_ParamError","data":{"anyOf":[{"$ref":"#/components/schemas/FinancialYearError"},{"$ref":"#/components/schemas/StatusError"}]}},"components/schemas/TaxLodgmentHistory_ParamError":{"id":"components/schemas/TaxLodgmentHistory_ParamError","kind":"json-schema","title":"TaxLodgmentHistory_ParamError","data":{"anyOf":[{"$ref":"#/components/schemas/FromFinancialYearError"},{"$ref":"#/components/schemas/FinancialYearNonZeroError"}]}},"components/schemas/BusinessTaxLodgmentStatus_ParamError":{"id":"components/schemas/BusinessTaxLodgmentStatus_ParamError","kind":"json-schema","title":"BusinessTaxLodgmentStatus_ParamError","data":{"anyOf":[{"$ref":"#/components/schemas/FromFinancialYearError"},{"$ref":"#/components/schemas/RequiredEntityTypeError"},{"$ref":"#/components/schemas/StatusError"}]}},"components/schemas/BusinessTaxLodgmentHistory_ParamError":{"id":"components/schemas/BusinessTaxLodgmentHistory_ParamError","kind":"json-schema","title":"BusinessTaxLodgmentHistory_ParamError","data":{"anyOf":[{"$ref":"#/components/schemas/FromFinancialYearError"},{"$ref":"#/components/schemas/RequiredEntityTypeError"},{"$ref":"#/components/schemas/StatusError"}]}},"components/schemas/StatusError":{"id":"components/schemas/StatusError","kind":"json-schema","title":"StatusError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"Invalid tax lodgement 'status'"}}}},"components/schemas/RequiredEntityTypeError":{"id":"components/schemas/RequiredEntityTypeError","kind":"json-schema","title":"RequiredEntityTypeError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"Legal entity type must be provided."}}}},"components/schemas/FinancialYearError":{"id":"components/schemas/FinancialYearError","kind":"json-schema","title":"FinancialYearError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"'financialYear' must be greater than 0."}}}},"components/schemas/RequiredFinancialYearError":{"id":"components/schemas/RequiredFinancialYearError","kind":"json-schema","title":"RequiredFinancialYearError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"'fromFinancialYear' and 'toFinancialYear' must be   provided."}}}},"components/schemas/FromFinancialYearError":{"id":"components/schemas/FromFinancialYearError","kind":"json-schema","title":"FromFinancialYearError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"'fromFinancialYear' must be earlier than   'toFinancialYear'."}}}},"components/schemas/FinancialYearNonZeroError":{"id":"components/schemas/FinancialYearNonZeroError","kind":"json-schema","title":"FinancialYearNonZeroError","data":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"'fromFinancialYear' and 'toFinancialYear' must be   greater than 0"}}}},"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"}},"xml":{"name":"Error","wrapped":false}}},"components/schemas/InternalErrorCommon":{"id":"components/schemas/InternalErrorCommon","kind":"json-schema","title":"InternalErrorCommon","data":{"type":"object","properties":{"Code":{"type":"string","example":"INTERNAL_SERVER_ERROR"},"Message":{"type":"string","example":"An unexpected error occurred on the server. Please   try again later."}},"xml":{"name":"Error"}}},"components/schemas/ForbiddenErrorCommon":{"id":"components/schemas/ForbiddenErrorCommon","kind":"json-schema","title":"ForbiddenErrorCommon","data":{"type":"object","properties":{"Code":{"type":"string","example":"FORBIDDEN"},"Message":{"type":"string","example":"You do not have permission to access this resource  ."}},"xml":{"name":"Error"}}},"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."}},"xml":{"name":"Error"}}},"components/schemas/TaxLodgmentPostRequest":{"id":"components/schemas/TaxLodgmentPostRequest","kind":"json-schema","title":"TaxLodgmentPostRequest","data":{"type":"object","properties":{"brands":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of brand codes to filter by.","example":["BRAND_VANGUARD","BRAND_BLACKROCK","BRAND_FIDELITY"]},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of tag codes to filter by.","example":["FY2023","FY2024","FY2025"]},"whiteLabels":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of white label codes to filter by.","example":["WL_AUS_INVEST_01","WL_GLOBAL_GROWTH_02","WL_TAX_EFFICIENT_03"]},"entityType":{"type":"string","nullable":true,"description":"Legal entity type to filter by.","example":"SMSF"},"includeSuspended":{"type":"boolean","nullable":true,"description":"Whether to include suspended entities.","example":true}},"additionalProperties":false}},"components/schemas/BusinessTaxLodgmentStatusResponse":{"id":"components/schemas/BusinessTaxLodgmentStatusResponse","kind":"json-schema","title":"BusinessTaxLodgmentStatusResponse","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"},"nullable":true,"readOnly":true,"description":"List of errors, if any."},"Data":{"$ref":"#/components/schemas/BusinessTaxLodgmentStatus","description":"Business tax lodgment status data."}},"xml":{"name":"taxLodgementStatus xmlns:xsd=\"http://www.w3.org/2001  /XMLSchema\"","wrapped":false}}},"components/schemas/BusinessTaxLodgmentStatus":{"id":"components/schemas/BusinessTaxLodgmentStatus","kind":"json-schema","title":"BusinessTaxLodgmentStatus","data":{"type":"object","properties":{"total":{"type":"number","nullable":false,"description":"Total number of records returned.","example":2},"pageSize":{"type":"number","nullable":false,"description":"Number of records per page.","example":500},"pageNumber":{"type":"number","nullable":false,"description":"Current page number.","example":1},"totalPages":{"type":"number","nullable":false,"description":"Total number of pages available.","example":1},"funds":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/FundOne"},{"$ref":"#/components/schemas/Fund"}]},"nullable":false,"description":"List of funds with their tax lodgment status."}}}},"components/schemas/Fund":{"id":"components/schemas/Fund","kind":"json-schema","title":"Fund","data":{"type":"object","properties":{"entityCode":{"type":"string","nullable":true,"description":"Unique code identifying the entity.","example":"demo-fund"},"entityName":{"type":"string","nullable":true,"description":"Name of the entity.","example":"DEMO_SMSF_2024"},"legalType":{"type":"string","nullable":true,"description":"Legal type of the entity.","example":"SMSF"},"status":{"type":"string","nullable":true,"description":"Current status of the entity.","example":"Active"},"latestPeriodUpdate":{"type":"string","nullable":true,"description":"Date of the latest period update.","example":"30/06/2024"},"latestYearLodged":{"type":"integer","nullable":true,"description":"Most recent financial year lodged.","example":2024},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of tags associated with the fund.","example":["FY2023","FY2024","FY2025"]},"financialYears":{"type":"array","items":{"type":"integer"},"nullable":true,"description":"List of financial years with lodgment data.","example":[]}}}},"components/schemas/FundOne":{"id":"components/schemas/FundOne","kind":"json-schema","title":"FundOne","data":{"type":"object","properties":{"entityCode":{"type":"string","nullable":true,"description":"Unique code identifying the entity.","example":"001_ABC"},"entityName":{"type":"string","nullable":true,"description":"Name of the entity.","example":"Acme Super Fund"},"legalType":{"type":"string","nullable":true,"description":"Legal type of the entity.","example":"SMSF"},"status":{"type":"string","nullable":true,"description":"Current status of the entity.","example":"Active"},"latestPeriodUpdate":{"type":"string","nullable":true,"description":"Date of the latest period update.","example":"31/03/2023"},"latestYearLodged":{"type":"integer","nullable":true,"description":"Most recent financial year lodged.","example":2022},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of tags associated with the fund.","example":["FY2023","FY2024","FY2025"]},"financialYears":{"type":"array","items":{"type":"integer"},"nullable":true,"description":"List of financial years with lodgment data.","example":[]}}}},"components/schemas/FinancialYear":{"id":"components/schemas/FinancialYear","kind":"json-schema","title":"FinancialYear","data":{"type":"object","properties":{"year":{"type":"integer","description":"The financial year.","example":2023},"lodgments":{"type":"array","items":{"$ref":"#/components/schemas/Lodgment"},"nullable":true,"description":"List of lodgment records for the financial year."}},"additionalProperties":false}},"components/schemas/TaxLodgmentStatusGetResponse":{"id":"components/schemas/TaxLodgmentStatusGetResponse","kind":"json-schema","title":"TaxLodgmentStatusGetResponse","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"},"nullable":true,"readOnly":true,"description":"List of errors, if any."},"Data":{"$ref":"#/components/schemas/TaxLodgmentStatus","description":"Tax lodgment status data for the fund."}},"xml":{"name":"taxLodgementStatus xmlns:xsd=\"http://www.w3.org/2001  /XMLSchema\"","wrapped":false}}},"components/schemas/TaxLodgmentStatus":{"id":"components/schemas/TaxLodgmentStatus","kind":"json-schema","title":"TaxLodgmentStatus","data":{"type":"object","properties":{"entityCode":{"type":"string","nullable":true,"description":"Unique code identifying the entity.","example":"demo-fund"},"entityName":{"type":"string","nullable":true,"description":"Name of the entity.","example":"DEMO_SMSF_2024"},"legalType":{"type":"string","nullable":true,"description":"Legal type of the entity.","example":"SMSF"},"status":{"type":"string","nullable":true,"description":"Current status of the entity.","example":"Active"},"latestPeriodUpdate":{"type":"string","nullable":true,"description":"Date of the latest period update.","example":"30/06/2024"},"latestYearLodged":{"type":"integer","format":"int32","nullable":true,"description":"Most recent financial year lodged.","example":2023},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of tags associated with the fund.","example":["FY2025","FY2024","TAX2024","SMSF Tag"]},"financialYears":{"type":"array","items":{"$ref":"#/components/schemas/FinancialYear"},"nullable":false,"description":"List of financial years with their lodgment details."}},"additionalProperties":false}},"components/schemas/Lodgment":{"id":"components/schemas/Lodgment","kind":"json-schema","title":"Lodgment","data":{"type":"object","properties":{"lodgmentStatus":{"type":"string","nullable":true,"description":"Current status of the tax lodgment.","example":"LodgmentSucceeded"},"taxAgent":{"type":"string","nullable":true,"description":"Name of the tax agent handling the lodgment.","example":"Mr Bob Johnson"},"transmissionId":{"type":"string","nullable":true,"description":"Unique transmission identifier for the lodgment.","example":"KGYLX3GOFCMF5KWR"},"amountDue":{"type":"number","format":"double","nullable":true,"description":"Amount due or refundable for the lodgment.","example":-3203.87},"lodgmentDate":{"type":"string","nullable":true,"description":"Date when the lodgment was submitted.","example":"18/04/2024"},"auditDate":{"type":"string","nullable":true,"description":"Date of the audit, if applicable.","example":"31/05/2023"}}}},"schema_1042":{"kind":"json-schema","data":{"type":"string","example":"demo-business"},"id":"schema_1042"},"schema_1043":{"kind":"json-schema","data":{"type":"string","example":"SMSF"},"id":"schema_1043"},"schema_1044":{"kind":"json-schema","data":{"type":"string","enum":["NotSubmitted","SubmittedToTaxAgent","SubmittedToATO","LodgmentSucceeded","LodgmentFailed","RejectedByAgent","None"],"example":"SubmittedToTaxAgent"},"id":"schema_1044"},"schema_1045":{"kind":"json-schema","data":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"id":"schema_1045"},"schema_1046":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_1046"},"schema_1047":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/BusinessTaxLodgmentStatus_ParamError"}}}},"id":"schema_1047"},"schema_1048":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/UnauthorizedErrorCommon"}}}},"id":"schema_1048"},"schema_1049":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ForbiddenErrorCommon"}}}},"id":"schema_1049"},"schema_1050":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ResourceUnavailableErrorCommon"}}}},"id":"schema_1050"},"schema_1051":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/InternalErrorCommon"}}}},"id":"schema_1051"},"schema_1052":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/BusinessTaxLodgmentHistory_ParamError"}}}},"id":"schema_1052"},"schema_1053":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"type":"object","properties":{"Code":{"type":"string","example":"API_INVALID_PARAMETER"},"Message":{"type":"string","example":"EntityType provided in both URL and body with different values."}}}}}},"id":"schema_1053"},"schema_1054":{"kind":"json-schema","data":{"type":"string","example":"demo-fund"},"id":"schema_1054"},"schema_1055":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/TaxLodgmentStatus_ParamError"}}}},"id":"schema_1055"},"schema_1056":{"kind":"json-schema","data":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/TaxLodgmentHistory_ParamError"}}}},"id":"schema_1056"}},"exampleStore":{},"securitySchemeStore":{"Class_oAuth":{"id":"Class_oAuth","type":"oAuth2","description":"Class uses oAuth2 and OpenID for authentication and authorisation","flows":{"authorizationCode":{"authorizationUrl":"https://apigateway.class-pie.com.au/connect/authorize","tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}},"password":{"tokenUrl":"https://apigateway.class-pie.com.au/connect/token","scopes":{"fund.read":"View all fund information","fund.maintain":"View and maintain all fund information"}}}}},"servers":[{"url":"https://apigateway.class-pie.com.au/api/1.0","description":"Partner Integration Environment (Sandbox)"},{"url":"https://apigateway.class.com.au/api/1.0","description":"Production Environment"}]},"options":{"layout":"three-panel","hideSchemaTitles":true,"hideReplay":true,"hideInfoMetadata":true,"jsonSamplesExpandLevel":"all","hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/class/apis/partner/tax-lodgment.json?download"},{"url":"/_bundle/products/class/apis/partner/tax-lodgment.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Tax Lodgment Status","description":"The Tax Lodgment Status API endpoints - temporary documentation as we transition these endpoints over to to our new API environment. The new developer portal will replace this documentation.\nEnsure that you use the new BASE url apigateway.class.com.au\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://apigateway.class-pie.com.au/api/1.0</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://apigateway.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://apigateway.class.com.au/api/1.0</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://apigateway.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>","tags":["Class Partner"]}},"baseSlug":"/products/class/apis/partner/tax-lodgment","routesMapping":{}}