The Journal Attachment object allows users to upload attachments to billing objects through an online link or file upload. It inherits from the abstract File base object.
This object contains the following attributes:
URL
string
The external link to the attachment.
id
string
The primary identifier for the billing attachment.
type
string
The type of billing attachment.
{
"id": "BIA-1234-1234",
"name": "29 Nov 2024 #1 - journal data",
"href": "/billing/journals/BJO-1234-5678/attachments/BIA-1234-1234",
"type": "File",
"contentType": "text/csv",
"description": "Journal charges for Microsoft 365",
"filename": "charges.csv",
"audit": {
"created": {
"at": "2024-12-02T17:00:00Z",
"by": { ... }
}
}
}Returns all attachments associated with the journal. Supports filtering, sorting, and pagination.
OK
Name of the attachment.
raw records dataRepresents the type of billing attachment.
Represents the name of the file associated with the attachment.
invoice.pdfIndicates the size of the file in bytes.
102400Represents the MIME type of the file content.
application/pdfProvides a description of the attachment.
Invoice for March 2025Indicates whether the attachment has been marked as deleted.
falseThe unique identifier of the attachment.
JOA-1234-1234The unique identifier of the journal entry.
BJO-1234-1234Name of the journal.
29 Nov 2024 #1The due date for the journal entry.
2025-05-15T23:59:59+00:00GET /public/v1/billing/journals/{journalId}/attachments HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"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": "JOA-1234-1234",
"journal": {
"revision": 1,
"id": "BJO-1234-1234",
"name": "29 Nov 2024 #1",
"dueDate": "2025-05-15T23:59:59+00:00"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}
]
}Uploads a file as multipart/form-data with optional properties (name, description).
The ID of the journal to which the attachment belongs.
The name of the attachment.
The description of the attachment.
The file of the attachment.
Created
Represents an attachment associated with a journal in the billing system.
Name of the attachment.
raw records dataRepresents the type of billing attachment.
Represents the name of the file associated with the attachment.
invoice.pdfIndicates the size of the file in bytes.
102400Represents the MIME type of the file content.
application/pdfProvides a description of the attachment.
Invoice for March 2025Indicates whether the attachment has been marked as deleted.
falseThe unique identifier of the attachment.
JOA-1234-1234The unique identifier of the journal entry.
BJO-1234-1234Name of the journal.
29 Nov 2024 #1The due date for the journal entry.
2025-05-15T23:59:59+00:00Bad Request
POST /public/v1/billing/journals/{journalId}/attachments HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 83
{
"attachment": {
"name": "text",
"description": "text",
"file": "binary"
},
"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": "JOA-1234-1234",
"journal": {
"revision": 1,
"id": "BJO-1234-1234",
"name": "29 Nov 2024 #1",
"dueDate": "2025-05-15T23:59:59+00:00"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}Depending on the Accept header, returns metadata (application/json) or redirects to file download (301).
The ID of the journal attachment to retrieve.
Optional select statement to specify which fields to include in the response.
OK
Represents an attachment associated with a journal in the billing system.
Name of the attachment.
raw records dataRepresents the type of billing attachment.
Represents the name of the file associated with the attachment.
invoice.pdfIndicates the size of the file in bytes.
102400Represents the MIME type of the file content.
application/pdfProvides a description of the attachment.
Invoice for March 2025Indicates whether the attachment has been marked as deleted.
falseThe unique identifier of the attachment.
JOA-1234-1234The unique identifier of the journal entry.
BJO-1234-1234Name of the journal.
29 Nov 2024 #1The due date for the journal entry.
2025-05-15T23:59:59+00:00Moved Permanently
No content
Not Found
Not Acceptable
GET /public/v1/billing/journals/{journalId}/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": "JOA-1234-1234",
"journal": {
"revision": 1,
"id": "BJO-1234-1234",
"name": "29 Nov 2024 #1",
"dueDate": "2025-05-15T23:59:59+00:00"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
}
}Permanently removes the attachment and its file. This operation cannot be undone.
The ID of the journal to which the attachment belongs.
The ID of the attachment to delete.
No Content
No content
Not Found
DELETE /public/v1/billing/journals/{journalId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content