DeveloperPOST as x-www-form-urlencoded:
https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE&client_id=YOUR_CLIENT_ID
Charge@TODO DESCRIBE ME
Charge
| Params | Description |
|---|---|
| id | The ID of an object |
| dbId | Identifies the primary key from the database. |
| organizationAccountId | Organization account |
| invoiceId | invoice |
| name | Charge's name |
| description | Charge description |
| amount | Charge amount |
| currency | Charge currency |
| dateLimit | Limit date to pay charge |
| notifyAt | Date to notify users to pay charge |
| paymentMethods | custom payment method defined for this charge |
| absorbedFee | which payment method will have its fee absorbed by default |
| allowedInstallments | Number of allowed installments |
| anticipationDiscountUntil | Number of days before the expiration of a charge that the discount is still applied |
| anticipationDiscountType | Type of the discount (percentange or amount) |
| anticipationDiscountValue | Discount value in percentage or total amount |
| fineStart | Number of days after the expiration of a charge that the fine should start |
| fineType | Type of the fine (percentange or amount) |
| fineValue | Fine value in percentage or total amount |
| interestStart | Number of days after the expiration of a charge that the interest should start |
| interestType | Type of the interest (percentange or amount) |
| interestValue | interest value in percentage or total amount |
| payableExpired | Whether the charge can be paid when expired or not |
| expired | date limit has passed |
| messageId | message associated |
| planId | plan associated |
| contractId | contract ssociated |
| account | Organization account the charge belongs to |
| message | Message the charge belongs to |
| plan | Plan the charge belongs to |
| invoice | invoice the charge belongs to |
| entities | Entities associated with survey |
| hasFine | if charge has fine or not |
| fineStartDate | Last date to pay with anticipation discount |
| hasInterest | if charge has fine or not |
| interestStartDate | Last date to pay with anticipation discount |
| hasAnticipationDiscount | if charge has fine or not |
| anticipationDiscountFinalDate | Last date to pay with anticipation discount |
| fineAmount | amount of fine applied to the payment |
| interestAmount | amount of interest applied to the payment |
| discountAmount | amount of interest applied to the payment |
| cardFee | amount of fee applied to the payment with card |
| boletoFee | amount of fee applied to the payment with boleto |
| cardAmount | amount of payment with card considering fee |
| paymentCardAmount | amount of payment with card considering fee, discount, fine and interest |
| organizationCardAmount | amount organization receives with charge is paid with card |
| boletoAmount | amount of the payment with boleto considering fee |
| paymentBoletoAmount | amount of payment with card considering fee, discount, fine and interest |
| organizationBoletoAmount | amount organization receives with charge is paid with boleto |
| minimumAmount | minimum amount of the available payment options |
| diferencePercentage | percentage difference between card and boleto amount |
| differenceAmount | difference between the card and boleto amount |
| minimumMethod | payment method with minimum value |
| paymentSituation | payment situation |
| payments | Payments made for charge |
| canRemind | can send remind notifications |
| chargeStatus | current status of the charge |
| created | An ISO-8601 encoded UTC date string of when record was created |
| modified | An ISO-8601 encoded UTC date string of when record was updated |
| deleted | An ISO-8601 encoded UTC date string of when record was deleted |
| key | Random ID to differentiate from others |
| selected | Helper field for clients |
| highlighted | Helper field for clients |
| expanded | Helper field for clients |
| loaded | Helper field for clients |
| loading | Helper field for clients |
UpdateChargeInput
| Arguments | Type | Description |
|---|---|---|
| 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
| Arguments | Type | Description |
|---|---|---|
| id | Not Null | The ID of a charge object |
| reason | String SCALAR | Reason for changing charge |
| clientMutationId | String SCALAR |