15.1 Criar acordo

Request

Request

mutation CreateAgreement {
    createAgreement(
        data: {
            financialOwnerId: 68
            companyId: 10
            dependentId: 1560
            originalBillings: [
                {
                    billingId: 7102
                    discount: 10
                    discountTarget: ORIGINAL
                    fine: 20
                    interest: 8
                    paymentDate: "2026-01-09 11:30:00"
                }
                {
                    billingId: 7103
                    discount: 0
                    discountTarget: ORIGINAL
                    fine: 10
                    interest: 6
                    paymentDate: "2026-01-09 11:30:00"
                }
            ]
            paymentPlan: {
                parcelQuantity: 4
                paymentPlanType: MONTHLY
                costCenterName: "Mensalidades"
                newBillingsData: {
                    externalToken: "{{$guid}}"
                    paymentType: CARTAO_CREDITO
                    dueDate: "2026-01-08 00:00:00"
                    billingStatus: PAID
                    value: 32
                    discount: null
                    discountUntil: null
                    interestValue: null
                    fineValue: null
                }
            }
            requester: REVO
            bank: {
                name: "Banco teste"
                agency: "0001"
                account: "12345"
                accountType: CHECKING_ACCOUNT
            }
            agreementDate: "2026-01-09 00:00:00"
            bankPaymentDate: "2026-01-10 00:00:00"
        }
    ) {
        status
        financialOwnerId
        companyId
        breachDate
        breachReason
        breachDescription
        description
        requester
        agreementDate
        bankPaymentDate
        parcelQuantity
        id
        refId
        externalId
        creationDate
        active
        deleted
        lastUpdateDate
    }
}

Params

Parâmetro	Tipo	Descrição
data	CreateAgreementDataInput!	Dados de criação do acordo

Objeto CreateAgreementDataInput

Campo	Tipo	Obrigatório	Descrição
agreementDate	DateTime	Sim	Data do acordo
bank	BankInput	Sim	Conta de recebimento
bankPaymentDate	DateTime	Sim	Data do pagamento (banco para Kedu)
companyId	Int	Sim	Id da empresa
dependentId	Int	Não	Id do dependente
dependentRefId	String	Não	Id da Referência do dependente
description	String	Não	Descrição do acordo
financialOwnerId	Int	Não	Id do responsável financeiro
financialOwnerRefId	String	Não	Id da Referência do responsável financeiro
originalBillings	[AgreementBillingDataInput!]!	Sim	Informações de baixa dos boletos originais
paymentPlan	AddExternalPaymentPlanDataInput!	Sim	Plano de pagamento externo
requester	AgreementRequester	Não	Identificador de quem está solicitando o acordo

Objeto Bank

Campo	Tipo	Obrigatório	Descrição
name	String	Sim	Nome
agency	String	Sim	Agência
account	String	Sim	Conta
accountDescription	String	Não	Observações sobre a conta
accountType	AccountType	Sim	Tipo de Conta

Objeto AgreementBillingDataInput

Campo	Tipo	Obrigatório	Descrição
billingId	Int	Não	Id da cobrança
billingRefId	String	Não	RefId da cobrança
discount	Decimal	Não	Valor de desconto concedido
discountTarget	AgreementDiscountTarget	Não	Em que o desconto foi aplicado
fine	Decimal	Não	Multa
interest	Decimal	Não	Juros
paymentDate	DateTime	Sim	Data da baixa

Objeto AddExternalPaymentPlanDataInput

Campo	Tipo	Obrigatório	Descrição
description	String	Não	Descrição
parcelQuantity	Int	Não	Quantidade de Parcelas
paymentPlanType	PaymentPlanType	Sim	Tipo de Plano de Pagamento
costCenterId	Int	Não	Id do Centro de Custo
costCenterName	String	Não	Id do Nome do Centro de Custo
newBillingsData	[AddExternalBillingDataInput!]!	Sim	Dados dos novos boletos que farão parte do acordo
punctualDiscounts	[Int!]	Não	Descontos por Pontualidade
auditData	AuditDataInput	Não	Dados de auditoria do sistema integrado

Objeto AddExternalBillingDataInput

Campo	Tipo	Nulável	Descrição
externalToken	String	Não	Token externo
paymentType	PaymentType	Sim	Tipo de Pagamento
dueDate	DateTime	Não	Data de vencimento
billingStatus	BillingStatus	Sim	Status da cobrança
competenceDate	DateTime	Sim	Data de competência
description	String	Sim	Descrição
value	Decimal	Não	Valor
discount	Decimal	Sim	Desconto
discountUntil	DateTime	Sim	Data limite para aplicação do Desconto
punctualDiscountIds	[Int!]	Sim	Ids dos Descontos por Pontualidade
punctualDiscounts	[AddPunctualDiscountDataInput!]	Sim	Descontos por Pontualidade
notes	String	Sim	Anotação
interestValue	Decimal	Sim	Juros
fineValue	Decimal	Sim	Multa
paymentPlanId	Int	Sim	Id do Plano de Pagamento
paymentPlanRefId	String	Sim	Id da Referência do Plano de Pagamento
documentCode	String	Sim	Código do Documento
controlNumber	String	Sim	Código para Controle
barcode	String	Sim	Código de Barras
barcodeUrl	String	Sim	Url do Código de Barras
barcodeNumber	String	Sim	Número do Código de Barras
pixCode	String	Sim	Código do Pix
nn	String	Sim	Nosso Número
url	String	Sim	Url
auditData	AuditDataInput	Sim	Dados de auditoria do sistema integrado

Response

Response

{
    "data": {
        "createAgreement": {
            "status": "FINISHED",
            "financialOwnerId": 68,
            "companyId": 10,
            "breachDate": null,
            "breachReason": null,
            "breachDescription": null,
            "description": null,
            "requester": "REVO",
            "agreementDate": "2026-01-09T03:00:00.000Z",
            "bankPaymentDate": "2026-01-10T03:00:00.000Z",
            "parcelQuantity": 4,
            "id": 33,
            "refId": "afb03e95-7c33-4347-84de-eae22445b81b",
            "externalId": null,
            "creationDate": "2026-01-10T17:10:39.499Z",
            "active": true,
            "deleted": false,
            "lastUpdateDate": "2026-01-10T17:10:41.968Z"
        }
    }
}

Result

Campo	Tipo	Descrição
createAgreement	Agreement	Dados do acordo

Objeto Agreement

Campo	Tipo	Descrição
status	AgreementStatus	Status do acordo
financialOwnerId	Int	Id do responsável financeiro
financialOwner	FinancialOwner	Dados do responsável financeiro
companyId	Int	Id da Empresa
company	Company	Dados da Empresa
breachDate	DateTime	Data de quebra do acordo
breachReason	AgreementBreachReason	Motivo da quebra do acordo
breachDescription	String	Descrição do motivo da quebra
description	String	Observações do acordo
billingAgreements	[BillingAgreement!]!	Cobranças associadas ao acordo
requester	AgreementRequester	Identificador de quem está solicitando o acordo
bank	Bank	Conta de recebimento
agreementDate	DateTime	Data do acordo
bankPaymentDate	DateTime	Data do pagamento (banco para Kedu)
parcelQuantity	Int	Quantidade de parcelas do acordo
id	Int	Id do objeto da Requisição
refId	UUID	Id da Referência
externalId	Int	Id Externo
creationDate	DateTime	Data de Criação
active	Boolean	Status de Ativação
deleted	Boolean	Status de Deleção
changes	[LogHistory!]!	Histórico de alterações
lastUpdateDate	DateTime	Data da ultima atualização

Objeto BillingAgreement

Campo	Tipo	Descrição
id	Int	Identificador único do registro
creationDate	DateTime	Data de criação do registro
billingId	Int	Id da Cobrança
billing	Billing	Dados da Cobrança
totalValue	Decimal	Valor total calculado
interest	Decimal	Juros
fine	Decimal	Multa
discount	Decimal	Valor de desconto concedido
paymentDate	DateTime	Data da baixa
discountTarget	AgreementDiscountTarget	Em que o desconto foi apli