CreditMemoAttachments

Updates an existing credit memo attachment.

Updates the properties (name, description) of an existing credit memo attachment. Only the fields provided in the request body will be updated. The file content cannot be changed; to replace the file, delete and recreate the attachment.

put/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

creditMemoIdstring required

The ID of the credit memo 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.

isExternalboolean

Indicates whether the attachment is stored externally

Example request

{
  "name": "raw records data",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "id": "CMA-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.

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.