Skip to main content

JournalEntry

Represents a journal entry in the system.

type JournalEntry implements Node, ObjectWithMetadata {
id: ID!
metadata: [MetadataItem!]!
privateMetadata: [MetadataItem!]!
createdAt: DateTime!
updatedAt: DateTime!
description: String!
fulfillmentLine: FulfillmentLine
nauticalOrder: NauticalOrder
order: Order
orderLine: OrderLine
payment: Payment
refund: Refund
refundLine: RefundLine
vendorPayout: VendorPayout
type: JournalEntryTypeEnum!
ledgerEntries: [LedgerEntry!]!
}

Fields​

JournalEntry.id ● ID! non-null scalar​

The Globally Unique ID of this object

JournalEntry.metadata ● [MetadataItem!]! non-null object​

List of public metadata items. Can be accessed without permissions.

JournalEntry.privateMetadata ● [MetadataItem!]! non-null object​

List of private metadata items. Requires proper staff permissions to access.

JournalEntry.createdAt ● DateTime! non-null scalar​

When the entry was created

JournalEntry.updatedAt ● DateTime! non-null scalar​

When the entry was last updated

JournalEntry.description ● String! non-null scalar​

Description of the journal entry

JournalEntry.fulfillmentLine ● FulfillmentLine object​

Related fulfillment line

JournalEntry.nauticalOrder ● NauticalOrder object​

Related nautical order

JournalEntry.order ● Order object​

Related order

JournalEntry.orderLine ● OrderLine object​

Related order line

JournalEntry.payment ● Payment object​

Related payment

JournalEntry.refund ● Refund object​

Related refund

JournalEntry.refundLine ● RefundLine object​

Related refund line

JournalEntry.vendorPayout ● VendorPayout object​

Related vendor payout

JournalEntry.type ● JournalEntryTypeEnum! non-null enum​

Type of the journal entry

JournalEntry.ledgerEntries ● [LedgerEntry!]! non-null object​

Ledger entries for this journal entry

Interfaces​

Node interface​

An object with a Globally Unique ID

ObjectWithMetadata interface​

An object that supports metadata.

Member Of​

JournalEntryCorrect object ● JournalEntryCountableEdge object ● LedgerEntry object

Was this page helpful?