Upload charges

Uploads a file for a specific custom ledger.

post

Accepts XLSX files containing charge data. File is validated and charges are extracted for processing.

Path parameters

idstringRequired

The ID of the custom ledger.

Body

multipart/form-data

filestring · binaryOptional

The file to upload.

Responses

200

OK

application/json

Represents a custom ledger in the billing system.

revisioninteger · int32Optional

idstringOptional

The unique identifier of the custom ledger.

namestringOptional

Name of the custom ledger.

Example: Quarterly Revenue Ledger

billingStartDatestring · date-timeOptional

The start date of the billing period for the custom ledger.

Example: 2025-01-01T00:00:00+00:00

billingEndDatestring · date-timeOptional

The end date of the billing period for the custom ledger.

Example: 2025-03-31T23:59:59+00:00

notesstring · nullableOptional

Additional notes or comments about the custom ledger.

Example: Includes all transactions for Q1 2025.

statusstring · enumOptional

Represents the various statuses a custom ledger can have in the billing system.

Possible values:

403

Forbidden

application/json

404

Not Found

application/json

415

Unsupported Media Type

application/json

post

/public/v1/billing/custom-ledgers/{id}/upload

HTTPcURLJavaScriptPython

POST /public/v1/billing/custom-ledgers/{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-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "draft": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "deleted": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "validating": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "validated": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "error": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "generating": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "generated": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "queued": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    },
    "completed": {
      "at": "2026-06-14T04:17:42.811Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "text",
  "name": "Quarterly Revenue Ledger",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "seller": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "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"
  },
  "billingStartDate": "2025-01-01T00:00:00+00:00",
  "billingEndDate": "2025-03-31T23:59:59+00:00",
  "notes": "Includes all transactions for Q1 2025.",
  "status": "Validated",
  "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": {
      "purchase": "USD",
      "sale": "EUR",
      "rate": 1
    },
    "totalSP": 1200
  },
  "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-14T04:17:42.811Z"
  }
}