Update File Reading

Edit extracted file reading content before creating invoices or wastes

PUT /v1/files/readings/{file_reading_id}

Update File Reading

JavaScript

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({content: {}, 'content.items': [{}]})
};

fetch('https://api.dcycle.io/v1/files/readings/{file_reading_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "status": "<string>",
  "content": {
    "items": {}
  }
}

Use this endpoint to correct OCR or LLM extraction output before converting the reading into invoices or wastes.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

file_reading_id · string · required

File reading UUID from GET /v1/files/readings.

Body

Send the full updated content.items array. The shape depends on the reading category.

content · object · required

Wrapper for the updated extracted content.

content.items · array · required

Updated parsed items. Replace the existing list with the corrected values.

Electricity, stationary combustion and water readings: issuer_legal_name and issuer_tax_id (and, for stationary combustion, printed_fuel_name) are OCR-only fields. If an item in the request omits one of them, the stored value of the item at the same position is kept (when the number of items is unchanged). Send the key explicitly, even as null, to overwrite it. supplier_match is set by the server only: any value sent is ignored and the stored one is kept.

Response

Returns the updated file reading (HTTP 200).

id · string

File reading UUID.

status · string

Processing status (e.g. "success").

content · object

Updated extracted content.

Show Content Object

items · array[object]

Updated line items. Shape varies by reading category (e.g. invoice fields for energy, waste fields for wastes).

Example

cURL

curl -X PUT "https://api.dcycle.io/v1/files/readings/22222222-2222-2222-2222-222222222222" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "items": [
        {
          "invoice_number": "WTR-2024-03",
          "quantity": 32.1,
          "unit": "cubic_metre_(m3)",
          "start_date": "2024-03-01",
          "end_date": "2024-03-31"
        }
      ]
    }
  }'

Successful Response

{
  "id": "22222222-2222-2222-2222-222222222222",
  "status": "success",
  "content": {
    "items": [
      {
        "invoice_number": "WTR-2024-03",
        "quantity": 32.1,
        "unit": "cubic_metre_(m3)",
        "start_date": "2024-03-01",
        "end_date": "2024-03-31"
      }
    ]
  }
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: The file reading does not exist or belongs to another organization

{"detail": "Not Found"}

422 Unprocessable Entity

Cause: Missing required content.items array

{
  "detail": [
    {
      "loc": ["body", "content"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

• Use this before calling POST /v1/files/readings.
• The API does not currently publish category-specific schemas in the docs, so clients should start from the values returned by GET /v1/files/readings, modify only the needed fields, and send the full content.items array back.

Related Endpoints

List File Readings

Retrieve readings to get the current content

Create Records

Convert the edited reading into invoices or wastes

Upload Files

Upload new files via presigned S3 URLs

Files Overview

Learn about the Files API