Sign in
Documents

File documents

Changed on

Up to 100 documents in one call, matched on external_id, which is required here.

The bytes go up separately. POST /company/v3/files takes one file and answers an id; send that as file_id. A file may be claimed once: one already hanging off a document is refused rather than moved.

An uploaded file waits to be claimed and is not cleaned up. A batch refused at the hundredth document leaves all hundred files staged and still valid, so a retry should send the same file_ids rather than uploading them again.

parent_external_id links a supplementary agreement to what it amends, by your key rather than ours. It resolves against documents already filed — not against another item of the same batch — and a key matching nothing clears the link rather than failing.

user_id is required and may name somebody who has left: termination paperwork is filed after a dismissal, which is exactly when it is needed.

No signers. Signing runs conversions and outbound calls that do not belong under a versioned contract, so documents filed here are always party: employee. Signature state is readable; creating a signing request is not offered yet.

author_id is set to the subject: this token authenticates a company, not a person.

post/company/v3/documents/upsert

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/documents/upsert
  • Auth: HTTP bearer

Request body

Response

Success

Changes

  • v396f948c66816Revision changes
    • info

      the endpoint scheme security companyToken was added to the API

    • info

      added the new asp_certificate enum value to the request property //

    • info

      added the new attorney enum value to the request property //

    • info

      added the new disability_certificate enum value to the request property //

    • info

      added the new hunter enum value to the request property //

    • info

      added the new insurance_policy enum value to the request property //

    • info

      added the new large_family_certificate enum value to the request property //

    • info

      added the new lbg_card enum value to the request property //

    • info

      added the new oralman enum value to the request property //

    • info

      added the new pcr_certificate enum value to the request property //

    • info

      added the new pension enum value to the request property //

    • info

      added the new rk_passport enum value to the request property //

    • info

      added the new social_id enum value to the request property //

    • info

      added the new srts enum value to the request property //

    • info

      added the new student_card enum value to the request property //

    • info

      added the new tech_passport enum value to the request property //

    • info

      added the new vaccination enum value to the request property //

    • info

      added the new vnzh enum value to the request property //

  • v30b1170aa3044Revision changes
    • info

      added the new birth_certificate enum value to the request property //

    • info

      added the new change_fio_certificate enum value to the request property //

    • info

      added the new divorce_certificate enum value to the request property //

    • info

      added the new driver_license enum value to the request property //

    • info

      added the new marriage_certificate enum value to the request property //