All pages
Powered by GitBook
1 of 1

Loading...

Recalculate ledger

post

Recalculates pricing, margins, and totals for all charges in the ledger without changing status.

Path parameters
idstringRequired

The ID of the ledger to recalculate.

Body

Represents a ledger in the billing system.

atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the ledger.

Example: BLE-1234-1234-1234-1234
revisioninteger · int32Optional
idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234
namestringOptional

Name of the journal.

Example: 29 Nov 2024 #1
dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59+00:00
statusstring · enumOptional

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

Possible values:
idstringOptional
namestringOptional
revisioninteger · int32Optional
currencystringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
operationsstring · nullableOptional
defaultErpItemstring · nullableOptional
statusstringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
markupnumber · doubleOptional

Represents the markup value applied to the pricing.

Example: 15.5
marginnumber · doubleOptional

Represents the margin value calculated for the pricing.

Example: 20
totalPPnumber · doubleOptional

Represents the total purchase price.

Example: 1000
totalBSPnumber · doubleOptional

Represents the total sale price in buyer currency.

Example: 1200
currencystringOptional

Specifies the currency for the pricing.

totalinteger · int32Optional

Indicates the total number of items involved in the processing.

Example: 100
readyinteger · int32Optional

Indicates the number of items that are ready for further processing.

Example: 80
errorinteger · int32Optional

Indicates the number of items that encountered errors during processing.

Example: 5
splitinteger · int32Optional

Indicates the number of items that were split into multiple parts during processing.

Example: 10
skippedinteger · int32Optional

Indicates the number of items that were skipped during processing.

Example: 5
ignoredinteger · int32Optional

Indicates the number of items that were manually ignored.

Example: 2
errorCodestringOptional

Represents the error code associated with the billing entity.

Example: ERR-001
errorMessagestringOptional

Represents the error message providing details about the issue.

Example: Invalid billing data provided.
idstring · nullableOptional

Represents the unique identifier for the error, if applicable.

Example: 12345
messagestring · nullableOptional

Represents the detailed message associated with the error, if applicable.

Example: Failed to process the billing entity due to missing data.
statusstring · enumOptional

Represents the status of a backup operation.

Possible values:
datestring · date-time · nullableOptional

Date and time of the backup action, if available.

Responses
200

OK

application/json

Represents a ledger in the billing system.

atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the ledger.

Example: BLE-1234-1234-1234-1234
revisioninteger · int32Optional
idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234
namestringOptional

Name of the journal.

Example: 29 Nov 2024 #1
dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59+00:00
statusstring · enumOptional

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

Possible values:
idstringOptional
namestringOptional
revisioninteger · int32Optional
currencystringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
operationsstring · nullableOptional
defaultErpItemstring · nullableOptional
statusstringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
markupnumber · doubleOptional

Represents the markup value applied to the pricing.

Example: 15.5
marginnumber · doubleOptional

Represents the margin value calculated for the pricing.

Example: 20
totalPPnumber · doubleOptional

Represents the total purchase price.

Example: 1000
totalBSPnumber · doubleOptional

Represents the total sale price in buyer currency.

Example: 1200
currencystringOptional

Specifies the currency for the pricing.

totalinteger · int32Optional

Indicates the total number of items involved in the processing.

Example: 100
readyinteger · int32Optional

Indicates the number of items that are ready for further processing.

Example: 80
errorinteger · int32Optional

Indicates the number of items that encountered errors during processing.

Example: 5
splitinteger · int32Optional

Indicates the number of items that were split into multiple parts during processing.

Example: 10
skippedinteger · int32Optional

Indicates the number of items that were skipped during processing.

Example: 5
ignoredinteger · int32Optional

Indicates the number of items that were manually ignored.

Example: 2
errorCodestringOptional

Represents the error code associated with the billing entity.

Example: ERR-001
errorMessagestringOptional

Represents the error message providing details about the issue.

Example: Invalid billing data provided.
idstring · nullableOptional

Represents the unique identifier for the error, if applicable.

Example: 12345
messagestring · nullableOptional

Represents the detailed message associated with the error, if applicable.

Example: Failed to process the billing entity due to missing data.
statusstring · enumOptional

Represents the status of a backup operation.

Possible values:
datestring · date-time · nullableOptional

Date and time of the backup action, if available.

403

Forbidden

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/billing/ledgers/{id}/recalculate
POST /public/v1/billing/ledgers/{id}/recalculate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1995

{
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "rating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "error": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "review": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "completed": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "revision": 1,
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59+00:00"
  },
  "status": "Generated",
  "authorization": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "currency": "text"
  },
  "owner": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "seller": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBSP": 1200,
    "currency": "text"
  },
  "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-01-01T00:00:00.000Z"
  }
}
{
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "rating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "error": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "review": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "generated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "completed": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "revision": 1,
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59+00:00"
  },
  "status": "Generated",
  "authorization": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "currency": "text"
  },
  "owner": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "seller": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalId": "text"
  },
  "product": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "status": "text"
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBSP": 1200,
    "currency": "text"
  },
  "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-01-01T00:00:00.000Z"
  }
}

Recalculates a ledger.