Update Invoice Attachment

Updates an existing invoice attachment.

put

Path parameters

invoiceIdstringRequired

The ID of the invoice to which the attachment belongs.

idstringRequired

The ID of the attachment to update.

Body

application/jsontext/jsonapplication/*+json

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

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

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

invoiceall ofOptional

isExternalbooleanOptional

Indicates whether the attachment is stored externally

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /public/v1/billing/invoices/{invoiceId}/attachments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 483

{
  "$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
}

application/jsontext/jsonapplication/*+json

{
  "$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
}