Create Company Officer
POST {{baseUrl}}/companies/:companyId/officers
Creates a company officer.
Constraints:
- Cannot create an officer if one exists with the same contactId & position.
- Contact must have birth details attached
Request Body
| Key | DataType | Mandatory | Constraints | Notes |
|---|---|---|---|---|
| contactId | Number | Yes | Must be ID of an existing contact | |
| appointDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 | |
| position | String | Yes | Must be one of 'Director','Secretary', 'Alternate', Managing Director, Manager, Nominee Director, Chief Executive Officer | Managing Director, Manager, Nominee Director, Chief Executive Officer only supported for SG companies |
| positionStatus | String | No | Must be one of 'Appointed, Resigned, Removed, Deceased' | |
| ceaseDate | Date | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Only if positionStatus is present and is not ‘Appointed’. Cannot be before ‘appointedDate’ | |
| signatoryStatus | String | No | Must be one of 'Attendee, Signatory, Chairperson, Form Signatory, Apology, Non Attendee' | |
| alternateContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Alternate' | |
| alternateTerms | String | No | Terms of Alternate appointmentMandatory if the position is 'Alternate' | |
| nominatorContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Nominee Director' | |
| notes | String | No | Text | |
| prepareForm | Boolean | No | True or False |
Response Body
Returns a list of objects that will contain the below keys
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | Number | Yes | Must be ID of an existing Officer transaction |
| contactId | Number | Yes | Must be ID of an existing contact |
| position | String | Yes | Must be one of 'Director','Secretary', 'Alternate', Managing Director, Manager, Nominee Director, |
| positionStatus | String | No | Must be one of 'Appointed, Resigned, Removed, Deceased' |
| ceaseDate | Date | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Only if positionStatus is present and is not ‘Appointed’. Cannot be before ‘appointDate’ |
| appointDate | Date | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. Cannot be after ‘ceaseDate’ |
| signatoryStatus | String | No | Must be one of 'Attendee, Signatory, Chairperson, Form Signatory, Apology, Non Attendee' |
| alternateContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Alternate' |
| alternateTerms | String | No | Terms of Alternate appointmentMandatory if the position is 'Alternate' |
| nominatorContactId | Number | No | This is the contactID of the existing director\Mandatory if the position is 'Nominee Director' |
| notes | String | No | Text |
| prepareForm | Boolean | No | True or False |
Request Body
{"alternateContactId"=>nil, "alternateTerms"=>nil, "appointDate"=>"2020-04-01", "ceaseDate"=>nil, "contactId"=>11038, "nominatorContactId"=>nil, "notes"=>nil, "position"=>"Director", "positionStatus"=>"Appointed", "prepareForm"=>true, "signatoryStatus"=>"Attendee"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: OK
{"contactId":"68482290001","appointDate":"2018-12-18","position":"Director"}