Ctrlk
Sign InJoin
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Export as PDF

Update journal

Updates an existing journal.

put

Updates journal properties. Only provided fields will be modified.

Path parameters
idstringRequired

The ID of the journal to update.

Body

Represents a journal entry in the billing system.

revisioninteger · int32Optional
idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234
namestringOptional

Name of the journal.

Example: 29 Nov 2024 #1
descriptionstringOptional

A description of the journal entry.

Example: Monthly revenue journal entry
notesstring · nullableOptional

Additional notes or comments about the journal entry.

Example: Includes adjustments for Q1 2025
statusstring · enumOptional

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

Possible values:
generationstring · enumOptional

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.

Possible values:
dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59+00:00
Responses
200

OK

application/json

Represents a journal entry in the billing system.

revisioninteger · int32Optional
idstringOptional

The unique identifier of the journal entry.

Example: BJO-1234-1234
namestringOptional

Name of the journal.

Example: 29 Nov 2024 #1
descriptionstringOptional

A description of the journal entry.

Example: Monthly revenue journal entry
notesstring · nullableOptional

Additional notes or comments about the journal entry.

Example: Includes adjustments for Q1 2025
statusstring · enumOptional

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

Possible values:
generationstring · enumOptional

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.

Possible values:
dueDatestring · date-timeOptional

The due date for the journal entry.

Example: 2025-05-15T23:59:59+00:00
put/public/v1/billing/journals/{id}
PUT /public/v1/billing/journals/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2616

{
  "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
      }
    },
    "draft": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "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
      }
    },
    "validating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "validated": {
      "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
      }
    },
    "enquiring": {
      "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
      }
    },
    "accepted": {
      "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": "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",
  "status": "Validated",
  "generation": "V2",
  "vendor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "owner": {
    "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"
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "currency": "text"
  },
  "dueDate": "2025-05-15T23:59:59+00:00",
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 1200,
    "currency": "text"
  },
  "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."
  },
  "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
      }
    },
    "draft": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "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
      }
    },
    "validating": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "validated": {
      "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
      }
    },
    "enquiring": {
      "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
      }
    },
    "accepted": {
      "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": "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",
  "status": "Validated",
  "generation": "V2",
  "vendor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "owner": {
    "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"
  },
  "authorization": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "currency": "text"
  },
  "dueDate": "2025-05-15T23:59:59+00:00",
  "assignee": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "price": {
    "markup": 15.5,
    "margin": 20,
    "totalPP": 1000,
    "totalBP": 1100,
    "totalBSP": 1200,
    "currency": "text"
  },
  "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."
  },
  "backup": {
    "status": "Pending",
    "date": "2026-01-01T00:00:00.000Z"
  }
}
PreviousGet journal
NextDelete journal

Last updated

Was this helpful?