Upload journal

Uploads a journal file.

post

Accepts XLSX or JSONL files containing charge records. Supports chunked uploads via MPT-File-Manager header. File is validated and charges are extracted for processing. Maximum file size is 10GB.

Path parameters

idstringRequired

The ID of the journal.

Body

multipart/form-data

filestring · binaryOptional

Journal file that contains the charges data.

Responses

200

OK

application/json

Represents a journal entry in the billing system.

revisioninteger · int32Optional

idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234

namestringOptional

Name of the journal.

Example: 29 Nov 2024 #1

descriptionstringOptional

A description of the journal entry.

Example: Monthly revenue journal entry

notesstring · nullableOptional

Additional notes or comments about the journal entry.

Example: Includes adjustments for Q1 2025

statusstring · enumOptional

Represents the various statuses a journal can have in the billing system.

Possible values:

dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59+00:00

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

415

Unsupported Media Type

application/json

post

/public/v1/billing/journals/{id}/upload

HTTPcURLJavaScriptPython

POST /public/v1/billing/journals/{id}/upload HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "audit": {
    "created": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "draft": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "deleted": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "error": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "validating": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "validated": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "review": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "enquiring": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "generating": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "generated": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "accepted": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    },
    "completed": {
      "at": "2026-06-09T01:17:47.542Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "BJO-1234-1234",
  "name": "29 Nov 2024 #1",
  "description": "Monthly revenue journal entry",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "notes": "Includes adjustments for Q1 2025",
  "status": "Validated",
  "vendor": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "account": "[Circular Reference]",
        "modules": [
          "[Circular Reference]"
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          "[Circular Reference]"
        ],
        "extensions": [
          "[Circular Reference]"
        ],
        "buyers": [
          "[Circular Reference]"
        ]
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "owner": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "product": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "published": "[Circular Reference]",
      "pending": "[Circular Reference]",
      "unpublished": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "website": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "revision": 1,
          "description": "text",
          "account": "[Circular Reference]",
          "modules": [
            "[Circular Reference]"
          ],
          "logo": "text",
          "isDefault": true,
          "users": [
            "[Circular Reference]"
          ],
          "extensions": [
            "[Circular Reference]"
          ],
          "buyers": [
            "[Circular Reference]"
          ]
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "configurationOrderDraft": true,
        "terminationOrder": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      },
      "sendCostToErp": true,
      "subscriptionCessation": {
        "enabled": true,
        "mode": "Termination"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1
    }
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "currency": "text"
  },
  "dueDate": "2025-05-15T23:59:59+00:00",
  "assignee": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBSP": 1200,
    "currency": "text"
  },
  "upload": {
    "total": 100,
    "split": 10,
    "ready": 85,
    "error": 5
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5,
    "ignored": 2
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  },
  "backup": {
    "status": "Pending",
    "date": "2026-06-09T01:17:47.542Z"
  }
}