Create Company Document

This endpoint serves the purpose of creating a company documents.

POST /company/documents

Create Company Document

cURL

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/company/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "file": "<string>",
  "type": "<string>",
  "file_name": "<string>"
}
'

200

{
  "id": 123,
  "name": "Weekly Payroll",
  "file_name": "Weekly_Payroll_2023",
  "location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/Weekly_Payroll_2023.pdf",
  "date_added": "Dec 12th",
  "type": "application/pdf",
  "deleted": 0,
  "date_deleted": null
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Company Document Body

name · string · required

file · file · required

type · string · required

file_name · string · required

Response

200

application/json

OK

id · integer

name · string

file_name · string

location · string

date_added · string

Example:

"Dec 12th"

type · string

deleted · integer

date_deleted · string<date-time> | null