Magidoc

Order
Object

Order model

Fields

#

id

Non-null

legacyId

Non-null

description

amount

Non-null

Base order amount (without platform tip)

taxAmount

Tax amount

totalAmount

Non-null

Total order amount, including all taxes and platform tip

quantity

nextChargeDate

tier

fromAccount

toAccount

transactions

Non-null

Transactions for this order ordered by createdAt ASC

createdAt

updatedAt

totalDonations

Non-null

WARNING: Total amount donated between collectives, though there will be edge cases especially when looking on the Order level, as the order id is not used in calculating this.

paymentMethod

hostFeePercent

Host fee percent attached to the Order.

platformTipAmount

Platform Tip attached to the Order.

platformTipEligible

tags

[ String ]!
Non-null

taxes

Non-null

membership

This represents a MemberOf relationship (ie: Collective backed by an Individual) attached to the Order.

permissions

Non-null

The permissions given to current logged in user for this order

accountingCategory

The accounting category attached to this order

activities

Non-null

The list of activities (ie. approved, edited, etc) for this Order ordered by date ascending

data

Data related to the order

customData

Custom data related to the order, based on the fields described by tier.customFields. Must be authenticated as an admin of the fromAccount or toAccount (returns null otherwise)

memo

Memo field which adds additional details about the order. For example in added funds this can be a note to mark what method (cheque, money order) the funds were received.

createdByAccount

The account who created this order

processedAt

Date the funds were received.

pendingContributionData

Data about the pending contribution

needsConfirmation

Whether the order needs confirmation (3DSecure/SCA)

comments

Returns the list of comments for this order, or null if user is not allowed to see them

Usages

#

References

#