UploadFileToEntity

GraphQL Mutation

mutation($input: UploadFileInput!) {
  uploadFileToEntity(input: $input)
  {
    id
  }
}

GraphQL Variables (in operations)

{
  "input": {
    "file": null,
    "entityType": "ACCOUNTING_ENTRY",
    "entityId": "8b21a143-4d9c-41ea-b1dc-1cf9d91a72f1",
    "fileName": "invoice-q1",
    "businessDate": "2025-04-04",
    "comment": "Invoice for Q1"
  }
}

File Binding Map (in map)

{
  "0": ["variables.input.file"]
}

File Part (in the multipart request)

The actual file is sent in the multipart body as a separate part, using the key 0 (as referenced in the map):

--boundary
Content-Disposition: form-data; name="0"; filename="invoice-q1.pdf"
Content-Type: application/pdf

(binary file content here)
--boundary--

Most GraphQL clients (like Postman, Insomnia, or Apollo Upload Client) handle this automatically when using the Upload scalar. Just make sure:

• the field is named 0,
• the file is selected in the form-data body,
• and the map and operations fields are correctly provided.

Example Response

{
  "data": {
    "uploadFileToEntity": {
      "id": "98f7adc7dd104cd984f9c113ef9a8e54.pdf"
    }
  }
}

In Postman, uploading a file via GraphQL requires setting a multipart/form-data request, adding the GraphQL-preflight: 1 header, and correctly populating the operations, map, and file parts of the request.

Steps:

1. In Postman, open the Headers tab.
2. Add the usual authentication headers required for any API call:
   • Authorization: Bearer {Current access Token}
   • X-TenantId: {Current tenant id} DEPRECATEDThis object is now deprecated, and we recommend using an alternative solution
   • X-OrganizationId: {Current organization id}
   • x-api-key: {Primary or secondary subscription key}
3. Add an additional header specifically required for uploads:
   • Key: GraphQL-preflight
   • Value: 1
4. In the Body tab, select form-data.

5. Set the following three key/value pairs:
   
   

   Key	Type	Value / Example
   operations	Text	GraphQL mutation + variables, with file: null (see example below)
   map	Text	{ "0": ["variables.input.file"] }
   0	File	The actual file to upload (e.g., invoice-q1.pdf)

• operations:
  A JSON string containing the GraphQL mutation and its variables, as in the following example.
  The file field must be set to null in the variables.

  {
    "query": "mutation($input: UploadFileInput!) { uploadFileToEntity(input: $input){id}}",
    "variables": {
      "input": {
        "file": null,
        "entityType": "Customer",
        "entityId": "8b21a143-4d9c-41ea-b1dc-1cf9d91a72f1",
        "fileName": "invoice-q1",
        "businessDate": "2025-04-04",
        "comment": "Customer invoice Q1"
      }
    }
  }
  

• map:
  A JSON string mapping the uploaded file (index 0) to the GraphQL variable path:

   { "0": ["variables.input.file"] }
  

• 0:
  The actual file upload. As the key, use 0 (matching the map).
  Select type File and upload your PDF, image, or other supported file.