{"items":[{"type":"link","label":"Documents","link":"/products/nowinfinity/apis/partner/documents","routeSlug":"/products/nowinfinity/apis/partner/documents","content":{"contentType":"overview","meta":{"name":"Documents"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"documents.json","url":"/_bundle/products/nowinfinity/apis/partner/documents.json?download"},{"kind":"download","label":"documents.yaml","url":"/_bundle/products/nowinfinity/apis/partner/documents.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":"Documents (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 summary information for a document."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List and download the files generated for a document."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query documents 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/documents"}],"sectionId":"/products/nowinfinity/apis/partner/documents"}]}]}},{"type":"group","label":"Documents","link":"/products/nowinfinity/apis/partner/documents/documents","routeSlug":"/products/nowinfinity/apis/partner/documents/documents","items":[{"label":"Document details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/documents/documents/getdocument","routeSlug":"/products/nowinfinity/apis/partner/documents/documents/getdocument","metadata":{"seo":{"title":"Document details","description":"Returns summary information for the specified document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDocument","name":"Document details","isWebhook":false,"pointer":"/paths/~1documents~1{documentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns summary information for the specified document.\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":"documentId","in":"path","schemaId":"schema_1120","description":"Unique id of the document.","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34"}],"pointer":"/paths/~1documents~1{documentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{documentId}","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":"documentId","in":"path","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34","schemaId":"schema_1120"}],"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":"/documents/{documentId}","href":"documents/getdocument","openApiOperationId":"GetDocument","summary":"Document 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/DocumentInfo"}},"schemaId":"components/schemas/DocumentInfo"},{"code":"404","description":"A document with the specified Id cannot be found."}],"pointer":"/paths/~1documents~1{documentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentInfo"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getdocument"}],"panels":[]}]},"httpPath":"/documents/{documentId}"},{"label":"Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/documents/documents/querydocuments","routeSlug":"/products/nowinfinity/apis/partner/documents/documents/querydocuments","metadata":{"seo":{"title":"Documents","description":"OData endpoint to query active documents under the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QueryDocuments","name":"Documents","isWebhook":false,"pointer":"/paths/~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","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 active documents under the account.\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_1121","description":"Expands related entities inline.","example":"Trustee"},{"name":"$filter","in":"query","schemaId":"schema_1121","description":"Filters the results, based on a Boolean condition.","example":"Status eq 'Active'"},{"name":"$select","in":"query","schemaId":"schema_1121","description":"Selects which properties to include in the response.","example":"Name,ABN,Status"},{"name":"$orderby","in":"query","schemaId":"schema_1121","description":"Sorts the results.","example":"CreatedDate desc"},{"name":"$top","in":"query","schemaId":"schema_1122","description":"Returns only the first n results.","example":25},{"name":"$skip","in":"query","schemaId":"schema_1122","description":"Skips the first n results.","example":0},{"name":"$count","in":"query","schemaId":"schema_1123","description":"Includes a count of the matching results in the response.","example":true}],"pointer":"/paths/~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/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":[],"query":[{"name":"$expand","in":"query","required":false,"example":"Trustee","schemaId":"schema_1121"},{"name":"$filter","in":"query","required":false,"example":"Status eq 'Active'","schemaId":"schema_1121"},{"name":"$select","in":"query","required":false,"example":"Name,ABN,Status","schemaId":"schema_1121"},{"name":"$orderby","in":"query","required":false,"example":"CreatedDate desc","schemaId":"schema_1121"},{"name":"$top","in":"query","required":false,"example":25,"schemaId":"schema_1122"},{"name":"$skip","in":"query","required":false,"example":0,"schemaId":"schema_1122"},{"name":"$count","in":"query","required":false,"example":true,"schemaId":"schema_1123"}],"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":"/documents","href":"documents/querydocuments","openApiOperationId":"QueryDocuments","summary":"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_1124"}},"schemaId":"schema_1124"}],"pointer":"/paths/~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1124","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1124"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/querydocuments"}],"panels":[]}]},"httpPath":"/documents"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":"Documents held under the account, including their ASIC and signing status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/documents/{documentId}","summary":"Document details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getdocument","deprecated":false},{"title":"/documents","summary":"Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/querydocuments","deprecated":false}]}]}]}]}},{"type":"group","label":"Document files","link":"/products/nowinfinity/apis/partner/documents/document-files","routeSlug":"/products/nowinfinity/apis/partner/documents/document-files","items":[{"label":"Document files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/documents/document-files/getdocumentfiles","routeSlug":"/products/nowinfinity/apis/partner/documents/document-files/getdocumentfiles","metadata":{"seo":{"title":"Document files","description":"Returns the list of files generated for the specified document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDocumentFiles","name":"Document files","isWebhook":false,"pointer":"/paths/~1documents~1{documentId}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of files generated for the specified document.\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":"documentId","in":"path","schemaId":"schema_1120","description":"Unique id of the document.","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34"}],"pointer":"/paths/~1documents~1{documentId}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{documentId}/files","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":"documentId","in":"path","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34","schemaId":"schema_1120"}],"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","202","204","404"],"pointer":"/documents/{documentId}/files","href":"document-files/getdocumentfiles","openApiOperationId":"GetDocumentFiles","summary":"Document files"},"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_1125"}},"schemaId":"schema_1125"},{"code":"202","description":"Files are still being generated for the specified document. Retry the request later."},{"code":"204","description":"Files have not been generated because the specified document is still in draft state."},{"code":"404","description":"A document with the specified Id cannot be found."}],"pointer":"/paths/~1documents~1{documentId}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1125","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1125"}}},{"code":"202"},{"code":"204"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-files/getdocumentfiles"}],"panels":[]}]},"httpPath":"/documents/{documentId}/files"},{"label":"Document file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/nowinfinity/apis/partner/documents/document-files/getdocumentfile","routeSlug":"/products/nowinfinity/apis/partner/documents/document-files/getdocumentfile","metadata":{"seo":{"title":"Document file","description":"Returns a single file generated for the specified document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDocumentFile","name":"Document file","isWebhook":false,"pointer":"/paths/~1documents~1{documentId}~1files~1{filename}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a single file generated for the specified document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the filename to retrieve all files for the document as one archive."},"children":[]}]}]}]},{"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":"documentId","in":"path","schemaId":"schema_1120","description":"Unique id of the document.","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34"},{"name":"filename","in":"path","schemaId":"schema_1121","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the file to return, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all files as a single archive."},"children":[]}]}]}],"required":true,"example":"change-of-registered-office.pdf"}],"pointer":"/paths/~1documents~1{documentId}~1files~1{filename}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{documentId}/files/{filename}","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":"documentId","in":"path","required":true,"example":"c7a4f912-3e85-4b60-a1d2-7f9e0b5c8a34","schemaId":"schema_1120"},{"name":"filename","in":"path","required":true,"example":"change-of-registered-office.pdf","schemaId":"schema_1121"}],"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":"/documents/{documentId}/files/{filename}","href":"document-files/getdocumentfile","openApiOperationId":"GetDocumentFile","summary":"Document file"},"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/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1126"}},"schemaId":"schema_1126"},{"code":"404","description":"A document with the specified Id cannot be found, or no file with the specified name exists for the document."}],"pointer":"/paths/~1documents~1{documentId}~1files~1{filename}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1126","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_1126"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-files/getdocumentfile"}],"panels":[]}]},"httpPath":"/documents/{documentId}/files/{filename}"}],"content":{"contentType":"group","meta":{"name":"Document files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document files","showPageActions":true},{"nodeType":"markdoc","content":"The generated files attached to a document. Files exist only once the document\nhas been processed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/documents/{documentId}/files","summary":"Document files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-files/getdocumentfiles","deprecated":false},{"title":"/documents/{documentId}/files/{filename}","summary":"Document file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-files/getdocumentfile","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DocumentFile":{"id":"components/schemas/DocumentFile","kind":"json-schema","title":"DocumentFile","data":{"description":"A file generated for a document.","type":"object","properties":{"FileName":{"type":"string","example":"change-of-registered-office.pdf"},"CreatedOn":{"type":"string","format":"date-time","example":"2026-07-16T23:05:44Z"},"Links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}}},"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"}}}}},"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"}}}},"schema_1120":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_1120"},"schema_1121":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1121"},"schema_1122":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_1122"},"schema_1123":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_1123"},"schema_1124":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentInfo"}},"id":"schema_1124"},"schema_1125":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFile"}},"id":"schema_1125"},"schema_1126":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_1126"}},"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/documents.json?download"},{"url":"/_bundle/products/nowinfinity/apis/partner/documents.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Documents","description":"- Retrieve summary information for a document.\n- List and download the files generated for a document.\n- Query documents 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/documents","routesMapping":{},"apiId":"NowInfinity Partner v1"}