Skip to content

Commit

Permalink
22707 - Update wording for GET /businesses/{identifier}/documents/{do…
Browse files Browse the repository at this point in the history
…cumentName} (#2910)

Update wording for GET /businesses/{identifier}/documents/{documentName} endpoint
  • Loading branch information
AimeeGao authored Aug 13, 2024
1 parent 5acf01f commit a995a1c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/business.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2405,7 +2405,7 @@ paths:
reportType: lseal
stateFilings: []
operationId: get-businesses-identifier-document-documentName
description: Return the requested document.
description: Retrieves a specific document for the specified business.
parameters:
- schema:
type: string
Expand Down Expand Up @@ -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: 'Organization or 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
Expand All @@ -4133,15 +4133,15 @@ 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 '
pattern: '^[A-Z]{1,3}[0-9]{7}|T[A-Za-z0-9]{9}$'
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
Expand Down Expand Up @@ -4200,18 +4200,18 @@ 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), Sole proprietor(SP), General Partnership(GP).'
taxId:
type: string
pattern: '^[0-9]{9}$'
example: BN123456789
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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit a995a1c

Please sign in to comment.