--- title: "Consulta de fatura aberta" method: GET path: "/cards/invoices/document/{documentNumber}/proxy/{proxy}/open" tags: ["Consulta de faturas"] --- # Consulta de fatura aberta `GET /cards/invoices/document/{documentNumber}/proxy/{proxy}/open` ## Request - Base URL: `https://api-mtls.sandbox.bankly.com.br` - URL: `https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/open` - Auth: HTTP bearer

Consulte os dados de uma fatura em aberto (cycleType = “Open”) por meio do proxy do cartão e do número do documento de seu titular.

stable scope: invoice.read
[block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta de fatura aberta](/docs/consulta-de-fatura-aberta)." } [/block] ## Path parameters - `documentNumber` string, nullable, required: Número do documento do titular do cartão. - `proxy` string, nullable, required: Código identificador do cartão utilizado na transação. ## Parameters - `#/paths/~1cards~1invoices~1adjustments/post/parameters/1` (unresolved $ref) - `#/paths/~1cards~1invoices~1adjustments/post/parameters/0` (unresolved $ref) ## Response `200` Solicitação aceita com sucesso. - OpenInvoiceDto - `statementId` integer: Identificador único da fatura. - `month` integer: Mês de vencimento da fatura. - `year` integer: Ano de vencimento da fatura. - `cycle` integer: Indicador do ciclo da fatura (por contrato de crédito). - `cycleCloseDate` string, date-time, nullable: Data de fechamento da fatura. - `dueDateStart` string, date-time: Data inicial do período da fatura. - `dueDateEnd` string, date-time, nullable: Data final do período da fatura. - `dueDate` string, date-time: Data de vencimento da fatura. - `amountMinimal` number, double, nullable: Valor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura. - `previousBalance` object: Objeto que contém informações referentes ao valor total da fatura anterior. - `value` number: Valor total da fatura anterior. - `currency` string: Código da moeda com base na ISO-4217. - `balance` number, double, nullable: Valor total da fatura. - `cycleType` 'Open' | 'Future' | 'Closed' | 'DueDate': Situação da fatura. - `documentNumber` string, nullable: Número do documento do titular do cartão (CPF ou CNPJ). - `paymentStatus` 'Pending' | 'Paid' | 'PartialPaid': Situação do pagamento da fatura. - `elegibilityCompulsory` boolean: Sinaliza se a fatura é elegível (true) ou não (false) ao parcelamento compulsório. - `currentBalance` object: Objeto que contém informações referentes ao saldo atual da fatura. - `value` number: Saldo atual da fatura, considerando todos os valores creditados e/ou debitados. - `currency` string: Código da moeda com base na ISO-4217. - `statementItens` ItemInvoiceDto[], nullable - `statementNumber` integer: Número da parcela. - `statementTotal` integer: Total de parcelas. - `isCredit` boolean: Indica se é uma operação de crédito (true) ou débito (false). - `transactionDate` string, date-time: Data em que ocorreu a transação. - `createdAt` string, date-time: Data em que a transação foi postada em fatura. - `transactionType` 'REFINANCE_CHARGES' | 'INTEREST_ON_ARREST' | 'TRAFFIC_TICKET' | 'PURCHASE_BY_SIGHT' | 'INSTALLMENT_WITHOUT_INTEREST' | 'DEBIT_ADJUSTMENT' | 'INSTALLMENTS_WITHOUT_INTEREST' | 'INSTALLED_WITH_INTEREST' | 'PAYMENT' | 'CREDIT_ADJUSTMENT' | 'PARTIAL_CANCELLATION_OF_PURCHASE' | 'WITHDRAW' | 'INTERNATIONAL_PURCHASE' | 'INTERNATIONAL_IOF' | 'IOF' | 'IOF_WITHDRAWAL' | 'WITHDRAWAL_CHARGES' | 'ANNUITY' | 'WITHDRAWAL_RATE' | 'RATE_CARD_ISSUANCE' | 'REFINANCE_INSTALLMENT' | 'CANC_CREDIT_INSTALLMENTS' | 'PREPAID_CHARGE' | 'MEMBERSHIP_PAYMENT' | 'PURCHASE_CANCELLATION' | 'CANC_INSTALLMENT_WITHOUT_INTEREST' | 'ANNUAL_REVERSAL' | 'CREDIT_BY_INSTALLMENT' | 'REFINANCE_CONTRACT' | 'CANC_PARC_DE_REF' | 'EXCHANGE_DIF_DEBIT' | 'DIF_EXCHANGE_CREDIT' | 'REVERSAL_REFINING_CHARGES' | 'REVERSAL_INTEREST' | 'FINE_REVERSAL' | 'REVERSAL_IOF' | 'CANCELLATION_AGREEMENT_REFINANC' | 'CREDIT_BY_AGREEMENT' | 'INSTALLMENT_OF_AGREEMENT' | 'AGREEMENT_CONTRACT' | 'CANCELLATION_OF_INSTALLMENT_AGREEMENT' | 'CANC_CREDIT_AGREEMENT' | 'CANCELLATION_CONTRACT_AGREEMENT' | 'CREDIT_BY_INSTALLMENT_CP' | 'CP_REFINANCING_INSTALLMENT' | 'CP_REFINANCE_CONTRACT' | 'CANC_PARC_DE_REF_CP' | 'CANC_CREDIT_INSTALLMENT_CP' | 'CANCELLATION_CONTRACT_REF_CP' | 'DEBIT_PAYMENT' | 'CREDIT_VOUCHER' | 'CANC_INSTALLMENTS_WITHOUT_INTEREST' | 'CANC_IN_INSTALLMENTS_WITH_INTEREST' | 'CANC_INSTALLMENT_WITH_INTEREST' | 'CANC_INTERNATIONAL_PURCHASE' | 'CANC_IOF_INTERNATIONAL' | 'REVERSAL_INTERNATIONAL_WITHDRAWAL' | 'REVERSAL_DEBIT_PAYMENT' | 'REVERSED_WITHDRAWAL' | 'REVERSAL_RATE_WITHOUT_WITHDRAWAL' | 'INTERNATIONAL_WITHDRAWAL' | 'FLAG_PAYMENT' | 'TED_CASH_OUT' | 'TEF_CASH_OUT' | 'TED_CASH_IN' | 'DEBIT_REVERSAL' | 'REVERSAL_PAYMENT' | 'REVERSED_WITHDRAWAL_CHARGES' | 'PRE_PAID_RECHARGE_RATE' | 'PREPAID_RECHARGE_PERCENTAGE' | 'MDR' | 'REVERSAL_RATE_WITHDRAWAL' | 'REVERSAL_IOF_WITHDRAWAL' | 'CHARGEBACK_PURCHASE' | 'REVERSAL_CHARGEBACK_PURCHASE' | 'ANNUAL_REVERSAL' | 'REVERSAL_REFINING_CHARGES' | 'REVERSAL_IOF' | 'REVERSAL_INTEREST' | 'REVERSAL_PAYMENT' | 'CREDIT_VOUCHER_INTER' | 'CANC_REVERSAL_INTEREST' | 'PAYMENT_INCLUSION' | 'CANC_ESTORNO_IOF' | 'CRELIQ' | 'INSTALLMENTS_WITH_INTEREST' | 'REFUND_CHARGES' | 'REFUND_FINE' | 'DEPOSIT_BY_BANK_SLIP' | 'PREPAID_RATE' | 'OVERLIMIT_FEE' | 'CASHBACK' | 'CANC_CASHBACK' | 'EARLY_PAYMENT_REFUND' | 'SEGUROS_CRED ' | 'SEGUROS_PERDAS' | 'SEGUROS_DEB': Tipo da transação. - `transaction` TransactionInvoiceDto - `merchant` string, nullable: Nome do estabelecimento/comerciante que aceitou a transação. - `mcc` string, nullable: Código mcc da transação. - `entrymode` string, nullable: Código que identifica o tipo da transação. - `mcg` string, nullable: Descrição do tipo do mcc. - `card` CardDto: Objeto que contém informações sobre o cartão utilizado na transação. - `proxy` string, nullable: Código identificador do cartão utilizado na transação. - `lastFourDigits` string, nullable: Quatro últimos dígitos do cartão. - `alias` string, nullable: Apelido dado ao cartão. - `cardType` 'Physical' | 'Virtual', nullable: Tipo do cartão. - `amounts` AmountInvoiceDto[], nullable: Lista de objetos contendo informações sobre os valores de cada item de fatura. - `amountType` 'NotMapper' | 'Local' | 'Exchange' | 'Billet': Indicador do item de fatura. - `value` number, double: Valor do item da fatura. - `currency` string, nullable: Código da moeda com base na ISO-4217. Exemplo: BRL. - `fees` FeeInvoiceDto[], nullable: Lista de objetos contendo informações sobre as taxas cobradas em saques e transações internacionais. - `feeType` 'NotMapper' | 'Iof' | 'Markup' | 'DailyIof' | 'Interest': Tipo da taxa. - `value` number, double: Valor da taxa. - `statementItemId` integer: Indicador do item de fatura. - `transactionDescription` string, nullable: Descritivo do item da fatura. - `isAnticipation` boolean: Indica se o item da fatura foi antecipado (true) ou não (false). - `summary` object: Objeto que contém informações resumidas sobre a fatura. - `outstandingBalance` object: Objeto que contém informações sobre o saldo residual devedor da fatura anterior. - `value` number: Saldo residual devedor. - `currency` string: Código da moeda com base na ISO-4217. - `estimatedCharges` EstimatedCharges: Objeto que contém informações sobre o valor estimado de encargos caso a fatura seja rotativada. - `iof` object: Objeto que contém informações sobre o valor estimado do IOF caso a fatura seja rotativada. - `value` number: Valor total estimado do IOF. - `currency` string: Código da moeda com base na ISO-4217. - `refinance` object: Objeto que contém informações sobre o valor que será refinanciado caso a fatura seja rotativada. Observação: o valor a ser refinanciado é a diferença entre o mínimo da fatura e o valor total. - `value` number: Valor total a ser refinanciado. - `currency` string: Código da moeda com base na ISO-4217. - `interest` object: Objeto que contém informações sobre o valor estimado do encargo de refinanciamento caso a fatura seja rotativada. - `value` number: Valor total estimado dos encargos de refinanciamento. - `currency` string: Código da moeda com base na ISO-4217. - `trafficValue` object: Objeto que contém informações sobre o valor estimado da multa caso a fatura seja rotativada. - `value` number: Valor total estimado da multa. - `currency` string: Código da moeda com base na ISO-4217. - `annualCet` number: Percentual anual do custo efetivo total da operação de rotativo. - `monthlyCet` number: Percentual mensal do custo efetivo total da operação de rotativo. - `installmentSummary` InstallmentSummary: Objeto que contém informações sobre os itens parcelados a vencer (itens de parcelamento que compõem a fatura aberta e faturas futuras). - `interestFree` object: Objeto que contém informações sobre a soma das parcelas sem juros a vencer. - `value` number: Soma das parcelas sem juros a vencer. - `currency` string: Código da moeda com base na ISO-4217. - `interest` object: Objeto que contém informações sobre a soma das parcelas com juros a vencer, com desconto dos encargos que compõem a parcela. - `value` number: Soma das parcelas com juros a vencer, com desconto dos encargos que compõem a parcela. - `currency` string: Código da moeda com base na ISO-4217. - `interestWithoutDiscount` object: Objeto que contém informações sobre a soma das parcelas com juros a vencer, sem o desconto dos encargos que compõem a parcela. - `value` number: Soma das parcelas com juros a vencer, sem o desconto dos que compõem a parcela. - `currency` string: Código da moeda com base na ISO-4217. - `amountMinimalComposition` AmountMinimalComposition: Objeto que contém informações sobre os valores que compõem o valor de pagamento mínimo da fatura. - `outstandingBalance` object: Objeto que contém informações sobre o saldo residual devedor da fatura anterior. - `value` number: Saldo residual devedor. - `currency` string: Código da moeda com base na ISO-4217. - `fees` object: Objeto que contém informações sobre a soma dos encargos lançados em fatura. - `value` number: Soma dos encargos lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `refinance` object: Objeto que contém informações sobre a soma dos itens de refinanciamento de fatura lançados em fatura. - `value` number: Soma dos itens de refinanciamento lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `transactions` object: Objeto que contém informações sobre a soma dos itens de débito lançados em fatura. - `value` number: Soma dos itens de débito lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `transactionsSummary` TransactionsSummaryResponse: Objeto que contém informações sobre os valores totais das transações na fatura, agrupados por categoria de transação. - `nationalPurchasing` object: Objeto que contém informações sobre a soma das transações nacionais na fatura. - `value` number: Soma das transações nacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `internationalPurchasing` unknown[]: Objeto que contém informações sobre a soma das transações internacionais na fatura. - unknown - `fees` object: Objeto que contém informações sobre a soma dos encargos lançados em fatura. - `value` number: Soma dos encargos lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `debtAdjustments` object: Objeto que contém informações sobre a soma dos ajustes a débito lançados em fatura. - `value` number: Soma dos ajustes a débito lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `creditAdjustments` object: Objeto que contém informações sobre a soma dos ajustes a crédito lançados em fatura. - `value` number: Soma dos ajustes a crédito lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `payments` object: Objeto que contém informações sobre a soma dos pagamentos realizados. - `value` number: Soma dos pagamentos. - `currency` string: Código da moeda com base na ISO-4217. - `insurance` object: Objeto que contém informações sobre a soma dos itens de seguro lançados em fatura. - `value` number: Soma dos itens de seguro lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `annuity` object: Objeto que contém informações sobre a soma dos itens de anuidade lançados em fatura. - `value` number: Soma dos itens de anuidade lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `withdraw` object: Objeto que contém informações sobre a soma dos itens de saque nacionais na fatura. - `value` number: Soma dos itens de saque nacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `internationalWithdraw` object: Objeto que contém informações sobre a soma dos itens de saque internacionais na fatura. - `value` number: Soma dos itens de saque internacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `installment` object: Objeto que contém informações sobre a soma das transações parceladas na fatura atual. - `value` number: Soma das transações parceladas na fatura atual. - `currency` string: Código da moeda com base na ISO-4217. - `transactionsCardsSummary` object[]: Lista de objetos contendo informações sobre a soma das transações da fatura, agrupadas por cartão e divididas por categoria de transação. - `card` object: Objeto que contém informações sobre o cartão atrelado à transação. - `type` 'Virtual' | 'Physical': Tipo do cartão. - `lastFourDigitis` string: Quatro últimos dígitos do cartão. - `name` string: Nome exibido no cartão. - `proxy` string: Código identificador do cartão. - `totalDebits` object: Objeto que contém informações sobre a soma dos itens de débito na fatura atual. - `value` number: Soma dos itens de débito na fatura atual. - `currency` string: Código da moeda com base na ISO-4217. - `nationalPurchasing` object: Objeto que contém informações sobre a soma das transações nacionais na fatura. - `value` number: Soma das transações nacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `internationalPurchasing` object[] - `value` number: Soma das transações internacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `fees` object: Objeto que contém informações sobre a soma dos encargos lançados em fatura. - `value` number: Soma dos encargos lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `debitAdjustments` object: Objeto que contém informações sobre a soma dos ajustes a débito lançados em fatura. - `value` number: Soma dos ajustes a débito lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `creditAdjustments` object: Objeto que contém informações sobre a soma dos ajustes a crédito lançados em fatura. - `value` number: Soma dos ajustes a crédito lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `payments` object: Objeto que contém informações sobre a soma dos pagamentos por cartão. - `value` number: Soma dos pagamentos por cartão. - `currency` string: Código da moeda com base na ISO-4217. - `insurance` object: Objeto que contém informações sobre a soma dos itens de seguro lançados em fatura. - `value` number: Soma dos itens de seguro lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `annuity` object: Objeto que contém informações sobre a soma dos itens de anuidade lançados em fatura. - `value` number: Soma dos itens de anuidade lançados em fatura. - `currency` string: Código da moeda com base na ISO-4217. - `withdraw` object: Objeto que contém informações sobre a soma dos itens de saque nacionais na fatura. - `value` number: Soma dos itens de saque nacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `internationalWithdraw` object: Objeto que contém informações sobre a soma dos itens de saque internacionais na fatura. - `value` number: Soma dos itens de saque internacionais na fatura. - `currency` string: Código da moeda com base na ISO-4217. - `installment` object: Objeto que contém informações sobre a soma das transações parceladas na fatura atual. - `value` number: Soma das transações parceladas na fatura atual. - `currency` string: Código da moeda com base na ISO-4217. - `nextStatement` NextStatementResponse: Objeto que contém informações sobre a próxima fatura. - `statementId` number: Identificador único da próxima fatura. - `balance` number: Valor total da próxima fatura, que pode ser negativo ou positivo. - `cicleCloseDate` string, date-time: Data de fechamento da próxima fatura. ## Other responses - `400` (unresolved $ref) - `404` (unresolved $ref) - `406` (unresolved $ref) --- [API](https://skmtc.dev/bankly/apis/gest-o-de-faturas.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-faturas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-faturas/revisions/59ad0e112fb8?raw)