Create credit memo attachment

Creates a new credit memo attachment.

post

Uploads a file and associates it with the specified credit memo (e.g., CRD-3295-7900-0234). The request must be sent as multipart/form-data containing the file and optional properties (name, description).

Path parameters
creditMemoIdstringRequired

The ID of the credit memo to which the attachment belongs.

Body
filestring · binaryOptional

The file of the attachment.

Responses
chevron-right
201

Created

application/json

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

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
isExternalbooleanOptional

Indicates whether the attachment is stored externally

post
/public/v1/billing/credit-memos/{creditMemoId}/attachments

Last updated

Was this helpful?