Charge
@TODO DESCRIBE ME




POST as x-www-form-urlencoded:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE&client_id=YOUR_CLIENT_ID


Charge

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
organizationAccountIdOrganization account
invoiceIdinvoice
nameCharge's name
descriptionCharge description
amountCharge amount
currencyCharge currency
dateLimitLimit date to pay charge
notifyAtDate to notify users to pay charge
paymentMethodscustom payment method defined for this charge
absorbedFeewhich payment method will have its fee absorbed by default
allowedInstallmentsNumber of allowed installments
anticipationDiscountUntilNumber of days before the expiration of a charge that the discount is still applied
anticipationDiscountTypeType of the discount (percentange or amount)
anticipationDiscountValueDiscount value in percentage or total amount
fineStartNumber of days after the expiration of a charge that the fine should start
fineTypeType of the fine (percentange or amount)
fineValueFine value in percentage or total amount
interestStartNumber of days after the expiration of a charge that the interest should start
interestTypeType of the interest (percentange or amount)
interestValueinterest value in percentage or total amount
payableExpiredWhether the charge can be paid when expired or not
expireddate limit has passed
messageIdmessage associated
planIdplan associated
contractIdcontract ssociated
accountOrganization account the charge belongs to
messageMessage the charge belongs to
planPlan the charge belongs to
invoiceinvoice the charge belongs to
entitiesEntities associated with survey
hasFineif charge has fine or not
fineStartDateLast date to pay with anticipation discount
hasInterestif charge has fine or not
interestStartDateLast date to pay with anticipation discount
hasAnticipationDiscountif charge has fine or not
anticipationDiscountFinalDateLast date to pay with anticipation discount
fineAmountamount of fine applied to the payment
interestAmountamount of interest applied to the payment
discountAmountamount of interest applied to the payment
cardFeeamount of fee applied to the payment with card
boletoFeeamount of fee applied to the payment with boleto
cardAmountamount of payment with card considering fee
paymentCardAmountamount of payment with card considering fee, discount, fine and interest
organizationCardAmountamount organization receives with charge is paid with card
boletoAmountamount of the payment with boleto considering fee
paymentBoletoAmountamount of payment with card considering fee, discount, fine and interest
organizationBoletoAmountamount organization receives with charge is paid with boleto
minimumAmountminimum amount of the available payment options
diferencePercentagepercentage difference between card and boleto amount
differenceAmountdifference between the card and boleto amount
minimumMethodpayment method with minimum value
paymentSituationpayment situation
paymentsPayments made for charge
canRemindcan send remind notifications
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

UpdateChargeInput

ArgumentsTypeDescription
id
ID
SCALAR
organizationAccountId
ID
SCALAR
Organization account
invoiceId
ID
SCALAR
invoice
name
String
SCALAR
Charge's name
description
String
SCALAR
Charge description
amount
Float
SCALAR
Charge amount
dateLimit
String
SCALAR
Date limit to pay charge
notifyAt
String
SCALAR
Date to notify users to pay charge
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
allowedInstallments
Int
SCALAR
Number of allowed installments
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
payableExpired
Boolean
SCALAR
Whether the charge can be paid when expired or not
reason
String
SCALAR
Reason for changing charge
remindPending
remindPending
INPUT_OBJECT
Remind pending entities
clientMutationId
String
SCALAR

DeleteChargeInput

ArgumentsTypeDescription
id
Not Null
The ID of a charge object
reason
String
SCALAR
Reason for changing charge
clientMutationId
String
SCALAR