CreditMemoAttachments

Retrieves a specific credit memo attachment by its ID.

Depending on the Accept header, this endpoint can either download the attachment or return only its metadata. Use Accept: application/json to retrieve metadata only, or Accept: application/octet-stream to download the file. For external attachments (e.g., ERP-generated PDF), the file content is returned directly. For internal attachments, a 301 redirect to the download URL is returned.

get/public/v1/billing/credit-memos/{creditMemoId}/attachments/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/credit-memos/{creditMemoId}/attachments/{id}
  • Auth: none declared

Path parameters

idstring required

The ID of the credit memo attachment to retrieve.

creditMemoIdstring 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.

isExternalboolean

Indicates whether the attachment is stored externally

Example response

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

Changes

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