CHcheckhq

Get a Setup Document

Changed on

Returns a setup document, including created_at (ISO 8601 UTC timestamp of when Check generated this document).

get/documents/setup_documents/{document}

Request

Path parameters

documentstring required

Document ID

Response

200

idstring

Unique identifier for the document.

companystring

ID of the company that this document belongs to.

document_typestring

Machine-readable document type identifier. See Document types for the full list.

labelstring

Human-readable name of the document type.

descriptionstring

Description of what this document is. May be an empty string.

created_atstring date-time

ISO 8601 UTC timestamp when Check generated the document.

Example response

{
  "id": "doc_Bw5rH2tYk8NcLq3ZsV0D",
  "company": "com_EkKTRETE3zl8CffWF2iW",
  "document_type": "payroll_journal",
  "label": "Payroll Journal",
  "created_at": "2024-09-03T14:21:55.918034Z"
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status