All pages
Powered by GitBook
1 of 1

Loading...

Get credit memo attachment

get

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.

Path parameters
idstringRequired

The ID of the credit memo attachment to retrieve.

creditMemoIdstringRequired
Query parameters
selectstringOptional

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

Responses
200

OK

application/json

Represents an attachment associated with a credit memo in the billing system.

atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
namestringOptional

Name of the attachment.

Example: raw records data
typestring · 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: CMA-1234-1234
revisioninteger · int32Optional
idstringOptional

The unique identifier of the credit memo.

isExternalbooleanOptional

Indicates whether the attachment is stored externally

301

Moved Permanently

No content

404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
406

Not Acceptable

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/billing/credit-memos/{creditMemoId}/attachments/{id}
GET /public/v1/billing/credit-memos/{creditMemoId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "name": "raw records data",
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "CMA-1234-1234",
  "creditMemo": {
    "revision": 1,
    "id": "text"
  },
  "isExternal": true
}

Retrieves a specific credit memo attachment by its ID.