Invoice
@TODO DESCRIBE ME




POST as x-www-form-urlencoded:

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


Invoice

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
sendAtdate and time to send message
chargeExpirationdate and time to expire the charge
invoiceNumberinvoice number
amountamount to be charged
statusinvoice status
discountTypetype of discount
discountValuediscount value
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
paymentMethodscustom payment method defined for this charge
absorbedFeewhich payment method will have its fee absorbed by default
amountWithDiscountTotal amount of interest applied discounts
amountWithIntestAndFineTotal amount of interest applied interest and fines
originalChargeExpirationoriginal date and time to expire the charge
logsLogs
contractcontract related to invoice
discountsdiscounts created for invoice
chargescharges associated with invoice
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

CreateInvoiceInput

ArgumentsTypeDescription
contractId
Not Null
contract ID
organizationAccountId
Not Null
organization account ID
sendAt
String
SCALAR
date and time to send message
chargeExpiration
String
SCALAR
date and time to expire the charge
invoiceNumber
Int
SCALAR
invoice number
amount
Float
SCALAR
amount to be charged
status
InvoiceStatus
ENUM
invoice status
discountType
DiscountType
ENUM
type of discount
discountValue
Float
SCALAR
discount value
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
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
discounts
LIST
InvoiceProductDiscountInput
clientMutationId
String
SCALAR

UpdateInvoiceInput

ArgumentsTypeDescription
id
Not Null
Invoice ID
sendAt
String
SCALAR
date and time to send message
chargeExpiration
String
SCALAR
date and time to expire the charge
invoiceNumber
Int
SCALAR
invoice number
amount
Float
SCALAR
amount to be charged
status
InvoiceStatus
ENUM
invoice status
discountType
DiscountType
ENUM
type of discount
discountValue
Float
SCALAR
discount value
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
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
discounts
LIST
InvoiceProductDiscountInput
clientMutationId
String
SCALAR

DeleteInvoiceInput

ArgumentsTypeDescription
id
Not Null
Invoice ID
clientMutationId
String
SCALAR