From 7c0dbb3114b777ca937aba13589c3dc7ee89bd2c Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Tue, 13 Aug 2024 14:40:31 -0700 Subject: [PATCH 1/9] update spec wording --- docs/business.yaml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index a7a3bc2b98..18637abcc7 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -53,7 +53,7 @@ paths: '404': description: Not Found operationId: get-business - description: 'Based on the users role, this returns basic information about a business.' + description: '

Retrieve a set of information about a business.

Access to a business and its information is dependent on the user being linked to that business, the API will return a 401 response if the user does not have access to that business.

The API will also return a 404 response if the business cannot be found.

' parameters: - $ref: '#/components/parameters/accountId' tags: @@ -3022,7 +3022,7 @@ paths: value: errorMessage: API backend third party service error. rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF. - description: Submitting a creation filing for a business will create that type of business if it is a fully valid filing and payment has been completed. + description: '

Use this endpoint to create a new business. This endpoint supports creation of a new business entity by these filings:

' requestBody: content: application/json: @@ -3490,11 +3490,11 @@ paths: type: boolean in: query name: draft - description: Set to save a draft in the ledger. No validations are performed. + description: This parameter is used to save a filing in Draft form which can be retrieved at a later time. - schema: type: boolean in: query - description: 'Validate the submission, but do not save or process it. Errors and warnings are returned if there are any.' + description: 'This parameter is used to submit a filing for validation only, no entity will be created. Use this to confirm that a filing is fully complete and correct prior to submission.' name: only_validate - $ref: '#/components/parameters/accountId' parameters: [] @@ -4112,13 +4112,13 @@ components: registeredDate: '2022-04-16T21:36:07.009977+00:00' startDate: '2022-04-10' type: 'DBA' - description: 'Organization or enterprising entity engaged in commercial, industrial, or professional activities.' + description: 'Object to hold information about a business entity.' properties: lastLedgerTimestamp: type: string format: date-time example: '2020-11-24T18:24:27.179623+00:00' - description: Recorded date/time of a company's financial transactions. + description: Recorded date/time of a company's filing. fiscalYearEndDate: type: string format: date @@ -4133,7 +4133,7 @@ components: type: string format: date-time example: '2020-11-24T18:23:53.498863+00:00' - description: 'The date written on the company''s certificate of incorporation. ' + description: 'The date written on the company''s certificate of incorporation, amalgamation, Continuation In or registration. ' identifier: type: string example: 'BC1234567 is an identifier for a corporation ' @@ -4141,7 +4141,7 @@ components: description: 'Unique code(letters & numbers) to identify a business, issued by the provincial or federal registry.' legalName: type: string - description: Name that appears on the formation document of the business. + description: Registered name of the business. example: '1234567 B.C. Ltd. is a legal name for a corporation ' state: type: string @@ -4200,7 +4200,7 @@ components: - XP - XS example: 'GP: General Partnership' - description: 'Type of business eg: individual(SP), partnership(GP).' + description: 'Type of business eg: BC corporation (B), Continued in corporation (C), individualSole proprietor(SP), partnership(GP).' taxId: type: string pattern: '^[0-9]{9}$' @@ -4208,10 +4208,10 @@ components: description: 'Company unique business number assigned by CRA: BN9 or BN15. ' goodStanding: type: boolean - description: Being in good standing means that the company is not in the process of being dissolved for non-filing of federal and/or provincial tax returns or non-filing of the BC annual report. + description: The business is up to date with required filings, e.g. Annual Report. adminFreeze: type: boolean - description: 'Example: If a business is not in good standing or investigated for fraud BC Registry Admin might freeze the business to prevent further filing from them. ' + description: 'The business has been placed in a Frozen state by the Registry which will prevent any further filings from being made ' naics: $ref: '#/components/schemas/Naics' natureOfBusiness: @@ -4240,7 +4240,7 @@ components: example: '''https://LEGAL-API-HOST/api/v2/businesses/IDENTIFIER/filings/FILING_ID''' alternateNames: type: array - description: The alternate name of the business + description: The alternate name of the business. Only applicable for Sole Proprietorship(SP) and General Partnership(GP) items: type: object properties: @@ -6129,7 +6129,7 @@ components: Naics: type: object title: NAICS Schema - description: NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities. + description: '

NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities.

NAICS information is not required or collected for all types of business entities.

' properties: naicsCode: type: string From 1ce43376e78b0f10b36e40b6e743c1a9510cb9bb Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Tue, 13 Aug 2024 15:32:36 -0700 Subject: [PATCH 2/9] fix duplicate issue --- docs/business.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index 32b958bca6..cdb9d93125 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -4201,7 +4201,6 @@ components: - XS example: 'GP: General Partnership' description: 'Type of business eg: BC corporation (B), Continued in corporation (C), Sole proprietor(SP), General Partnership(GP).' - description: 'Type of business eg: BC corporation (B), Continued in corporation (C), individualSole proprietor(SP), partnership(GP).' taxId: type: string pattern: '^[0-9]{9}$' @@ -4210,7 +4209,6 @@ components: goodStanding: type: boolean description: The business is up to date with required filings, e.g. Annual Report. - description: The business is up to date with required filings, e.g. Annual Report. adminFreeze: type: boolean description: 'The business has been placed in a Frozen state by the Registry which will prevent any further filings from being made ' From 91fe7b579da89570ec19369be382020da55a2b18 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Wed, 14 Aug 2024 15:21:45 -0700 Subject: [PATCH 3/9] arrange in alphabetical order --- docs/business.yaml | 376 ++++++++++++++++++++++----------------------- 1 file changed, 188 insertions(+), 188 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index c82e14ba9e..3acdad56c5 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -2464,109 +2464,6 @@ paths: type: object properties: {} examples: - incorporation-application-success-response: - summary: Incorporation Application Response - value: - errors: - - null - filing: - business: - identifier: Tqcbbbc157 - header: - accountId: 6164 - affectedFilings: [] - availableOnPaperOnly: false - certifiedBy: API Specs - colinIds: [] - comments: [] - date: '2024-07-25' - deletionLocked: false - effectiveDate: '2024-07-25T16:17:57.191129+00:00' - email: no_one@never.get - filingId: 150333 - inColinOnly: false - isCorrected: false - isCorrectionPending: false - name: incorporationApplication - status: DRAFT - submitter: mocked submitter - incorporationApplication: - contactPoint: - email: no_one@never.get - phone: 123-456-7890 - nameRequest: - legalType: BEN - nrNumber: 'NR 1345876' - offices: - recordsOffice: - deliveryAddress: - addressCity: delivery_address city - addressCountry: CA - addressRegion: BC - postalCode: H0H0H0 - streetAddress: delivery_address - address line one - mailingAddress: - addressCity: mailing_address city - addressCountry: CA - addressRegion: BC - postalCode: H0H0H0 - streetAddress: mailing_address - address line one - registeredOffice: - deliveryAddress: - addressCity: delivery_address city - addressCountry: CA - addressRegion: BC - postalCode: H0H0H0 - streetAddress: delivery_address - address line one - mailingAddress: - addressCity: mailing_address city - addressCountry: CA - addressRegion: BC - postalCode: H0H0H0 - streetAddress: mailing_address - address line one - parties: - - mailingAddress: - addressCity: Victoria - addressCountry: CA - addressRegion: BC - postalCode: V8W 3E6 - streetAddress: 200-940 Blanshard St - streetAddressAdditional: '' - officer: - email: severin@example.com - firstName: BCREGTEST Lucille - id: 'p90x2145' - lastName: TWENTY - middleName: '' - organizationName: '' - partyType: person - roles: - - appointmentDate: '2024-07-24' - roleType: Completing Party - - deliveryAddress: - addressCity: Burnaby - addressCountry: CA - addressRegion: BC - postalCode: V5E 1R9 - streetAddress: 6767 Burford St - streetAddressAdditional: '' - mailingAddress: - addressCity: Burnaby - addressCountry: CA - addressRegion: BC - postalCode: V5E 1R9 - streetAddress: 6767 Burford St - streetAddressAdditional: '' - officer: - firstName: Director - id: 'p90x2145' - lastName: Test - middleName: '' - organizationName: '' - partyType: person - roles: - - appointmentDate: '2024-07-24' - roleType: Director amalgamation-regular-success-response: summary: Amalgamation Regular Response value: @@ -2946,6 +2843,109 @@ paths: name: continuationIn status: DRAFT submitter: mocked submitter + incorporation-application-success-response: + summary: Incorporation Application Response + value: + errors: + - null + filing: + business: + identifier: Tqcbbbc157 + header: + accountId: 6164 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: API Specs + colinIds: [] + comments: [] + date: '2024-07-25' + deletionLocked: false + effectiveDate: '2024-07-25T16:17:57.191129+00:00' + email: no_one@never.get + filingId: 150333 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: incorporationApplication + status: DRAFT + submitter: mocked submitter + incorporationApplication: + contactPoint: + email: no_one@never.get + phone: 123-456-7890 + nameRequest: + legalType: BEN + nrNumber: 'NR 1345876' + offices: + recordsOffice: + deliveryAddress: + addressCity: delivery_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: delivery_address - address line one + mailingAddress: + addressCity: mailing_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: mailing_address - address line one + registeredOffice: + deliveryAddress: + addressCity: delivery_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: delivery_address - address line one + mailingAddress: + addressCity: mailing_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: mailing_address - address line one + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + officer: + email: severin@example.com + firstName: BCREGTEST Lucille + id: 'p90x2145' + lastName: TWENTY + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - deliveryAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + mailingAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + officer: + firstName: Director + id: 'p90x2145' + lastName: Test + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director registration-sucess-response: summary: Registartion Response value: @@ -3054,91 +3054,6 @@ paths: schema: $ref: '#/components/schemas/Filing' examples: - incorporation-application-request: - summary: Incorporation Application Request - value: - filing: - header: - certifiedBy: API Specs - email: no_one@never.get - name: incorporationApplication - date: '2024-07-25' - accountId: 6164 - incorporationApplication: - nameRequest: - legalType: BEN - nrNumber: NR 1234567 - offices: - registeredOffice: - deliveryAddress: - streetAddress: delivery_address - address line one - addressCity: delivery_address city - addressCountry: CA - postalCode: H0H0H0 - addressRegion: BC - mailingAddress: - streetAddress: mailing_address - address line one - addressCity: mailing_address city - addressCountry: CA - postalCode: H0H0H0 - addressRegion: BC - recordsOffice: - deliveryAddress: - streetAddress: delivery_address - address line one - addressCity: delivery_address city - addressCountry: CA - postalCode: H0H0H0 - addressRegion: BC - mailingAddress: - streetAddress: mailing_address - address line one - addressCity: mailing_address city - addressCountry: CA - postalCode: H0H0H0 - addressRegion: BC - contactPoint: - email: no_one@never.get - phone: 123-456-7890 - parties: - - mailingAddress: - addressCity: Victoria - addressCountry: CA - addressRegion: BC - postalCode: V8W 3E6 - streetAddress: 200-940 Blanshard St - streetAddressAdditional: '' - officer: - email: severin@example.com - firstName: BCREGTEST Lucille - lastName: TWENTY - middleName: '' - organizationName: '' - partyType: person - roles: - - appointmentDate: '2024-07-24' - roleType: Completing Party - - deliveryAddress: - addressCity: Burnaby - addressCountry: CA - addressRegion: BC - postalCode: V5E 1R9 - streetAddress: 6767 Burford St - streetAddressAdditional: '' - mailingAddress: - addressCity: Burnaby - addressCountry: CA - addressRegion: BC - postalCode: V5E 1R9 - streetAddress: 6767 Burford St - streetAddressAdditional: '' - officer: - firstName: Director - lastName: Test - middleName: '' - organizationName: '' - partyType: person - roles: - - appointmentDate: '2024-07-24' - roleType: Director amalgamation-regular-request: summary: Amalgamation Regular Request value: @@ -3448,6 +3363,91 @@ paths: priority: 0 hasMaximumShares: true hasRightsOrRestrictions: true + incorporation-application-request: + summary: Incorporation Application Request + value: + filing: + header: + certifiedBy: API Specs + email: no_one@never.get + name: incorporationApplication + date: '2024-07-25' + accountId: 6164 + incorporationApplication: + nameRequest: + legalType: BEN + nrNumber: NR 1234567 + offices: + registeredOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + recordsOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + contactPoint: + email: no_one@never.get + phone: 123-456-7890 + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + officer: + email: severin@example.com + firstName: BCREGTEST Lucille + lastName: TWENTY + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - deliveryAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + mailingAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + officer: + firstName: Director + lastName: Test + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director registration-request: summary: Registration Request value: From 52680d2e31cf3b0b9ab894f05379f431544103ce Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Wed, 14 Aug 2024 15:48:30 -0700 Subject: [PATCH 4/9] fix lint issue --- docs/business.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/business.yaml b/docs/business.yaml index 3acdad56c5..6015a4e94e 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -3928,7 +3928,6 @@ components: legalName: type: string nameRequest: - title: The resulting business name and type $ref: '#/components/schemas/Name_request' nameTranslations: $ref: '#/components/schemas/Name_translations' From a3911ac19370ec99aa556aa5298d58ef369d0ca5 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Wed, 14 Aug 2024 16:01:03 -0700 Subject: [PATCH 5/9] fix linting issue 1 --- docs/business.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/business.yaml b/docs/business.yaml index 6015a4e94e..9b1c508cf9 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -2444,6 +2444,7 @@ paths: /businesses: post: summary: save business creation filing + operationId: post-business tags: - business responses: From 3b63c258a858501431e2daa972b59505b89ddf23 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Thu, 15 Aug 2024 08:16:49 -0700 Subject: [PATCH 6/9] fix linting issue 1 --- docs/business.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/business.yaml b/docs/business.yaml index 9b1c508cf9..6015a4e94e 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -2444,7 +2444,6 @@ paths: /businesses: post: summary: save business creation filing - operationId: post-business tags: - business responses: From a389f6df2bb2b2fd98d7b9112bfeb81746120a04 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Thu, 15 Aug 2024 08:19:51 -0700 Subject: [PATCH 7/9] fix linting issue 2 --- docs/business.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/business.yaml b/docs/business.yaml index 6015a4e94e..9b1c508cf9 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -2444,6 +2444,7 @@ paths: /businesses: post: summary: save business creation filing + operationId: post-business tags: - business responses: From 5502bb389ac8a64a431a1da033d0866fafbcfa00 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Thu, 15 Aug 2024 08:23:20 -0700 Subject: [PATCH 8/9] fix linting issue 3 --- docs/business.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index 9b1c508cf9..74e7c68565 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -4658,7 +4658,6 @@ components: properties: business: $ref: '#/components/schemas/Business' - title: Provide identifier and/or taxId if already registered as extra provincial business. foreignJurisdiction: type: object required: @@ -4669,10 +4668,8 @@ components: properties: country: $ref: '#/components/schemas/Foreign_jurisdiction/properties/country' - title: The jurisdiction country code. region: $ref: '#/components/schemas/Foreign_jurisdiction/properties/region' - title: The jurisdiction region code. identifier: type: string title: Identifier of the business in the foreign jurisdiction. From eace1edb8cfd96e6f373588f2e233d02a1eca8a7 Mon Sep 17 00:00:00 2001 From: ketaki-deodhar Date: Thu, 15 Aug 2024 09:55:28 -0700 Subject: [PATCH 9/9] fix linting issue 4 --- docs/business.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/business.yaml b/docs/business.yaml index 74e7c68565..824ca99c6f 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -5667,12 +5667,14 @@ components: - $ref: '#/components/schemas/Agm_extension' - $ref: '#/components/schemas/Agm_location_change' - $ref: '#/components/schemas/Alteration' + - $ref: '#/components/schemas/Amalgamation_application' - $ref: '#/components/schemas/Annual_report' - $ref: '#/components/schemas/Change_of_address' - $ref: '#/components/schemas/Change_of_directors' - $ref: '#/components/schemas/Change_of_name' - $ref: '#/components/schemas/Change_of_registration' - $ref: '#/components/schemas/Consent_continuation_out' + - $ref: '#/components/schemas/Continuation_in' - $ref: '#/components/schemas/Conversion' - $ref: '#/components/schemas/Court_order' - $ref: '#/components/schemas/Correction'