Update Ledger Attachment
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.
namestringOptionalExample:
Name of the attachment.
raw records data
typeall ofOptionalExample:
Specifies the type of the attachment, such as input, output, or general attachment.
Input
string · enumOptionalPossible values:
Represents the type of billing attachment.
filenamestringOptionalExample:
Represents the name of the file associated with the attachment.
invoice.pdf
sizeinteger · int64 | nullableOptionalExample:
Indicates the size of the file in bytes.
102400
contentTypestringOptionalExample:
Represents the MIME type of the file content.
application/pdf
descriptionstringOptionalExample:
Provides a description of the attachment.
Invoice for March 2025
isDeletedbooleanOptionalExample:
Indicates whether the attachment has been marked as deleted.
false
idstringOptionalExample:
The unique identifier of the attachment.
LEA-1234-1234
ledgerall ofOptional
Responses
200
OK
application/json
403
Forbidden
application/json
404
Not Found
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?