Recalculate Ledger

Recalculates the ledger with the specified ID.

post
Path parameters
idstringRequired

The ID of the ledger to regenerate.

Body

Represents a ledger in the billing system.

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

idstringOptional

The unique identifier of the ledger.

Example: BLE-1234-1234-1234-1234
journalall ofOptional
statusall ofOptional

The current status of the ledger.

Example: Generated
string · enumOptional

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

Possible values:
authorizationall ofOptional
ownerall ofOptional
sellerall ofOptional
productall ofOptional
assigneeall ofOptional
priceall ofOptional

Pricing details associated with the ledger.

processingall ofOptional

Processing status and related details for the ledger, visible to operations.

errorall of | nullableOptional

Error details associated with the ledger, if any.

Responses
200
OK
application/json
post
POST /public/v1/billing/ledgers/{id}/recalculate HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2946

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "rating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "error": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "review": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "queued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "completed": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59.0000000+00:00"
  },
  "status": "Generated",
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "owner": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": "EUR"
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  }
}
{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "rating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "error": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "review": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generating": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "generated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "queued": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "completed": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BLE-1234-1234-1234-1234",
  "journal": {
    "id": "BJO-1234-1234",
    "name": "29 Nov 2024 #1",
    "dueDate": "2025-05-15T23:59:59.0000000+00:00"
  },
  "status": "Generated",
  "authorization": {
    "id": "text",
    "name": "text",
    "currency": "text"
  },
  "owner": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text",
    "erpLink": {
      "id": "text",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "icon": "text",
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "name": "text",
      "status": "Active",
      "note": "text",
      "externalIds": {
        "erpCompanyContact": "text",
        "erpCustomer": "text",
        "accountExternalId": "text"
      },
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalSP": 1200,
    "currency": "EUR"
  },
  "processing": {
    "total": 100,
    "ready": 80,
    "error": 5,
    "split": 10,
    "skipped": 5
  },
  "error": {
    "errorCode": "ERR-001",
    "errorMessage": "Invalid billing data provided.",
    "id": "12345",
    "message": "Failed to process the billing entity due to missing data."
  }
}

Last updated

Was this helpful?