Journal
The Journal object is linked to an authorization and is created by vendors from the raw data available from their services.
id
string
A unique identifier for the journal. Note that no nesting exists for this identifier.
Example: BJO-1234-5678
name
string
The name of the journal.
Example: 29 Nov 2024 #1
externalId
string
The external identifier or reference number. This is an optional value to assist vendors in matching the journal with external ERP systems.
Example: bill-12345609
notes
string
The journal notes added by the vendor during the creation of the journal.
Example: This is new billing data for November.
status
enum
Journal's status. Possible values: Draft, Deleted, Validating, Validated, Error, Ready, Review, Enquiring, Generating, Generated, Accepted, or Completed.
vendor
A reference to the vendor account object completed during the creation of a journal.
Example:
product
A reference to the Product object.
Example:
authorization
A reference to the Authorization object.
Example:
dueDate
dateTime
The due date of a journal. Possible values are generated according to Authorization.
Example: 2024-12-29T09:09:30.087Z
currency
string
The currency of the journal.
Example: EUR
assignee
A reference to the User object.
Example:
audit
A reference to the Audit object.
Possible values: Created or Updated.
Example:
price
The price summary including the aggregated price values for all journal charges.
Note that not all fields are visible to all actors.
Example:
upload
The journal upload summary, including the total charges and counts of split, ready, and error charges.
Only visible to SoftwareOne Operations and Vendor accounts.
Example:
processing
The journal processing summary including the total charges and counts of ready, error, split, cancelled, and completed charges.
Only visible to SoftwareOne Operations.
Example:
PriceSummary
totalPP
decimal
A sum of all purchase price values of all charges in the billing object. Only visible to SoftwareOne Operations and Vendor accounts.
Example: 229.8
markup
decimal
The average markup value among all charges in the billing object. Only visible to SoftwareOne Operations.
Example: 0.5013
margin
decimal
The average margin value among all charges in the billing object. Only visible to SoftwareOne Operations.
Example: 0.3339
totalSP
decimal
A sum of all the selling price values of all charges in the billing object. Only visible to SoftwareOne Operations and Vendor accounts.
Example: 356.7
JournalUploadSummary
total
integer
The number of charges in the billing object.
Example: 150
split
integer
The number of split charges.
Example: 4
ready
integer
The number of ready charges.
Example: 144
error
integer
The number of error charges.
Example: 6
ProcessingSummary
total
integer
The total number of charges within the billing object.
Example: 150
ready
integer
The total number of ready charges.
Example: 140
error
integer
The total number of error charges.
Example: 6
split
integer
The total number of split charges.
Example: 4
cancelled
integer
The total number of cancelled charges.
Example: 2
completed
integer
The total number of completed charges.
Example: 0
Example
Journal object
{
"id": "BJO-1234-5678",
"name": "29 Nov 2024 #1",
"externalId": "bill-12345609",
"notes": "This is new billing data for November",
"status": "Accepted",
"vendor": {
"id": "ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC1234-1234/account.png"
},
"product": {
"id": "PRD-1111-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD1111-1111-1111/logo.png"
},
"authorization": {
"id": "AUT-1234-4567",
"name": "Salesforce Enterprise License"
},
"dueDate": "2024-12-29T09:09:30.087Z",
"currency": "EUR",
"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
},
"uploadSummary": {
"total": 150,
"split": 4,
"ready": 144,
"error": 6
},
"processingSummary": {
"total": 150,
"ready": 140,
"error": 6,
"split": 4,
"cancelled": 2,
"completed": 0
}
}
Last updated
Was this helpful?