{"items":[{"type":"link","label":"Companies","link":"/products/nowinfinity/apis/partner/companies","routeSlug":"/products/nowinfinity/apis/partner/companies","content":{"contentType":"overview","meta":{"name":"Companies"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"companies.json","url":"/_bundle/products/nowinfinity/apis/partner/companies.json?download"},{"kind":"download","label":"companies.yaml","url":"/_bundle/products/nowinfinity/apis/partner/companies.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://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","description":"Production Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Companies (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$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":"Retrieve details of a company by its unique id or ACN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the documents held against a company."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query companies under the account using OData."},"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://partnerapi.nowinfinity-test.com.au/v1"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"button","attrs":{"type":"button","className":"copy-btn","data-copy":"https://partnerapi.nowinfinity-test.com.au/v1","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://partnerapi.nowinfinity.com.au/v1"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"button","attrs":{"type":"button","className":"copy-btn","data-copy":"https://partnerapi.nowinfinity.com.au/v1","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/nowinfinity/apis/partner/companies"}],"sectionId":"/products/nowinfinity/apis/partner/companies"}]}]}},{"type":"group","label":"Companies","link":"/products/nowinfinity/apis/partner/companies/companies","routeSlug":"/products/nowinfinity/apis/partner/companies/companies","items":[{"label":"Company details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/companies/companies/getcompany","routeSlug":"/products/nowinfinity/apis/partner/companies/companies/getcompany","metadata":{"seo":{"title":"Company details","description":"Returns details of the specified company, identified by either its unique id or its ACN."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCompany","name":"Company details","isWebhook":false,"pointer":"/paths/~1companies~1{companyIdOrAcn}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details of the specified company, identified by either its unique id or its ACN.\n\nCompanies with a status of Archived or De-Registered are not returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"NowInfinity_oAuth","scopes":["api1"],"type":"oauth2","description":"NowInfinity uses OAuth2 for authentication and authorisation.","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyIdOrAcn","in":"path","schemaId":"schema_1115","description":"Unique id or ACN of the company.","required":true,"example":"123456789"}],"pointer":"/paths/~1companies~1{companyIdOrAcn}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyIdOrAcn}","servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","description":"Production Environment"}],"parameters":{"path":[{"name":"companyIdOrAcn","in":"path","required":true,"example":"123456789","schemaId":"schema_1115"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"NowInfinity_oAuth","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}],"scopes":["api1"]}],"responseCodes":["200","404"],"pointer":"/companies/{companyIdOrAcn}","href":"companies/getcompany","openApiOperationId":"GetCompany","summary":"Company details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","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/Company"}},"schemaId":"components/schemas/Company"},{"code":"404","description":"A company with the specified Id or ACN cannot be found."}],"pointer":"/paths/~1companies~1{companyIdOrAcn}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Company"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/getcompany"}],"panels":[]}]},"httpPath":"/companies/{companyIdOrAcn}"},{"label":"Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/companies/companies/querycompanies","routeSlug":"/products/nowinfinity/apis/partner/companies/companies/querycompanies","metadata":{"seo":{"title":"Companies","description":"OData endpoint to query companies under the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QueryCompanies","name":"Companies","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"OData endpoint to query companies under the account.\n\nReturns companies that are active, under external administration, or de-registering.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"NowInfinity_oAuth","scopes":["api1"],"type":"oauth2","description":"NowInfinity uses OAuth2 for authentication and authorisation.","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"$expand","in":"query","schemaId":"schema_1115","description":"Expands related entities inline.","example":"Trustee"},{"name":"$filter","in":"query","schemaId":"schema_1115","description":"Filters the results, based on a Boolean condition.","example":"Status eq 'Active'"},{"name":"$select","in":"query","schemaId":"schema_1115","description":"Selects which properties to include in the response.","example":"Name,ABN,Status"},{"name":"$orderby","in":"query","schemaId":"schema_1115","description":"Sorts the results.","example":"CreatedDate desc"},{"name":"$top","in":"query","schemaId":"schema_1116","description":"Returns only the first n results.","example":25},{"name":"$skip","in":"query","schemaId":"schema_1116","description":"Skips the first n results.","example":0},{"name":"$count","in":"query","schemaId":"schema_1117","description":"Includes a count of the matching results in the response.","example":true}],"pointer":"/paths/~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"$expand","in":"query","required":false,"example":"Trustee","schemaId":"schema_1115"},{"name":"$filter","in":"query","required":false,"example":"Status eq 'Active'","schemaId":"schema_1115"},{"name":"$select","in":"query","required":false,"example":"Name,ABN,Status","schemaId":"schema_1115"},{"name":"$orderby","in":"query","required":false,"example":"CreatedDate desc","schemaId":"schema_1115"},{"name":"$top","in":"query","required":false,"example":25,"schemaId":"schema_1116"},{"name":"$skip","in":"query","required":false,"example":0,"schemaId":"schema_1116"},{"name":"$count","in":"query","required":false,"example":true,"schemaId":"schema_1117"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"NowInfinity_oAuth","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}],"scopes":["api1"]}],"responseCodes":["200"],"pointer":"/companies","href":"companies/querycompanies","openApiOperationId":"QueryCompanies","summary":"Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","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":"schema_1118"}},"schemaId":"schema_1118"}],"pointer":"/paths/~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1118"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/companies/querycompanies"}],"panels":[]}]},"httpPath":"/companies"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":"Companies held under the account, including officers, members and debt position."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyIdOrAcn}","summary":"Company details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/getcompany","deprecated":false},{"title":"/companies","summary":"Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/querycompanies","deprecated":false}]}]}]}]}},{"type":"group","label":"Company documents","link":"/products/nowinfinity/apis/partner/companies/company-documents","routeSlug":"/products/nowinfinity/apis/partner/companies/company-documents","items":[{"label":"Company documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/companies/company-documents/getcompanydocuments","routeSlug":"/products/nowinfinity/apis/partner/companies/company-documents/getcompanydocuments","metadata":{"seo":{"title":"Company documents","description":"Returns the documents held against the specified company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCompanyDocuments","name":"Company documents","isWebhook":false,"pointer":"/paths/~1companies~1{companyIdOrAcn}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the documents held against the specified company.\n\nThis endpoint supports OData query parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"NowInfinity_oAuth","scopes":["api1"],"type":"oauth2","description":"NowInfinity uses OAuth2 for authentication and authorisation.","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyIdOrAcn","in":"path","schemaId":"schema_1115","description":"Unique id or ACN of the company.","required":true,"example":"123456789"}],"pointer":"/paths/~1companies~1{companyIdOrAcn}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"$expand","in":"query","schemaId":"schema_1115","description":"Expands related entities inline.","example":"Trustee"},{"name":"$filter","in":"query","schemaId":"schema_1115","description":"Filters the results, based on a Boolean condition.","example":"Status eq 'Active'"},{"name":"$select","in":"query","schemaId":"schema_1115","description":"Selects which properties to include in the response.","example":"Name,ABN,Status"},{"name":"$orderby","in":"query","schemaId":"schema_1115","description":"Sorts the results.","example":"CreatedDate desc"},{"name":"$top","in":"query","schemaId":"schema_1116","description":"Returns only the first n results.","example":25},{"name":"$skip","in":"query","schemaId":"schema_1116","description":"Skips the first n results.","example":0},{"name":"$count","in":"query","schemaId":"schema_1117","description":"Includes a count of the matching results in the response.","example":true}],"pointer":"/paths/~1companies~1{companyIdOrAcn}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/{companyIdOrAcn}/documents","servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","description":"Production Environment"}],"parameters":{"path":[{"name":"companyIdOrAcn","in":"path","required":true,"example":"123456789","schemaId":"schema_1115"}],"query":[{"name":"$expand","in":"query","required":false,"example":"Trustee","schemaId":"schema_1115"},{"name":"$filter","in":"query","required":false,"example":"Status eq 'Active'","schemaId":"schema_1115"},{"name":"$select","in":"query","required":false,"example":"Name,ABN,Status","schemaId":"schema_1115"},{"name":"$orderby","in":"query","required":false,"example":"CreatedDate desc","schemaId":"schema_1115"},{"name":"$top","in":"query","required":false,"example":25,"schemaId":"schema_1116"},{"name":"$skip","in":"query","required":false,"example":0,"schemaId":"schema_1116"},{"name":"$count","in":"query","required":false,"example":true,"schemaId":"schema_1117"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"NowInfinity_oAuth","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}],"scopes":["api1"]}],"responseCodes":["200","404"],"pointer":"/companies/{companyIdOrAcn}/documents","href":"company-documents/getcompanydocuments","openApiOperationId":"GetCompanyDocuments","summary":"Company documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","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":"schema_1119"}},"schemaId":"schema_1119"},{"code":"404","description":"A company with the specified Id or ACN cannot be found."}],"pointer":"/paths/~1companies~1{companyIdOrAcn}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1119","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1119"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-documents/getcompanydocuments"}],"panels":[]}]},"httpPath":"/companies/{companyIdOrAcn}/documents"}],"content":{"contentType":"group","meta":{"name":"Company documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company documents","showPageActions":true},{"nodeType":"markdoc","content":"Documents lodged or held against a specific company."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies/{companyIdOrAcn}/documents","summary":"Company documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-documents/getcompanydocuments","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Company":{"id":"components/schemas/Company","kind":"json-schema","title":"Company","data":{"description":"A company held under the account.","type":"object","properties":{"CompanyId":{"type":"string","format":"uuid","example":"8f3c1b52-0d47-4a19-9c88-2ee6b7a14d90"},"Name":{"type":"string","example":"Harbourview Holdings Pty Ltd"},"CompanyType":{"type":"string","example":"Proprietary"},"ACN":{"type":"string","example":"123 456 789"},"ARBN":{"type":"string","example":"098 765 432"},"DebtDueNow":{"type":"number","format":"double","example":310},"DebtOverdue030":{"description":"Debt overdue by 0 to 30 days.","type":"number","format":"double","example":0},"DebtOverdue3160":{"description":"Debt overdue by 31 to 60 days.","type":"number","format":"double","example":0},"DebtOverdue6190":{"description":"Debt overdue by 61 to 90 days.","type":"number","format":"double","example":0},"DebtOverdue91":{"description":"Debt overdue by more than 90 days.","type":"number","format":"double","example":0},"TotalAmountOwing":{"type":"number","format":"double","example":310},"RegistrationDate":{"type":"string","format":"date-time","example":"2015-02-19T00:00:00Z"},"NextAnnualReviewDate":{"type":"string","format":"date-time","example":"2027-02-19T00:00:00Z"},"CreatedDate":{"type":"string","format":"date-time","example":"2015-02-19T06:21:40Z"},"ModifiedDate":{"type":"string","format":"date-time","example":"2026-07-16T23:05:44Z"},"RegisteredAddress":{"$ref":"#/components/schemas/Address"},"PrincipalAddress":{"$ref":"#/components/schemas/Address"},"SigningContact":{"$ref":"#/components/schemas/Individual"},"BillingContact":{"$ref":"#/components/schemas/Individual"},"Officers":{"type":"array","items":{"$ref":"#/components/schemas/Individual"}},"Members":{"$ref":"#/components/schemas/Members"},"Links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}}},"components/schemas/Members":{"id":"components/schemas/Members","kind":"json-schema","title":"Members","data":{"description":"The members of a company, split by party type.","type":"object","properties":{"Individuals":{"type":"array","items":{"$ref":"#/components/schemas/IndividualMember"}},"Corporates":{"type":"array","items":{"$ref":"#/components/schemas/CorporateBrief"}}}}},"components/schemas/IndividualMember":{"id":"components/schemas/IndividualMember","kind":"json-schema","title":"IndividualMember","data":{"type":"object","properties":{"FirstName":{"type":"string","example":"Sarah"},"MiddleName":{"type":"string","example":"Louise"},"LastName":{"type":"string","example":"Nguyen"},"DateOfBirth":{"type":"string","format":"date-time","example":"1978-03-14T00:00:00Z"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["Street","Suburb","State","PostCode"],"properties":{"CareOf":{"type":"string","example":"Level 3, Suite 2"},"Unit":{"type":"string","example":"12"},"Street":{"type":"string","example":"45 Macquarie Street"},"Suburb":{"type":"string","example":"Parramatta"},"State":{"type":"string","example":"NSW"},"PostCode":{"type":"string","example":"2150"},"Country":{"type":"string","example":"Australia"}}}},"components/schemas/Individual":{"id":"components/schemas/Individual","kind":"json-schema","title":"Individual","data":{"description":"Full details for an individual party.","type":"object","properties":{"FirstName":{"type":"string","example":"Sarah"},"MiddleName":{"type":"string","example":"Louise"},"LastName":{"type":"string","example":"Nguyen"},"PreferredName":{"type":"string","example":"Sarah"},"DateOfBirth":{"type":"string","format":"date-time","example":"1978-03-14T00:00:00Z"},"TFN":{"type":"string","example":"123456782"},"Phone":{"type":"string","example":"+61 2 9876 5432"},"Email":{"type":"string","example":"sarah.nguyen@example.com.au"},"Address":{"$ref":"#/components/schemas/Address"},"StateOrCountryOfBirth":{"type":"string","example":"NSW"},"SuburbOrCityOfBirth":{"type":"string","example":"Sydney"},"Title":{"type":"string","example":"Ms"},"Role":{"type":"string","enum":["NotSpecified","Director","Secretary","DirectorAndSecretary","AlternateDirector"],"example":"Director"},"DirectorId":{"type":"string","example":"036000001234"},"HasLegalCapacityToSign":{"type":"boolean","example":true}}}},"components/schemas/CorporateBrief":{"id":"components/schemas/CorporateBrief","kind":"json-schema","title":"CorporateBrief","data":{"description":"Summary details for a company party.","type":"object","properties":{"CompanyId":{"type":"string","format":"uuid","example":"8f3c1b52-0d47-4a19-9c88-2ee6b7a14d90"},"CompanyName":{"type":"string","example":"Harbourview Holdings Pty Ltd"},"ACN":{"type":"string","example":"123 456 789"},"Address":{"$ref":"#/components/schemas/Address"},"Directors":{"type":"array","items":{"$ref":"#/components/schemas/Individual"}},"Secretaries":{"type":"array","items":{"$ref":"#/components/schemas/Individual"}},"AuthorisedPersons":{"type":"array","items":{"$ref":"#/components/schemas/IndividualReference"}}}}},"components/schemas/IndividualReference":{"id":"components/schemas/IndividualReference","kind":"json-schema","title":"IndividualReference","data":{"description":"A minimal reference to an individual already known to NowInfinity.","type":"object","required":["FirstName","LastName"],"properties":{"FirstName":{"type":"string","example":"Sarah"},"MiddleName":{"type":"string","example":"Louise"},"LastName":{"type":"string","example":"Nguyen"},"DateOfBirth":{"type":"string","format":"date-time","example":"1978-03-14T00:00:00Z"}}}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"description":"A related action or resource available for this record.","type":"object","properties":{"Rel":{"type":"string","example":"documents"},"Href":{"type":"string","example":"/companies/123456789/documents"},"Action":{"type":"string","example":"GET"},"MediaType":{"type":"string","example":"application/json"}}}},"components/schemas/DocumentInfo":{"id":"components/schemas/DocumentInfo","kind":"json-schema","title":"DocumentInfo","data":{"description":"Summary information for a document held against the account.","type":"object","properties":{"DocumentId":{"type":"string","format":"uuid","example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34"},"DocumentName":{"type":"string","example":"Change of registered office"},"ReferenceNumber":{"type":"string","example":"NI-484A1-004822"},"AccountId":{"type":"string","format":"uuid","example":"2d81c6f0-9a34-4e57-b0c2-6f1e8d3a5b47"},"ContactId":{"type":"string","format":"uuid","example":"9e5b3d81-7c26-4a09-8f14-0b7d2e6c9a58"},"CreatedOn":{"type":"string","format":"date-time","example":"2026-07-14T02:31:08Z"},"LastModifiedOn":{"type":"string","format":"date-time","example":"2026-07-16T23:05:44Z"},"FormName":{"type":"string","example":"ASIC Form 484"},"FormTypeCode":{"type":"string","example":"484"},"DocumentStatus":{"type":"string","enum":["Signed","WaitingForSignature","Draft","AwaitingPayment","Processing","ASICRejected","SeeASICStatus","Delivered","ASICCorrectionRequested","AwaitingScorpio"],"example":"Delivered"},"SigningStatus":{"type":"string","enum":["Sent","Rejected","Completed"],"example":"Completed"},"LegalReviewStatus":{"type":"string","enum":["Draft","StrategyMeeting","DocumentsReview","ReviewMeeting","DocumentFinalisation","ClientSigning","Complete","Pending","InformationRequested","CorrectionRequested","PendingFinalReview","Cancelled","Approved"],"example":"Complete"},"AsicStatus":{"type":"string","enum":["None","WaitingForSignature","Pending","Transmitted","Lodged","ValidationError","OnHold","Rejected","Registered","AdminProcessing","Signed","FutureLodgement"],"example":"Lodged"},"AsicDocumentNumber":{"type":"string","example":"7EAB12345"},"AsicTraceNumber":{"type":"string","example":"048812345678"},"RelatedCompanyId":{"type":"string","format":"uuid","example":"8f3c1b52-0d47-4a19-9c88-2ee6b7a14d90"},"RelatedCompanyName":{"type":"string","example":"Harbourview Holdings Pty Ltd"},"RelatedTrustId":{"type":"string","format":"uuid","example":"6a0e4b73-1d58-4c92-a37f-5e8b1c0d92a6"},"RelatedTrustName":{"type":"string","example":"Nguyen Family Trust"},"RelatedSmsfFundId":{"type":"string","format":"uuid","example":"b3f7d201-8e46-4a15-9c73-2d0a6f4e8b19"},"RelatedSmsfFundName":{"type":"string","example":"Nguyen Family Superannuation Fund"},"Links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}}},"schema_1115":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1115"},"schema_1116":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_1116"},"schema_1117":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1117"},"schema_1118":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"id":"schema_1118"},"schema_1119":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentInfo"}},"id":"schema_1119"}},"exampleStore":{},"securitySchemeStore":{"NowInfinity_oAuth":{"id":"NowInfinity_oAuth","type":"oauth2","description":"NowInfinity uses OAuth2 for authentication and authorisation.","flows":{"implicit":{"authorizationUrl":"https://auth.nowinfinity-test.com.au/connect/authorize","scopes":{"api1":"Web API access","reporting":"Reporting"}}}}},"servers":[{"url":"https://partnerapi.nowinfinity-test.com.au/v1","description":"Partner Integration Environment (Sandbox)"},{"url":"https://partnerapi.nowinfinity.com.au/v1","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/nowinfinity/apis/partner/companies.json?download"},{"url":"/_bundle/products/nowinfinity/apis/partner/companies.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Companies","description":"- Retrieve details of a company by its unique id or ACN.\n- List the documents held against a company.\n- Query companies under the account using OData.\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://partnerapi.nowinfinity-test.com.au/v1</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://partnerapi.nowinfinity-test.com.au/v1\" 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://partnerapi.nowinfinity.com.au/v1</span><button type=\"button\" class=\"copy-btn\" data-copy=\"https://partnerapi.nowinfinity.com.au/v1\" 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":"NowInfinity Partner v1","tags":["NowInfinity Partner"]}},"baseSlug":"/products/nowinfinity/apis/partner/companies","routesMapping":{},"apiId":"NowInfinity Partner v1"}