latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Plan

plans

Returns the ids of the plans created. This endpoint will create new plans for the company specified in the request. You cannot update an existing plan using this endpoint. The plan must be deleted before you are able to post the same plan again.<p>Scopes: import_plan</p>

post/v{version}/plans

Path parameters

versionstring required

Request body

new_companies_onlyboolean

If true, the server will return an HTTP 419 code if there is already an existing company with the same name. Optional. The default is false.

Example request

{
  "plans": [
    {
      "start_date": "yyyy-MM-dd",
      "end_date": "yyyy-MM-dd",
      "eligibilities": [
        {
          "entry_date": "yyyy-MM-dd"
        }
      ]
    }
  ],
  "members": [
    {
      "birth_date": "yyyy-MM-dd",
      "hire_date": "yyyy-MM-dd"
    }
  ]
}

Response

company_idstring

The id of the company, whether new or existing.