5.2 Emissão de boletos

Request

Request

mutation AddBilling {
    addBilling(
        data: {
            paymentPlanRefId: "a6814f33-7093-453d-9af8-899cafc1ddba"
            dueDate: "2023-12-17T00:00:00.000Z"
            value: 100
            discount: 10.00
            discountUntil: "2023-12-17T00:00:00.000Z"
        }
    ) {
        id
        barcode
        digitableLine
        pixCode
    }
}

Params

Parâmetro	Tipo	Descrição
data	AddBillingDataInput!	Dados de inclusão da cobrança

Objeto AddBillingDataInput

Campo	Tipo	Descrição
auditData	AuditDataInput	Dados de auditoria do sistema integrado
competenceDate	DateTime	Data de competência
deductedDiscountIds	[Int!]	Ids dos descontos deduzidos
description	String	Descrição
discount	Decimal	Desconto
discountUntil	DateTime	Data limite para aplicação do Desconto
dueDate	DateTime!	Data de vencimento
financialIntegrationId	Int	Id da integração financeira
financialIntegrationRefId	String	Id de referência da integração financeira
notes	String	Anotação
paymentPlanId	Int	Id do plano de Pagamento
paymentPlanRefId	String	Id de referência do plano de Pagamento
paymentType	PaymentType	Tipo de pagamento
punctualDiscountIds	[Int!]	Ids dos descontos por pontualidade
punctualDiscounts	[AddPunctualDiscountDataInput!]	Descontos por pontualidade
value	Decimal!	Valor

Response

Response

{
    "data": {
        "addBilling": {
            "id": "2d926cdb-5aac-40e1-a98f-29b6e76e7553",
            "barcode": "32997956700000100000001090000000072376287110",
            "digitableLine": "32990001039000000007623762871103795670000010000",
            "pixCode": null
        }
    }
}

Atenção

O campo id devolvido no Response, deverá ser informado no campo ref_id das demais Requests

Result

Campo	Tipo	Descrição
addBilling	AddBillingResult!	Dados de retorno da inclusão da cobrança

Objeto AddBillingResult

Campo	Tipo	Descrição
barcode	String	Código de barras
billingStatus	BillingStatus	Status da cobrança
digitableLine	String	Linha digitável
id	UUID!	Id referência da cobrança gerada
pixCode	String	Código de pix