Payment
Definition of a payment
This page contains
Fields
| id: ID! | |
| paymentNumber: String | |
| jbillingPaymentId: String | |
| amount: Decimal! | |
| dateTime: DateTime! | |
| status: String! | |
| invoices: [Invoice] PREVIEW | |
| paymentMethod: PaymentMethod! PREVIEW | |
| paymentType: String | |
| gatewayPaymentId: String | |
| gatewayConfiguration: GatewayConfiguration PREVIEW | |
| properties: [PaymentProperty] PREVIEW | |
| refundedPayment: Payment PREVIEW | |
| refunds: [Payment] PREVIEW | |
| message: String | |
| code: String | |
| coreCode: String | |
| currency: Currency | Payment currency, using the ISO-4217 currency code |
| intents: [PaymentIntent] PREVIEW | Intents for which payment was done, Intent can be USER/COMPANY/INVOICE |
| balanceCreatedOn: DateTime! PREVIEW | Creation date of the payment in customer balance service |
| balanceUpdatedOn: DateTime! PREVIEW | Last updated date of the payment in customer balance service |
| customer: BalanceCustomer! PREVIEW | Customer |
| balanceLedgers(withHistory: Boolean): [PaymentBalanceLedger] | List payment balances |
| balanceStatus: String! PREVIEW | Payment balance status |
| appliedToInvoices: [AppliedToInvoice] PREVIEW | Invoices the payment was applied to |
Implements
Parent objects of Payment
| AppliedPayment PREVIEW | Definition of an applied payment |
| BalancePaymentConnection PREVIEW | |
| CreditMemo PREVIEW | Definition of an credit memo |
| Payment PREVIEW | Definition of a payment |
| PaymentConnection PREVIEW | |
| RefundProperties PREVIEW | Definition of credit memo refund properties |
Mutations for Payment
| createPayment PREVIEW | Create a payment for an intent, e.g. USER, COMPANY, INVOICE |
| createRefundPayment PREVIEW | Create a refund payment for an intent, e.g. USER, COMPANY, INVOICE |
| updateOffPlatformPayment PREVIEW | Update off-platform payment |
Queries for Payment
| creditMemo PREVIEW | Retrieve a Credit Memo by id |
| payment PREVIEW | Retrieve a payment by id |
| paymentByPaymentNumber PREVIEW | Retrieve a payment by payment number |
| payments PREVIEW | Retrieve list of payments by marketplace |
| paymentsByCompanyId PREVIEW | Retrieve list of payments by companyId |
| paymentsByUserAndCompanyId PREVIEW | Retrieve list of payments by companyId and userId |