# Get Journal

## GET /public/v1/billing/journals/{id}

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"Marketplace API","version":"prod-4.0.104-g76805994"},"servers":[{"url":"https://api.platform.softwareone.com"}],"paths":{"/public/v1/billing/journals/{id}":{"get":{"tags":["Journals"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"select","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"$meta":{"allOf":[{"type":"object","properties":{"omitted":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}],"description":"Platform entity metadata.","nullable":true},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string","nullable":true}},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event for the creation of an entity."}],"description":"Contains details about the creation event of the entity."},"updated":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event for the update of an entity."}],"description":"Contains details about the most recent update event of the entity, if applicable.","nullable":true},"draft":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Draft\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Draft\" status.","nullable":true},"deleted":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Deleted\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Deleted\" status.","nullable":true},"error":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Error\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Error\" status.","nullable":true},"validating":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Validating\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Validating\" status.","nullable":true},"validated":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Validated\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Validated\" status.","nullable":true},"review":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Review\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Review\" status.","nullable":true},"enquiring":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Enquiring\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Enquiring\" status.","nullable":true},"generating":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Generating\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Generating\" status.","nullable":true},"generated":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Generated\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Generated\" status.","nullable":true},"accepted":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Accepted\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Accepted\" status.","nullable":true},"completed":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the journal reached the \"Completed\" status."}],"description":"Contains details about the most recent event when the journal reached the \"Completed\" status.","nullable":true}},"additionalProperties":false,"description":"Represents a container for audit-related events for a journal"}],"description":"Contains audit-related details for the entity."},"id":{"type":"string","description":"The unique identifier of the journal entry."},"name":{"type":"string","description":"Name of the journal."},"description":{"type":"string","description":"A description of the journal entry."},"externalIds":{"allOf":[{"type":"object","properties":{"operations":{"type":"string","description":"Represents the identifier used for operations in the billing system.","nullable":true},"vendor":{"type":"string","description":"Represents the identifier used for vendors in the billing system.","nullable":true}},"additionalProperties":false,"description":"Represents external identifiers associated with billing entities."}],"description":"External identifiers associated with the journal entry."},"notes":{"type":"string","description":"Additional notes or comments about the journal entry.","nullable":true},"status":{"allOf":[{"enum":["Draft","Deleted","Error","Validating","Validated","Review","Enquiring","Generating","Generated","Accepted","Completed"],"type":"string","description":"Represents the various statuses a journal can have in the billing system."}],"description":"The current status of the journal entry."},"vendor":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"type":{"allOf":[{"enum":["Client","Vendor","Operations"],"type":"string"}],"nullable":true},"status":{"allOf":[{"enum":["Active","Enabled","Disabled"],"type":"string"}],"nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false}]},"owner":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"name":{"type":"string"},"erpLink":{"allOf":[{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","nullable":true},"by":{"allOf":[{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"updated":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"$meta":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/$meta/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"name":{"type":"string"},"icon":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"updated":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"blocked":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"unblocked":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"$meta":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/$meta/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"icon":{"type":"string","nullable":true},"buyer":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false}]},"seller":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/owner/allOf/0/properties"},"additionalProperties":false}]},"name":{"type":"string"},"status":{"allOf":[{"enum":["Active","Blocked"],"type":"string"}]},"note":{"type":"string","nullable":true},"externalIds":{"allOf":[{"type":"object","properties":{"erpCompanyContact":{"type":"string","nullable":true},"erpCustomer":{"type":"string","nullable":true},"accountExternalId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"address":{"allOf":[{"type":"object","properties":{"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"product":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"externalIds":{"allOf":[{"type":"object","properties":{"operations":{"type":"string","nullable":true}},"additionalProperties":false}]},"icon":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false}]},"authorization":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"}},"additionalProperties":false}]},"dueDate":{"type":"string","description":"The due date for the journal entry.","format":"date-time"},"assignee":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1journals~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]},"price":{"allOf":[{"type":"object","properties":{"markup":{"type":"number","description":"Represents the markup value applied to the pricing, visible to operations.","format":"double"},"margin":{"type":"number","description":"Represents the margin value calculated for the pricing, visible to operations.","format":"double"},"totalPP":{"type":"number","description":"Represents the total purchase price, visible to vendors or operations.","format":"double"},"totalSP":{"type":"number","description":"Represents the total sale price, visible to clients or operations.","format":"double"},"currency":{"type":"string","description":"Specifies the currency used in the pricing summary."}},"additionalProperties":false,"description":"Represents a detailed summary of pricing."}],"description":"Pricing details associated with the journal entry."},"upload":{"allOf":[{"type":"object","properties":{"total":{"type":"integer","description":"The total number of items in the upload.","format":"int32"},"split":{"type":"integer","description":"The number of items that were split during the upload.","format":"int32"},"ready":{"type":"integer","description":"The number of items that are ready for processing.","format":"int32"},"error":{"type":"integer","description":"The number of items that encountered errors during the upload.","format":"int32"}},"additionalProperties":false,"description":"Represents a summary of the upload status for a journal entry."}],"description":"Upload summary details for the journal entry, visible to vendors or operations."},"processing":{"allOf":[{"type":"object","properties":{"total":{"type":"integer","description":"Indicates the total number of items involved in the processing.","format":"int32"},"ready":{"type":"integer","description":"Indicates the number of items that are ready for further processing.","format":"int32"},"error":{"type":"integer","description":"Indicates the number of items that encountered errors during processing.","format":"int32"},"split":{"type":"integer","description":"Indicates the number of items that were split into multiple parts during processing.","format":"int32"},"skipped":{"type":"integer","description":"Indicates the number of items that were skipped during processing.","format":"int32"}},"additionalProperties":false,"description":"Represents a summary of the processing status for various billing operations."}],"description":"Processing status and related details for the journal entry, visible to operations."},"error":{"allOf":[{"type":"object","properties":{"errorCode":{"type":"string","description":"Represents the error code associated with the billing entity."},"errorMessage":{"type":"string","description":"Represents the error message providing details about the issue."},"id":{"type":"string","description":"Represents the unique identifier for the error, if applicable.","nullable":true},"message":{"type":"string","description":"Represents the detailed message associated with the error, if applicable.","nullable":true}},"additionalProperties":false,"description":"Represents an error related to a billing entity."}],"description":"Error details associated with the journal entry, if any.","nullable":true}},"additionalProperties":false,"description":"Represents a journal entry in the billing system."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}}}}}}
```
