JournalAttachments

Creates a new journal attachment.

Uploads a file as multipart/form-data with optional properties (name, description).

post/public/v1/billing/journals/{journalId}/attachments

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/journals/{journalId}/attachments
  • Auth: none declared

Path parameters

journalIdstring required

The ID of the journal to which the attachment belongs.

Response

Created

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.

Example response

{
  "name": "raw records data",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "id": "JOA-1234-1234",
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.