Journals

Resets a journal.

Returns journal to Draft status, clearing processing state and allowing re-upload or modification.

post/public/v1/billing/journals/{id}/reset

Request

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

Path parameters

idstring required

The ID of the journal to reset.

Request body

revisioninteger
idstring

The unique identifier of the journal entry.

namestring

Name of the journal.

descriptionstring

A description of the journal entry.

notesstring nullable

Additional notes or comments about the journal entry.

status'Draft' | 'Deleted' | 'Error' | 'Validating' | 'Validated' | 'Review' | 'Reconciling' | 'Enquiring' | 'Generating' | 'Generated' | 'Accepted' | 'Queued' | 'Completed' | 'Resetting'

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

generation'V1' | 'V2' | 'V3'

Identifies the contract the charges in a journal were created under. Each generation is a fixed point in time: a journal keeps the generation its charges were produced with, and recalculating it does not move it forward. Add a member when the shape or meaning of charge data changes.

dueDatestring date-time

The due date for the journal entry.

Example request

{
  "id": "BJO-1234-1234",
  "name": "29 Nov 2024 #1",
  "description": "Monthly revenue journal entry",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "notes": "Includes adjustments for Q1 2025",
  "dueDate": "2025-05-15T23:59:59+00:00",
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 1200
  },
  "upload": {
    "total": 100,
    "split": 10,
    "ready": 85,
    "error": 5
  },
  "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 journal entry.

namestring

Name of the journal.

descriptionstring

A description of the journal entry.

notesstring nullable

Additional notes or comments about the journal entry.

status'Draft' | 'Deleted' | 'Error' | 'Validating' | 'Validated' | 'Review' | 'Reconciling' | 'Enquiring' | 'Generating' | 'Generated' | 'Accepted' | 'Queued' | 'Completed' | 'Resetting'

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

generation'V1' | 'V2' | 'V3'

Identifies the contract the charges in a journal were created under. Each generation is a fixed point in time: a journal keeps the generation its charges were produced with, and recalculating it does not move it forward. Add a member when the shape or meaning of charge data changes.

dueDatestring date-time

The due date for the journal entry.

Example response

{
  "id": "BJO-1234-1234",
  "name": "29 Nov 2024 #1",
  "description": "Monthly revenue journal entry",
  "externalIds": {
    "operations": "OPS-12345",
    "vendor": "VND-67890"
  },
  "notes": "Includes adjustments for Q1 2025",
  "dueDate": "2025-05-15T23:59:59+00:00",
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 1200
  },
  "upload": {
    "total": 100,
    "split": 10,
    "ready": 85,
    "error": 5
  },
  "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.