Create Invoice Attachment

Creates a new invoice attachment.

post

Path parameters

invoiceIdstringRequired

The ID of the invoice to which the attachment belongs.

Body

multipart/form-data

filestring · binaryOptional

The file of the attachment.

Responses

201

Created

application/json

Represents an attachment associated with an invoice in the billing system.

namestringOptional

Name of the attachment.

Example: raw records data

typeall ofOptional

Specifies the type of the attachment, such as input, output, or general attachment.

Example: Input

string · 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: INA-1234-1234

isExternalbooleanOptional

Indicates whether the attachment is stored externally

400

Bad Request

application/json

post

/public/v1/billing/invoices/{invoiceId}/attachments

HTTPcURLJavaScriptPython

POST /public/v1/billing/invoices/{invoiceId}/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"
}

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "name": "raw records data",
  "type": "Input",
  "filename": "invoice.pdf",
  "size": 102400,
  "contentType": "application/pdf",
  "description": "Invoice for March 2025",
  "isDeleted": false,
  "id": "INA-1234-1234",
  "invoice": {
    "id": "INV-123-456-789"
  },
  "isExternal": true
}