5.6 Consultar boletos

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	BillingFilterInput	Objeto que define os critérios de filtragem para as cobranças.
order	[BillingSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto BillingFilterInput

Campo	Tipo	Descrição
active	BooleanOperationFilterInput	Indica se a cobrança está ativa
amountPaid	DecimalOperationFilterInput	Valor pago
and	[BillingFilterInput!]
apiRequestLogs	ListFilterInputTypeOfApiRequestLogFilterInput
atmPayment	AtmPaymentFilterInput	Dados do pagamento em ATM
atmPaymentId	IntOperationFilterInput	Id do pagamento em ATM
barcode	StringOperationFilterInput	Código de barras
barcodeUrl	StringOperationFilterInput	Url do código de barras
billingAgreements	ListFilterInputTypeOfBillingAgreementFilterInput	Acordos associados à cobrança
billingStatus	NullableOfBillingStatusOperationFilterInput	Status da cobrança
cancelAfterRegister	BooleanOperationFilterInput	Marca a cobrança para ser cancelada após o registro
cancellationDescription	StringOperationFilterInput	Descrição do motivo de cancelamento
cancellationReason	NullableOfCancellationReasonOperationFilterInput	Motivo de cancelamento
changes	ListFilterInputTypeOfLogHistoryFilterInput	Histórico de alterações
competenceDate	DateTimeOperationFilterInput	Data de competência
creationDate	DateTimeOperationFilterInput	Data de Criação
deductedDiscounts	ListFilterInputTypeOfDeductedDiscountFilterInput	Descontos deduzidos
deleted	BooleanOperationFilterInput	Status de Deleção
description	StringOperationFilterInput	Descrição
digitableLine	StringOperationFilterInput	Linha digitável
discount	DecimalOperationFilterInput	Desconto
documentCode	StringOperationFilterInput	Código do documento
dueDate	DateTimeOperationFilterInput	Data de vencimento
externalId	IntOperationFilterInput	Id Externo
externalToken	StringOperationFilterInput	Token externo
financialIntegration	FinancialIntegrationFilterInput	Dados da integração financeira
financialIntegrationId	IntOperationFilterInput	Id da integração financeira
financialOwner	FinancialOwnerFilterInput	Dados do responsável financeiro
financialOwnerId	IntOperationFilterInput	Id do responsável financeiro
fineValue	DecimalOperationFilterInput	Multa
firstBilling	BillingFilterInput	Primeira cobrança
firstBillingId	IntOperationFilterInput	Id da primeira cobrança
graphQLRequestLogs	ListFilterInputTypeOfGraphQLRequestLogFilterInput
hasRefund	BooleanOperationFilterInput	Marca se a cobrança foi estornada
id	IntOperationFilterInput	Id do objeto da Requisição
interestPercentage	DecimalOperationFilterInput	Porcentagem de Juros
interestValue	DecimalOperationFilterInput	Juros
isFromAgreement	BooleanOperationFilterInput	Indica se o boleto foi gerado por um acordo
isManualPayment	BooleanOperationFilterInput	Indicador de pagamento manual
lastUpdateDate	DateTimeOperationFilterInput	Data da ultima atualização
nn	StringOperationFilterInput	Nosso número
or	[BillingFilterInput!]
originalValue	DecimalOperationFilterInput	Valor original
parentBilling	BillingFilterInput	Cobrança pai
parentBillingId	IntOperationFilterInput	Id da cobrança pai
paymentDate	DateTimeOperationFilterInput	Data do pagamento
paymentPlan	PaymentPlanFilterInput	Dados do plano de pagamento
paymentPlanId	IntOperationFilterInput	Id do plano de pagamento
paymentType	NullableOfPaymentTypeOperationFilterInput	Tipo de pagamento
pixCode	StringOperationFilterInput	Código do Pix
punctualDiscounts	ListFilterInputTypeOfPunctualDiscountFilterInput	Descontos pontualidade
refId	UuidOperationFilterInput	Id da Referência
refundDate	DateTimeOperationFilterInput	Data do estorno
refundDescription	StringOperationFilterInput	Descrição do motivo de estorno
refundReason	NullableOfRefundReasonOperationFilterInput	Motivo do estorno
refundValue	DecimalOperationFilterInput	Valor estornado
reissueDescription	StringOperationFilterInput	Descrição do motivo da 2ª via
reissueReason	NullableOfReissueReasonOperationFilterInput	Motivo da 2ª via
value	DecimalOperationFilterInput	Valor

Objeto BillingSortInput

Campo	Tipo	Descrição
active	SortEnumType	Status de Ativação
amountPaid	SortEnumType	Valor pago
and	[BillingFilterInput!]
apiRequestLogs	ListFilterInputTypeOfApiRequestLogFilterInput
atmPayment	AtmPaymentSortInput	Dados do pagamento em ATM
atmPaymentId	SortEnumType	Id do pagamento em ATM
barcode	SortEnumType	Código de barras
barcodeUrl	SortEnumType	Url do código de barras
billingAgreements	ListFilterInputTypeOfBillingAgreementFilterInput	Acordos associados à cobrança
billingStatus	SortEnumType	Status da cobrança
cancelAfterRegister	SortEnumType	Marca a cobrança para ser cancelada após o registro
cancellationDescription	SortEnumType	Descrição do motivo de cancelamento
cancellationReason	SortEnumType	Motivo de cancelamento
changes	ListFilterInputTypeOfLogHistoryFilterInput	Histórico de alterações
competenceDate	SortEnumType	Data de competência
creationDate	SortEnumType	Data de Criação
deductedDiscounts	ListFilterInputTypeOfDeductedDiscountFilterInput	Descontos deduzidos
deleted	SortEnumType	Status de Deleção
description	SortEnumType	Descrição
digitableLine	SortEnumType	Linha digitável
discount	SortEnumType	Desconto
documentCode	SortEnumType	Código do documento
dueDate	SortEnumType	Data de vencimento
externalId	SortEnumType	Id Externo
externalToken	SortEnumType	Token externo
financialIntegration	FinancialIntegrationSortInput	Dados da integração financeira
financialIntegrationId	SortEnumType	Id da integração financeira
financialOwner	FinancialOwnerSortInput	Dados do responsável financeiro
financialOwnerId	SortEnumType	Id do responsável financeiro
fineValue	SortEnumType	Multa
firstBilling	BillingSortInput	Primeira cobrança
firstBillingId	SortEnumType	Id da primeira cobrança
graphQLRequestLogs	ListFilterInputTypeOfGraphQLRequestLogFilterInput
hasRefund	SortEnumType	Marca se a cobrança foi estornada
id	SortEnumType	Id do objeto da Requisição
interestPercentage	SortEnumType	Porcentagem de Juros
interestValue	SortEnumType	Juros
isFromAgreement	SortEnumType	Indica se o boleto foi gerado por um acordo
isManualPayment	SortEnumType	Indicador de pagamento manual
lastUpdateDate	SortEnumType	Data da ultima atualização
nn	SortEnumType	Nosso número
or	[BillingFilterInput!]
originalValue	SortEnumType	Valor original
parentBilling	BillingSortInput	Cobrança pai
parentBillingId	SortEnumType	Id da cobrança pai
paymentDate	SortEnumType	Data do pagamento
paymentPlan	PaymentPlanSortInput	Dados do plano de pagamento
paymentPlanId	SortEnumType	Id do plano de pagamento
paymentType	SortEnumType	Tipo de pagamento
pixCode	SortEnumType	Código do Pix
punctualDiscounts	ListFilterInputTypeOfPunctualDiscountFilterInput	Descontos pontualidade
refId	SortEnumType	Id da Referência
refundDate	SortEnumType	Data do estorno
refundDescription	SortEnumType	Descrição do motivo de estorno
refundReason	NullableOfRefundReasonOperationFilterInput	Motivo do estorno
refundValue	SortEnumType	Valor estornado
reissueDescription	SortEnumType	Descrição do motivo da 2ª via
reissueReason	NullableOfReissueReasonOperationFilterInput	Motivo da 2ª via
value	SortEnumType	Valor

Result

Campo	Tipo	Descrição
billings	BillingsCollectionSegment	Coleção de cobranças

Objeto BillingsCollectionSegment

Campo	Tipo	Descrição
items	[Billing!]	Lista de objetos do tipo "Billing".
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.

Exemplos

Consultar boletos filtrando por status e cpf do responsável financeiro

Request

query Billings {
  billings(
    skip: 0
    take: 100
    where: {
      billingStatus: { in: [PENDING, OVERDUE, EXPIRED] }
      financialOwner: { cpf: { eq: "02176074033" } }
    }
    order: [
      { financialOwner: { name: ASC } }
      { paymentPlan: { dependent: { name: ASC } } }
    ]
  ) {
    items {
      refId
      dueDate
      billingStatus
      value
      interestValue
      fineValue
      calculatedIncreaseValue
      calculatedFineValue
      updatedValue
      barcode
      digitableLine
      pixCode
      financialOwner {
        refId
        name
        cpf
        email
      }
      paymentPlan {
        refId
        dependent {
          refId
          name
          cpf
          customFields {
            customField {
              label
            }
            content
          }
        }
        company {
          name
          companyName
        }
        costCenter {
          name
          refId
        }
      }
      punctualDiscounts {
        value
        isPercentage
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
    totalCount
  }
}

Response

{
  "data": {
    "billings": {
      "items": [
        {
          "refId": "5cf33ff7-6fb9-49b1-b8a5-03f155eedd19",
          "dueDate": "2023-10-25T00:00:00.000Z",
          "billingStatus": "PENDING",
          "value": 50,
          "interestValue": 0.02,
          "fineValue": 2,
          "calculatedIncreaseValue": 0.24,
          "calculatedFineValue": 1,
          "updatedValue": 51.24,
          "barcode": "32991951400000050000001090000000069376287110",
          "digitableLine": "32990001039000000006893762871106195140000005000",
          "pixCode": null,
          "financialOwner": {
            "refId": "f09aeac5-f3f5-4a5a-861b-bf55604b54e5",
            "name": "Bruna Barros",
            "cpf": "02176074033",
            "email": "ricardo@sistemaegd.com.br"
          },
          "paymentPlan": {
            "refId": "a6814f33-7093-453d-9af8-899cafc1ddba",
            "dependent": {
              "refId": "d40c654c-af5b-480b-a60c-734f2a74dbde",
              "name": "Arnaldo Pires Silva",
              "cpf": null,
              "customFields": [
                {
                  "customField": {
                    "label": "Matrícula"
                  },
                  "content": "1025"
                },
                {
                  "customField": {
                    "label": "Turma"
                  },
                  "content": "1ª Série"
                }
              ]
            },
            "company": {
              "name": "Escola teste",
              "companyName": "TESTE LTDA"
            },
            "costCenter": {
              "name": "Mensalidades",
              "refId": "8a57c338-d125-4b24-b26d-dc4448ec3581"
            }
          },
          "punctualDiscounts": [
            {
              "value": 10,
              "isPercentage": false
            }
          ]
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "totalCount": 11
    }
  }
}

Consultar boletos filtrando por status e matrícula

Request

query Billings {
  billings(
    skip: 0
    take: 100
    where: {
      billingStatus: { in: [PENDING, OVERDUE, EXPIRED] }
      paymentPlan: {
        dependent: {
          customFields: {
            some: {
              customField: { label: { eq: "Matrícula" } }
              content: { eq: "1025" }
            }
          }
        }
      }
    }
    order: [
      { financialOwner: { name: ASC } }
      { paymentPlan: { dependent: { name: ASC } } }
    ]
  ) {
    items {
      refId
      dueDate
      billingStatus
      value
      interestValue
      fineValue
      calculatedIncreaseValue
      calculatedFineValue
      updatedValue
      barcode
      digitableLine
      pixCode
      financialOwner {
        refId
        name
        cpf
        email
      }
      paymentPlan {
        refId
        dependent {
          refId
          name
          cpf
          customFields {
            customField {
              label
            }
            content
          }
        }
        company {
          name
          companyName
        }
        costCenter {
          name
          refId
        }
      }
      punctualDiscounts {
        value
        isPercentage
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
    totalCount
  }
}

Response

{
  "data": {
    "billings": {
      "items": [
        {
          "refId": "5cf33ff7-6fb9-49b1-b8a5-03f155eedd19",
          "dueDate": "2023-10-25T00:00:00.000Z",
          "billingStatus": "PENDING",
          "value": 50,
          "interestValue": 0.02,
          "fineValue": 2,
          "calculatedIncreaseValue": 0.24,
          "calculatedFineValue": 1,
          "updatedValue": 51.24,
          "barcode": "32991951400000050000001090000000069376287110",
          "digitableLine": "32990001039000000006893762871106195140000005000",
          "pixCode": null,
          "financialOwner": {
            "refId": "f09aeac5-f3f5-4a5a-861b-bf55604b54e5",
            "name": "Bruna Barros",
            "cpf": "02176074033",
            "email": "ricardo@sistemaegd.com.br"
          },
          "paymentPlan": {
            "refId": "a6814f33-7093-453d-9af8-899cafc1ddba",
            "dependent": {
              "refId": "d40c654c-af5b-480b-a60c-734f2a74dbde",
              "name": "Arnaldo Pires Silva",
              "cpf": null,
              "customFields": [
                {
                  "customField": {
                    "label": "Matrícula"
                  },
                  "content": "1025"
                },
                {
                  "customField": {
                    "label": "Turma"
                  },
                  "content": "1ª Série"
                }
              ]
            },
            "company": {
              "name": "Escola teste",
              "companyName": "TESTE LTDA"
            },
            "costCenter": {
              "name": "Mensalidades",
              "refId": "8a57c338-d125-4b24-b26d-dc4448ec3581"
            }
          },
          "punctualDiscounts": [
            {
              "value": 10,
              "isPercentage": false
            }
          ]
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "totalCount": 11
    }
  }
}

Consultar boletos filtrando por status, cpf do responsável financeiro e matrícula

Request

query Billings {
  billings(
    skip: 0
    take: 1
    where: {
      billingStatus: { in: [PENDING, OVERDUE, EXPIRED] }
      financialOwner: { cpf: { eq: "02176074033" } }
      paymentPlan: {
        dependent: {
          customFields: {
            some: {
              customField: { label: { eq: "Matrícula" } }
              content: { eq: "1025" }
            }
          }
        }
      }
    }
    order: [
      { financialOwner: { name: ASC } }
      { paymentPlan: { dependent: { name: ASC } } }
    ]
  ) {
    items {
      refId
      dueDate
      billingStatus
      value
      interestValue
      fineValue
      calculatedIncreaseValue
      calculatedFineValue
      updatedValue
      barcode
      digitableLine
      pixCode
      financialOwner {
        refId
        name
        cpf
        email
      }
      paymentPlan {
        refId
        dependent {
          refId
          name
          cpf
          customFields {
            customField {
              label
            }
            content
          }
        }
        company {
          name
          companyName
        }
        costCenter {
          name
          refId
        }
      }
      punctualDiscounts {
        value
        isPercentage
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
    totalCount
  }
}

Response

{
  "data": {
    "billings": {
      "items": [
        {
          "refId": "5cf33ff7-6fb9-49b1-b8a5-03f155eedd19",
          "dueDate": "2023-10-25T00:00:00.000Z",
          "billingStatus": "PENDING",
          "value": 50,
          "interestValue": 0.02,
          "fineValue": 2,
          "calculatedIncreaseValue": 0.24,
          "calculatedFineValue": 1,
          "updatedValue": 51.24,
          "barcode": "32991951400000050000001090000000069376287110",
          "digitableLine": "32990001039000000006893762871106195140000005000",
          "pixCode": null,
          "financialOwner": {
            "refId": "f09aeac5-f3f5-4a5a-861b-bf55604b54e5",
            "name": "Bruna Barros",
            "cpf": "02176074033",
            "email": "ricardo@sistemaegd.com.br"
          },
          "paymentPlan": {
            "refId": "a6814f33-7093-453d-9af8-899cafc1ddba",
            "dependent": {
              "refId": "d40c654c-af5b-480b-a60c-734f2a74dbde",
              "name": "Arnaldo Pires Silva",
              "cpf": null,
              "customFields": [
                {
                  "customField": {
                    "label": "Matrícula"
                  },
                  "content": "1025"
                },
                {
                  "customField": {
                    "label": "Turma"
                  },
                  "content": "1ª Série"
                }
              ]
            },
            "company": {
              "name": "Escola teste",
              "companyName": "TESTE LTDA"
            },
            "costCenter": {
              "name": "Mensalidades",
              "refId": "8a57c338-d125-4b24-b26d-dc4448ec3581"
            }
          },
          "punctualDiscounts": [
            {
              "value": 10,
              "isPercentage": false
            }
          ]
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false
      },
      "totalCount": 11
    }
  }
}

Params​

Objeto BillingFilterInput​

Objeto BillingSortInput​

Result​

Objeto BillingsCollectionSegment​

Exemplos​

Consultar boletos filtrando por status e cpf do responsável financeiro​

Request​

Response​

Consultar boletos filtrando por status e matrícula​

Request​

Response​

Consultar boletos filtrando por status, cpf do responsável financeiro e matrícula​

Request​

Response​

Params

Objeto BillingFilterInput

Objeto BillingSortInput

Result

Objeto BillingsCollectionSegment

Exemplos

Consultar boletos filtrando por status e cpf do responsável financeiro

Request

Response

Consultar boletos filtrando por status e matrícula

Request

Response

Consultar boletos filtrando por status, cpf do responsável financeiro e matrícula

Request

Response