N1Developer docsv1

TESTED LIVE

Files

20 real calls against a live Core. Open a call for its headers, request and response.

/files/:id/download-url

101Drawing · open-design-filesupervisorPOST /files/01a14ba9-8093-7522-b009-598b20ea39a7/download-url200 OKAs expected424 ms
Operation
POST /files/:id/download-url
Request id
01a14ba9-abcd-711a-b724-3312ce37552f
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-805d-72e2-974e-fae9639ae7d6?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T21:04:33.615Z"
}
114Drawing · open-design-file-own-joboperatorPOST /files/01a14ba9-8093-7522-b009-598b20ea39a7/download-url200 OKAs expected29 ms

Design file of a card with a step assigned to this operator.

Operation
POST /files/:id/download-url
Request id
01a14ba9-bb65-79c7-863b-fa608a91fadd
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-805d-72e2-974e-fae9639ae7d6?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T21:04:37.215Z"
}
166Drawing · open-design-fileqcPOST /files/01a14ba9-8093-7522-b009-598b20ea39a7/download-url200 OKAs expected27 ms
Operation
POST /files/:id/download-url
Request id
01a14ba9-f704-7878-808e-08c774d10234
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-805d-72e2-974e-fae9639ae7d6?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T21:04:52.477Z"
}
201Drawing · open-design-file-assignedoperatorPOST /files/01a14ba9-f98e-734c-8188-537a12fc73f8/download-url403 FORBIDDENAs expected9 ms

G15: a customer-attached file is not a job file; expect FORBIDDEN.

Operation
POST /files/:id/download-url
Request id
01a14baa-1f25-7417-97a8-c6a0d98e57a5
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14baa-1f25-7417-97a8-c6a0d98e57a5"
  }
}
213InvoiceDetails · open-pdfownerPOST /files/01a14bff-9f26-7549-ac95-d7c5aa6a77fd/download-url200 OKAs expected22 ms
Operation
POST /files/:id/download-url
Request id
01a14bff-f10b-7ccf-af5f-e1dbde343ce1
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14bff-9eb1-77c4-8a3b-4340c05e9a44?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T22:38:47.039Z"
}

What the signed URL served

{
  "status": 200,
  "contentType": "application/pdf",
  "contentDisposition": "attachment",
  "bytes": 3620,
  "header": "%PDF-1.4",
  "prints": [
    "TAX INVOICE",
    "Amount in words",
    "Authorised signatory",
    "CGST"
  ]
}
216InvoiceDetails · open-pdf-after-settingsownerPOST /files/01a14bff-a40c-7847-b8db-fc4fd7e141b5/download-url200 OKAs expected12 ms
Operation
POST /files/:id/download-url
Request id
01a14bff-f471-73b3-8bd9-8ce49f5b81ce
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14bff-a3ca-7e41-9df8-3a70f00e2f97?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T22:38:47.899Z"
}

What the signed URL served

{
  "status": 200,
  "contentType": "application/pdf",
  "contentDisposition": "attachment",
  "bytes": 3997,
  "header": "%PDF-1.4",
  "prints": [
    "TAX INVOICE",
    "Amount in words",
    "Bank details",
    "SAC",
    "Authorised signatory",
    "CGST"
  ]
}
222QuoteDetails · open-pdfaccountantPOST /files/01a14bff-fd84-7a8a-aa74-d3fe4979cc39/download-url200 OKAs expected14 ms
Operation
POST /files/:id/download-url
Request id
01a14bff-fe64-7763-9deb-eddc28515a80
Expected
OK

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 200

{
  "url": "http://127.0.0.1:49000/n1-dev-files/t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14bff-fd48-7637-b8e0-114856a28353?[REDACTED-SIGNED-QUERY]",
  "expiresAt": "2026-10-17T22:38:50.448Z"
}

What the signed URL served

{
  "status": 200,
  "contentType": "application/pdf",
  "contentDisposition": "attachment",
  "bytes": 4255,
  "header": "%PDF-1.4",
  "prints": [
    "QUOTATION",
    "Amount in words",
    "Bank details",
    "SAC",
    "Authorised signatory",
    "CGST"
  ]
}
227InvoiceDetails · open-pdf-by-file-idoperatorPOST /files/01a14bff-9f26-7549-ac95-d7c5aa6a77fd/download-url403 FORBIDDENAs expected19 ms

D7: an invoice file needs invoice.read.

Operation
POST /files/:id/download-url
Request id
01a14c00-04de-71dc-ad73-b0d637035d41
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14c00-04de-71dc-ad73-b0d637035d41"
  }
}
228QuoteDetails · open-pdf-by-file-idoperatorPOST /files/01a14bff-fd84-7a8a-aa74-d3fe4979cc39/download-url403 FORBIDDENAs expected15 ms

D7: a quote file needs quote.read.

Operation
POST /files/:id/download-url
Request id
01a14c00-05f6-7400-9ffb-d6cb0b5364e5
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14c00-05f6-7400-9ffb-d6cb0b5364e5"
  }
}
233InvoiceDetails · open-pdf-by-file-idqcPOST /files/01a14bff-9f26-7549-ac95-d7c5aa6a77fd/download-url403 FORBIDDENAs expected17 ms

D7: an invoice file needs invoice.read.

Operation
POST /files/:id/download-url
Request id
01a14c00-0b48-748b-bc66-6def99442e9f
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14c00-0b48-748b-bc66-6def99442e9f"
  }
}
234QuoteDetails · open-pdf-by-file-idqcPOST /files/01a14bff-fd84-7a8a-aa74-d3fe4979cc39/download-url403 FORBIDDENAs expected14 ms

D7: a quote file needs quote.read.

Operation
POST /files/:id/download-url
Request id
01a14c00-0c5f-7eba-8217-26b002da5c26
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14c00-0c5f-7eba-8217-26b002da5c26"
  }
}
237InvoiceDetails · open-pdf-by-file-idsupervisorPOST /files/01a14bff-9f26-7549-ac95-d7c5aa6a77fd/download-url403 FORBIDDENAs expected20 ms

D5/D7: a supervisor does not read invoices.

Operation
POST /files/:id/download-url
Request id
01a14c00-0f8a-7fc1-83fd-78678470eec1
Expected
FORBIDDEN

Headers

{
  "authorization": "[REDACTED]"
}

Response · HTTP 403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this.",
    "requestId": "01a14c00-0f8a-7fc1-83fd-78678470eec1"
  }
}

/files/upload-url

027Organization · upload-logoownerPOST /files/upload-url201 OKAs expected47 ms

No organisation entity type for logo / invoice logo / signature.

Operation
POST /files/upload-url
Request id
01a14ba9-481c-75bc-b0f1-4c91de9544bb
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-027",
  "content-type": "application/json"
}

Body

{
  "entityType": "organisation",
  "entityId": "01a14ba6-e3d8-7d56-8060-bfa0d3554b8b",
  "name": "logo.png",
  "contentType": "image/png",
  "sizeBytes": 2048
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-486e-763c-a2fb-ba0e329f9b6c",
    "entityType": "organisation",
    "entityId": "01a14ba6-e3d8-7d56-8060-bfa0d3554b8b",
    "name": "logo.png",
    "contentType": "image/png",
    "sizeBytes": 2048,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "image/png",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205907Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-4837-71fa-9e5b-d918614d09d0",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:07.715Z"
  }
}
038UserDetails · upload-documentownerPOST /files/upload-url201 OKAs expected14 ms

No user entity type for employee documents or profile photo.

Operation
POST /files/upload-url
Request id
01a14ba9-5413-7cbe-b0c7-0c1894c9e2f4
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-038",
  "content-type": "application/json"
}

Body

{
  "entityType": "user",
  "entityId": "01a14ba9-4b84-7d73-8a4a-f05d76e8da8d",
  "name": "id-proof.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 4096
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-5450-774e-9e9f-e46d8ac83520",
    "entityType": "user",
    "entityId": "01a14ba9-4b84-7d73-8a4a-f05d76e8da8d",
    "name": "id-proof.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 4096,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "application/pdf",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205910Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-541b-7968-843b-35b59d2f448d",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:10.751Z"
  }
}
075OrderForm · upload-design-before-order-existsownerPOST /files/upload-url400 VALIDATION_FAILEDAs decided22 ms

G18: an upload needs an entity that exists; upload after the order is made.

Operation
POST /files/upload-url
Request id
01a14ba9-7e28-74d3-8e0b-fdb74495549d
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-075",
  "content-type": "application/json"
}

Body

{
  "entityType": "sales_order",
  "entityId": "cd343288-2acd-4682-8120-0679bde25a71",
  "name": "drawing.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 10240
}

Response · HTTP 400

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "The request has invalid fields.",
    "requestId": "01a14ba9-7e28-74d3-8e0b-fdb74495549d",
    "details": [
      {
        "path": "entityId",
        "message": "matches nothing in this shop"
      }
    ]
  }
}
076OrderForm · upload-design-dwgownerPOST /files/upload-url201 OKAs expected13 ms

The app design picker offers .dwg.

Operation
POST /files/upload-url
Request id
01a14ba9-7f42-7ed2-9a65-51c6d1376dcf
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-076",
  "content-type": "application/json"
}

Body

{
  "entityType": "job_card",
  "entityId": "01a14ba9-79f7-727d-9878-213ff050bcf7",
  "name": "drawing.dwg",
  "contentType": "application/acad",
  "sizeBytes": 10240
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-7f7e-79fb-9121-1a2a8174d5fb",
    "entityType": "job_card",
    "entityId": "01a14ba9-79f7-727d-9878-213ff050bcf7",
    "name": "drawing.dwg",
    "contentType": "application/acad",
    "sizeBytes": 10240,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "application/acad",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205921Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-7f48-7ea0-8d0f-085c14865cac",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:21.806Z"
  }
}
077OrderForm · upload-design-pdfownerPOST /files/upload-url201 OKAs expected19 ms
Operation
POST /files/upload-url
Request id
01a14ba9-8054-7752-ab6b-693ae2fa370b
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-077",
  "content-type": "application/json"
}

Body

{
  "entityType": "job_card",
  "entityId": "01a14ba9-79f7-727d-9878-213ff050bcf7",
  "name": "drawing.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 9
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-8093-7522-b009-598b20ea39a7",
    "entityType": "job_card",
    "entityId": "01a14ba9-79f7-727d-9878-213ff050bcf7",
    "name": "drawing.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 9,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "application/pdf",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205922Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-805d-72e2-974e-fae9639ae7d6",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:22.085Z"
  }
}
125QcFail · attach-reportqcPOST /files/upload-url201 OKAs expected154 ms
Operation
POST /files/upload-url
Request id
01a14ba9-c768-719b-8be5-c782f846f4ee
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-125",
  "content-type": "application/json"
}

Body

{
  "entityType": "job_card",
  "entityId": "01a14ba6-e65b-777f-9975-ca8ed40d8792",
  "name": "qc-report.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 9
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-c81a-75b8-944b-3b98c01298c7",
    "entityType": "job_card",
    "entityId": "01a14ba6-e65b-777f-9975-ca8ed40d8792",
    "name": "qc-report.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 9,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "application/pdf",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205940Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-c7e2-774b-a811-e23dbdcfab5e",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:40.413Z"
  }
}
126QcFail · attach-report-docxqcPOST /files/upload-url415 FILE_TYPE_NOT_ALLOWEDAs decided9 ms

D15: QC reports are PDF or images; .docx is not accepted.

Operation
POST /files/upload-url
Request id
01a14ba9-c907-7ae7-9458-3c626286bfdd
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-126",
  "content-type": "application/json"
}

Body

{
  "entityType": "job_card",
  "entityId": "01a14ba6-e65b-777f-9975-ca8ed40d8792",
  "name": "qc-report.docx",
  "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "sizeBytes": 9
}

Response · HTTP 415

{
  "error": {
    "code": "FILE_TYPE_NOT_ALLOWED",
    "message": "This kind of file cannot be uploaded.",
    "requestId": "01a14ba9-c907-7ae7-9458-3c626286bfdd"
  }
}
168Flow · upload-designownerPOST /files/upload-url201 OKAs expected45 ms
Operation
POST /files/upload-url
Request id
01a14ba9-f942-7805-b058-8e464781e3b9
Expected
OK

Headers

{
  "authorization": "[REDACTED]",
  "idempotency-key": "key-168",
  "content-type": "application/json"
}

Body

{
  "entityType": "customer",
  "entityId": "01a14ba6-e56a-7478-990d-ceec492d63e7",
  "name": "flow.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 9
}

Response · HTTP 201

{
  "file": {
    "id": "01a14ba9-f98e-734c-8188-537a12fc73f8",
    "entityType": "customer",
    "entityId": "01a14ba6-e56a-7478-990d-ceec492d63e7",
    "name": "flow.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 9,
    "status": "PENDING"
  },
  "upload": {
    "url": "http://127.0.0.1:49000/n1-dev-files",
    "fields": {
      "Content-Type": "application/pdf",
      "bucket": "n1-dev-files",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "[REDACTED]",
      "X-Amz-Date": "20261017T205953Z",
      "key": "t/01a14ba6-e3d8-7d56-8060-bfa0d3554b8b/2026/01a14ba9-f958-70af-b6df-e3f56f82f702",
      "Policy": "[REDACTED]",
      "X-Amz-Signature": "[REDACTED]"
    },
    "expiresAt": "2026-10-17T21:04:53.068Z"
  }
}

Search documentation

Search operations, types and errors from the generated contract.

↑ ↓ to navigate · Enter to openEsc to close