Refund

Represents a refund scoped to a nautical order, seller order, or order line.

type Refund implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  name: String!
  description: String!
  descriptionHtml: String!
  externalId: String
  token: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  status: RefundStatusEnum!
  refundType: RefundTypeEnum!
  orderId: ID!
  buyerId: ID
  order: NauticalOrder!
  buyer: User
  lines(
    before: String
    after: String
    first: Int
    last: Int
  ): RefundLineCountableConnection!
  payments(
    before: String
    after: String
    first: Int
    last: Int
  ): RefundPaymentCountableConnection!
}

Show more ↓

Fields

Refund.id ● ID! non-null scalar

The Globally Unique ID of this object

Refund.metadata ● [MetadataItem!]! non-null object

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

Refund.privateMetadata ● [MetadataItem!]! non-null object

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

Refund.name ● String! non-null scalar

Human readable name of the refund.

Refund.description ● String! non-null scalar

Refund description (plaintext).

Refund.descriptionHtml ● String! non-null scalar

Refund description (HTML).

Refund.externalId ● String scalar

External ID for synchronization.

Refund.token ● String! non-null scalar

Unique UUID for the refund.

Refund.createdAt ● DateTime! non-null scalar

When the refund was created.

Refund.updatedAt ● DateTime! non-null scalar

When the refund was last updated.

Refund.status ● RefundStatusEnum! non-null enum

Current status of the refund.

Refund.refundType ● RefundTypeEnum! non-null enum

Type of refund.

Refund.orderId ● ID! non-null scalar

ID of the nautical order.

Refund.buyerId ● ID scalar

ID of the buyer (if any).

Refund.order ● NauticalOrder! non-null object

The order that this refund is against.

Refund.buyer ● User object

The buyer who is receiving the refund.

Refund.lines ● RefundLineCountableConnection! non-null object

Refund line items.

Refund.lines.before ● String scalar

Returns the items in the list that come before the specified cursor.

Refund.lines.after ● String scalar

Returns the items in the list that come after the specified cursor.

Refund.lines.first ● Int scalar

Returns the first n items from the list.

Refund.lines.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Refund.payments ● RefundPaymentCountableConnection! non-null object

Refund payments.

Refund.payments.before ● String scalar

Returns the items in the list that come before the specified cursor.

Refund.payments.after ● String scalar

Returns the items in the list that come after the specified cursor.

Refund.payments.first ● Int scalar

Returns the first n items from the list.

Refund.payments.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

refund query

Member Of

InvoiceRequest object ● JournalEntry object ● NauticalOrder object ● RefundCountableEdge object ● RefundCreate object ● RefundLine object ● RefundLinesAdd object ● RefundLinesUpdate object ● RefundPayment object ● RefundPaymentsAdd object ● RefundPaymentsUpdate object ● RefundUpdate object