Ledgers

Queues a ledger for ERP integration.

Transitions ledger to Queued status, initiating ERP integration processing.

post/public/v1/billing/ledgers/{id}/queue

Request

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

Path parameters

idstring required

The ID of the ledger to queue.

Request body

revisioninteger
idstring

The unique identifier of the ledger.

status'Rating' | 'Error' | 'Review' | 'Generating' | 'Generated' | 'Queued' | 'Completed'

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

Example request

{
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59+00:00"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 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."
  }
}

Response

OK

revisioninteger
idstring

The unique identifier of the ledger.

status'Rating' | 'Error' | 'Review' | 'Generating' | 'Generated' | 'Queued' | 'Completed'

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

Example response

{
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59+00:00"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 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.