Create custom ledger attachment
Uploads a file as multipart/form-data with optional properties (name, description).
Path parameters
customLedgerIdstringRequired
The ID of the custom ledger to which the attachment belongs.
Body
filestring · binaryOptional
The file of the attachment.
Responses
201
Created
application/json
Represents an attachment associated with a custom ledger in the billing system.
revisioninteger · int32Optional
namestringOptionalExample:
Name of the attachment.
raw records datatypestring · enumOptionalPossible values:
Represents the type of billing attachment.
filenamestringOptionalExample:
Represents the name of the file associated with the attachment.
invoice.pdfsizeinteger · int64 · nullableOptionalExample:
Indicates the size of the file in bytes.
102400contentTypestringOptionalExample:
Represents the MIME type of the file content.
application/pdfdescriptionstringOptionalExample:
Provides a description of the attachment.
Invoice for March 2025isDeletedbooleanOptionalExample:
Indicates whether the attachment has been marked as deleted.
falseidstringOptionalExample:
The unique identifier of the attachment.
CLA-1234-1234400
Bad Request
application/json
post/public/v1/billing/custom-ledgers/{customLedgerId}/attachments
POST /public/v1/billing/custom-ledgers/{customLedgerId}/attachments HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 67
{
"attachment": {
"Name": "text",
"Description": "text"
},
"file": "binary"
}{
"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": "CLA-1234-1234",
"customLedger": {
"revision": 1,
"id": "text",
"name": "Quarterly Revenue Ledger"
}
}Last updated
Was this helpful?