Document Operations

Archive document

<small>Requires an API token with the Document Manager role.</small>

POST

/documents/{document}/archive

Archive document

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/{document}/archive \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "archived_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "dynamic_fields": [
      {
        "autofill_type": "document_created_date",
        "format": {
          "decimal_separator": ".",
          "decimals": 2,
          "thousands_separator": ","
        },
        "is_mandatory": true,
        "name": "Gross salary",
        "order": 123,
        "question": "What is the employee's gross salary in EUR?",
        "question_external": "<string>",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "scope": "internal",
        "select_values": [
          "<string>"
        ],
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "type": "id",
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "value": "EUR;95000;yearly"
      }
    ],
    "external_signatory_invitation_message": "<string>",
    "integration_reference": {
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity",
      "integration_type": "pipedrive",
      "object_type": "Opportunity"
    },
    "locale": "de-AT",
    "metadata_values": [
      {
        "computed_at": "2023-11-07T05:31:56Z",
        "computed_status": "missing_information",
        "computed_value": "EUR;95000;yearly",
        "is_attached": true,
        "metadata": {
          "always_exists": true,
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "display_name": "Discount Rate",
          "is_contract_value": true,
          "keywords": "discount, rate, valuation",
          "name": "discount_rate",
          "prompt": "Extract the discount rate percentage from the document.",
          "relevant_document_type_uuids": [
            "<string>"
          ],
          "select_values": [
            "<string>"
          ],
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "type": "system_autofilled",
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "value_type": "id"
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "value": "EUR;95000;yearly",
        "value_currency_monthly": "<string>",
        "value_currency_yearly": "<string>",
        "value_source": "user"
      }
    ],

Archives a document, hiding it from the document lists in fynk. Archiving does not change or remove any of the document's data, and the document can be unarchived again at any time using the Unarchive document endpoint.

Archived documents are excluded from the List documents endpoint's response by default. Use filter[archived]=true to list them instead.

Requires that the document is not already archived, i.e. that its archived_at is null.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

Response

DocumentDetailResource

dataobjectrequired

Show child attributes

Still need help? Share an idea