Skip to main content
objectPayment

Fields

id
ID!

The ID of the payment.

kind
String!

What the payment stands for. Known values: REGULAR, DUNNING_FEE_PAYMENT, CASH_DISCOUNT, VOUCHER_REDEMPTION. Treat unknown values as unknown.

Whether money came in or went out; follows from the sign of 'amount'.

amount
Decimal!

The amount with two decimals: positive for money received, negative for money paid back.

currencyCode
String!

The currency of the amount (ISO 4217): the currency of the document the payment counts for.

paymentDate
DateTime

The date of the payment. Can be empty for old records that were imported without one.

paymentMethodId
ID

The payment method. Can be empty for old records that were imported without one.

documentType
String!

The kind of sales document the payment counts for. Known values: SALES_ORDER, SALES_INVOICE, SALES_INVOICE_CORRECTION, SALES_CREDIT_NOTE.

salesOrderId
ID

The sales order of the payment. Also set for most payments of its invoices and corrections; never for credit notes.

salesInvoiceId
ID

The sales invoice the payment counts for; for a payment of an invoice correction, the corrected invoice when it is known.

salesInvoiceCorrectionId
ID

The sales invoice correction the payment counts for. Never a sales credit note.

salesCreditNoteId
ID

The sales credit note the payment counts for. Only payouts count for one; when it is cancelled, they leave QueryPayments.

externalTransactionId
String

The ID of the transaction at the payment provider, the marketplace or the bank, as it was delivered. For some shop orders it holds the payment note of the shop instead.

note
String

A free note.

isDownPayment
Boolean!

Whether the payment is a down payment. A label for accounting; it does not change how the payment counts.

generalLedgerAccount
String

The general ledger account the payment is posted to in the accounting export.

isExcludedFromAccountingExport
Boolean!

Whether the payment is left out of the accounting export.

paymentTransactionId
ID

The payment transaction (bank, payment provider or marketplace) the payment was created from or matched with.

refundId
ID

The refund that booked this payment.

createdBy
ID

The user who recorded the payment.