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

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

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

namestringOptional

Name of the attachment.

Example: raw records data
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
put
PUT /public/v1/billing/ledgers/{ledgerId}/attachments/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 472

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "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"
      }
    }
  },
  "name": "raw records data",
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "LEA-1234-1234",
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  }
}
{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "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"
      }
    }
  },
  "name": "raw records data",
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "LEA-1234-1234",
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  }
}

Last updated

Was this helpful?