LedgerAttachments

Updates an existing ledger attachment.

Updates the properties (name, description) of an existing ledger attachment. File content cannot be changed.

put/public/v1/billing/ledgers/{ledgerId}/attachments/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/ledgers/{ledgerId}/attachments/{id}
  • Auth: none declared

Path parameters

ledgerIdstring required

The ID of the ledger to which the attachment belongs.

idstring required

The ID of the attachment to update.

Request body

revisioninteger
namestring

Name of the attachment.

type'Attachment' | 'Input' | 'Output'

Represents the type of billing attachment.

filenamestring

Represents the name of the file associated with the attachment.

sizeinteger nullable

Indicates the size of the file in bytes.

contentTypestring

Represents the MIME type of the file content.

descriptionstring

Provides a description of the attachment.

isDeletedboolean

Indicates whether the attachment has been marked as deleted.

idstring

The unique identifier of the attachment.

Example request

{
  "name": "raw records data",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "id": "LEA-1234-1234",
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  }
}

Response

OK

revisioninteger
namestring

Name of the attachment.

type'Attachment' | 'Input' | 'Output'

Represents the type of billing attachment.

filenamestring

Represents the name of the file associated with the attachment.

sizeinteger nullable

Indicates the size of the file in bytes.

contentTypestring

Represents the MIME type of the file content.

descriptionstring

Provides a description of the attachment.

isDeletedboolean

Indicates whether the attachment has been marked as deleted.

idstring

The unique identifier of the attachment.

Example response

{
  "name": "raw records data",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "id": "LEA-1234-1234",
  "ledger": {
    "id": "BLE-1234-1234-1234-1234"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.