CustomLedgerAttachments

Retrieves a specific custom ledger attachment by its ID.

Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).

get/public/v1/billing/custom-ledgers/{customLedgerId}/attachments/{id}

Request

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

Path parameters

idstring required

The ID of the custom ledger attachment to retrieve.

customLedgerIdstring required

Query parameters

selectstring

Optional select statement to specify which fields to include in the response.

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": "CLA-1234-1234",
  "customLedger": {
    "name": "Quarterly Revenue Ledger"
  }
}

Changes

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