Magidoc

Settlement
Object

A settlement is a payout from Orderchamp to the supplier. It nets the marketplace supplier invoices (what Orderchamp owes the supplier) against the commission invoices (what the supplier owes Orderchamp).

Fields

#

amount

Money !
Non-null

The net amount of the settlement.

createdAt

DateTime !
Non-null

currency

CurrencyCode

id

ID !
Non-null

ID of the object.

invoices

InvoiceConnection !
Non-null

The order invoices included in this settlement: marketplace supplier invoices and commission invoices. Amounts are always positive, use the invoice type to determine the direction. Fees that are not tied to an order (such as subscription or payout fees) are included in the settlement amount but not listed here.

invoicesCount

Int

isCredit

Boolean !
Non-null

True when the supplier owes Orderchamp instead of receiving a payout.

isPaid

Boolean !
Non-null

number

String !
Non-null

paidAt

DateTime

taxCountry

TaxCountryCode

updatedAt

DateTime !
Non-null

Interfaces

#

Also implements Node .

Usages

#

References

#