Skip to main content

ShipmentCourierPayment

Staff only (needs sales:sales_order:ship): the seller recorded paying the courier for this shipment. Recording only — the payment and its accounting stay in the seller's bank and accounting tools.

type ShipmentCourierPayment {
method: String!
paidOn: String!
recordedAt: DateTime
recordedById: String!
recordedByName: String
reference: String!
}

Fields​

ShipmentCourierPayment.method ● String! non-null scalar​

How it was paid, for example EFT, Card, Cash or Courier account.

The date the courier was paid, as YYYY-MM-DD.

ShipmentCourierPayment.recordedAt ● DateTime scalar​

When the payment was recorded.

ShipmentCourierPayment.recordedById ● String! non-null scalar​

The ID of the user who recorded it.

ShipmentCourierPayment.recordedByName ● String scalar​

The name of the user who recorded it.

ShipmentCourierPayment.reference ● String! non-null scalar​

The bank or courier reference. May be empty.

Member Of​

ShipmentGql object