Update Ledger Attachment

Updates an existing ledger attachment.

put

Path parameters

ledgerIdstringRequired

The ID of the ledger to which the attachment belongs.

idstringRequired

The ID of the attachment to update.

Body

application/jsontext/jsonapplication/*+json

Represents an attachment associated with a ledger in the billing system.

$metaall of | nullableOptional

Platform entity metadata.

namestringOptional

Represents the name associated with the entity.

Example: Sample Entity

iconstring | nullableOptional

Represents the icon linked to the entity, if applicable.

Example: icon.png

auditall ofOptional

typeall ofOptional

Specifies the type of the attachment, such as input, output, or general attachment.

Example: Input

string · enumOptional

Represents the type of billing attachment.

Possible values:

filenamestringOptional

Represents the name of the file associated with the attachment.

Example: invoice.pdf

sizeinteger · int64 | nullableOptional

Indicates the size of the file in bytes.

Example: 102400

contentTypestringOptional

Represents the MIME type of the file content.

Example: application/pdf

descriptionstringOptional

Provides a description of the attachment.

Example: Invoice for March 2025

isDeletedbooleanOptional

Indicates whether the attachment has been marked as deleted.

Example: false

idstringOptional

The unique identifier of the attachment.

Example: LEA-1234-1234

ledgerall ofOptional

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /public/v1/billing/ledgers/{ledgerId}/attachments/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 528

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "LEA-1234-1234",
  "ledger": {
    "name": "Sample Entity",
    "icon": "icon.png",
    "id": "BLE-1234-1234-1234-1234"
  }
}

application/jsontext/jsonapplication/*+json

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "LEA-1234-1234",
  "ledger": {
    "name": "Sample Entity",
    "icon": "icon.png",
    "id": "BLE-1234-1234-1234-1234"
  }
}