CustomLedgers

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

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/billing/custom-ledgers/{id}
  • Auth: none declared

Path parameters

idstring required

Query parameters

selectstring

Response

OK

revisioninteger
idstring

The unique identifier of the custom ledger.

namestring

Name of the custom ledger.

billingStartDatestring date-time

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

billingEndDatestring date-time

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

notesstring nullable

Additional notes or comments about the custom ledger.

status'Draft' | 'Deleted' | 'Validating' | 'Validated' | 'Error' | 'Generating' | 'Generated' | 'Queued' | 'Completed'

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

Example response

{
  "name": "Quarterly Revenue Ledger",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "billingStartDate": "2025-01-01T00:00:00+00:00",
  "billingEndDate": "2025-03-31T23:59:59+00:00",
  "notes": "Includes all transactions for Q1 2025.",
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "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."
  }
}

Changes

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