Journal

The Journal object is linked to an authorization and is created by vendors from the raw data available from their services.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) A unique identifier for the journal. No nesting exists for this identifier.
name	string, core	The name of the journal.
externalId	string	(Optional) The external identifier or reference number. This is an optional value to assist vendors in matching the journal with external ERP systems.
notes	string	(Optional) Journal notes added by the vendor when creating the journal.
status	enum	(Read-only) The status of the journal. Allowed values are: Draft Deleted Validating Validated Error Ready Review Enquiring Generating Generated Accepted Completed
vendor	object	(Read-only) Represents the vendor account object completed during the creation of a journal. Example: { "id": "ACC-1234-1234", "href": "/accounts/accounts/ACC-1234-1234", "name": "Microsoft", "icon": "/static/ACC-1234-1234/account.png" }
product	object	Represents the product object. Example: { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }
authorization	object	Represents the authorization object. Example: { "id": "AUT-1234-4567", "name": "Salesforce Enterprise License" }
dueDate	dateTime, core	The due date of a journal. Allowed values are generated according to authorization.
currency	string	The currency of the journal.
assignee	object	(Optional) Represents the user object. Example: { "id": "USR-1234-1234-1234", "name": "John Smith", "icon": "/static/users/USR-1234-1234-1234.icon.svg" }
audit	object	(Read-only) Represents the audit object. Allowed values are created or updated.
price	object	(Read-only) The priceSummary including the aggregated price values for all journal charges. Not all fields are visible to all actors. Example: { "totalPP": 229.8, "markup": 0.5013, "margin": 0.3339, "totalSP": 356.7 }
upload	object	(Read-only) The journalUploadSummary, including the total charges and counts of split, ready, and error charges. Only visible to SoftwareOne Operations and Vendor accounts. Example: { "total": 150, "split": 4, "ready": 144, "error": 6 }
processing	object	(Read-only) The processingSummary including the total charges and counts of ready, error, split, cancelled, and completed charges. Only visible to SoftwareOne Operations. Example: { "total": 150, "ready": 140, "error": 6, "split": 4, "cancelled": 2, "completed": 0 }
error	object	(Read-only) (Optional) Represents the billingEntityError object containing error details associated with the journal entry, if any.

Single Currency Price Summary object

This object contains the following attributes:

Field	Type	Description
totalPP	decimal	(Read-only) A sum of all purchase price values of all charges in the billing object. Only visible to SoftwareOne Operations and Vendor accounts.
markup	decimal	(Read-only)The average markup value among all charges in the billing object. Only visible to SoftwareOne Operations.
margin	decimal	(Read-only) The average margin value among all charges in the billing object. Only visible to SoftwareOne Operations.
totalBSP	decimal	(Read-only) A sum of all the selling price values of all charges in the billing object. Only visible to SoftwareOne Operations and Vendor accounts.

Multi Currency Price Summary object

Field	Type	Description
currency	object	(Read-only) Purchase and sale currency with conversion rate. Example: { "purchase": "EUR", "sale": "USD", "rate": 0.83 }
markup	decimal	(Read-only) Average markup value among all charges in the billing object. Only visible to SoftwareOne Operations.
margin	decimal	(Read-only) Average margin value among all charges in the billing object. Only visible to SoftwareOne Operations.
totalPP	decimal	(Read-only) Sum of all purchase price values of all charges in the billing object. Only visible to SoftwareOne Operations and Vendor accounts.
totalBSP	decimal	(Read-only) Sum of all BSP values of all charges in the billing object. Only visible to SoftwareOne Operations and Client accounts.
totalSP	decimal	(Read-only) Sum of all sell price values of all charges in the billing object. Only visible to SoftwareOne Operations and Client accounts

Price Currency object

Field	Type	Description
purchase	sting	A reference to the purchase currency.
sale	sting	A reference to the sale currency.
rate	decimal	(Read-only) A conversion rate between purchase and sale currency.

Journal Upload Summary object

This object contains the following attributes:

Field	Type	Description
total	integer	(Read-only) Number of charges in the billing object.
split	integer	(Read-only) Number of split charges.
ready	integer	(Read-only) Number of ready charges.
error	integer	(Read-only) Number of error charges.

Processing Summary object

This object contains the following attributes:

Field	Type	Description
total	integer	(Read-only) The total number of charges within the billing object.
ready	integer	(Read-only) The total number of ready charges.
error	integer	(Read-only) The total number of error charges.
split	integer	(Read-only) The total number of split charges.
cancelled	integer	(Read-only) The total number of cancelled charges.
completed	integer	(Read-only) The total number of completed charges.

Example

JOURNAL OBJECT

{
    "id": "BJO-1234-5678",
    "name": "29 Nov 2024 #1",
    "externalIds": {
      "vendor": "bill-12345609",
      "operations": "SO-1234-1234-1111"
    },
    "notes": "This is new billing data for November",
    "status": "Accepted",
    "vendor": {
        "id": "ACC-9566-7072",
        "type": "Vendor",
        "status": "Active",
        "name": "Vikings"
    },
    "owner": {
        "id": "SEL-0209-5314",
        "address": {
            "country": "PL"
        },
        "name": "20 Adam's buyer",
        "icon": "/v1/accounts/sellers/SEL-0209-5314/icon"
    },  
    "product": {
        "id": "PRD-5771-7575",
        "name": "Valhalla",
        "externalIds": {},
        "icon": "/v1/catalog/products/PRD-5771-7575/icon",
        "status": "Published"
    },
    "authorization": {
        "id": "AUT-4320-7499",
        "name": "Vikings",
        "currency": "EUR"
    },
    "dueDate": "2024-12-29T09:09:30.087Z",
    "assignee": {
        "id": "USR-1234-1234-1234",
        "name": "John Smith",
        "icon": "/static/users/USR-1234-1234-1234.icon.svg"
    },
    "audit": {
        "created": {
            "at": "...",
            "by": {}
        },
        "updated": {
            "at": "...",
            "by": {}
        }
    },
    "priceSummary": {
        "totalPP": 229.8,
        "markup": 0.5013,
        "margin": 0.3339,
        "totalSP": 356.7,
        "currency": "EUR",
    },
    "uploadSummary": {
        "total": 150,
        "split": 4,
        "ready": 144,
        "error": 6
    },
    "processingSummary": {
        "total": 150,
        "ready": 140,
        "error": 6,
        "split": 4,
        "skipped": 2
    }
}