Create Plan Year
Header Parameters
Idempotency-Keystring Required
Unique identifier for idempotent requests (UUID v4)
Authorizationstring
Body Parameters
namestring Required
Display name of the plan year
start_datestring Required
Start date of the plan year
end_datestring
End date of the plan year
Nullable:
True
statusstring Required
Status of a plan year package
employer_idstring Required
Associated employer ID
Response
201
Object
Plan year created successfully
Response Attributes
dataobject Required
Show child attributes
400
Object
Bad Request
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
409
Object
Conflict - resource already exists
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal Server Error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?