Financeiro › Faturas

Alterar

put/invoices/{id}

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/invoices/{id}
  • Auth: HTTP bearer

Request body

typestring

Tipo da fatura. Valores permitidos:

  • single: Avulsa
  • contract: Contrato
payer_idinteger

ID do pagador.

contract_idinteger

ID do contrato.

business_idinteger

ID da empresa.

account_idinteger

ID da conta bancária.

billing_idinteger

ID do método de cobrança automático.

billing_methodstring required

Método de cobrança Valores permitidos:

  • ticket: Boleto
  • cash: Dinheiro
  • deposit: Depósito
  • pix: PIX
  • ted: DOC/TED
  • credit: Cartão de Crédito
  • debit: Cartão de Débito
  • check: Cheque
  • debit_account: Débito em Conta
paidboolean

Paga. Pode ser true (Pago) ou false (Agendado/Não Pago).

paid_atstring

Data do pagamento.

credit_atstring

Data do crédito.

payment_errorboolean

Erro no pagamento.

descriptionstring

Descrição da fatura.

totalnumber

Valor total da fatura.

datestring

Competência.

due_datestring

Data de vencimento.

guaranteed_transferboolean

Repasse garantido.

period_initialstring

Data de início da fatura, aluguel.

period_finalstring

Data final da fatura, aluguel.

tagstring[]

Tags da fatura.

ticket_registeredboolean

Boleto registrado.

ticket_datestring

Data do boleto.

ticket_keystring

ID da cobrança dentro do banco integrador (Asaas).

ticket_idinteger

ID do boleto.

ticket_feestring

Taxa do boleto.

ticket_linkstring

Link do boleto.

ticket_barcodestring

Código de barras do boleto .

ticket_infostring

Informações do boleto.

ticket_digitablestring

Linha digitável do boleto.

ticket_without_pixboolean

Boleto sem pix.

ticket_late_feeboolean

Adicionar Multa e Juros para contratos de Locação.

ticket_late_fee_item_idinteger

ID do item que será aplicado a multa.

ticket_late_fee_percentageinteger

Multa (%).

ticket_late_fee_interestinteger

Juros (%).

ticket_discountboolean

Adicionar Desconto de Pontualidade.

ticket_discount_modestring

Modo de desconto. Valores permitidos:

  • fixed: Valor Fixo
  • percentage: Porcentagem
ticket_discount_fixedstring

Desconto (R$).

ticket_discount_percentagestring

Desconto(%).

ticket_discount_actionstring

Ação do desconto de pontualidade. Valores permitidos:

  • business: Reter desconto para imobiliária
  • owner: Repassar desconto ao proprietário
ticket_discount_daysinteger

Quantidade de dias antes do vencimento.

transfer_auto_disabledboolean

Desativar repasse automático.

proteststring

Protesto.

Example request

{
  "type": "single",
  "payer_id": 1,
  "contract_id": 2,
  "business_id": 3,
  "account_id": 4,
  "billing_id": 5,
  "billing_method": "pix",
  "paid_at": "2024-01-01",
  "credit_at": "2024-01-02",
  "payment_error": true,
  "description": "Fatura X",
  "total": 1200,
  "date": "2024-01-01",
  "due_date": "2024-01-10",
  "guaranteed_transfer": true,
  "period_initial": "2024-01-01",
  "period_final": "2024-01-31",
  "tag": [
    123,
    456,
    789
  ],
  "ticket_date": "2024-01-01 00:00:00",
  "ticket_key": "abc123",
  "ticket_id": 1,
  "ticket_fee": "12.0",
  "ticket_link": "https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1",
  "ticket_barcode": "12395828200001760000010003821587100516853008",
  "ticket_info": "Este boleto...",
  "ticket_digitable": "12390.01007 03821.587106 05168.530086 5 82820000176000",
  "ticket_late_fee": true,
  "ticket_late_fee_item_id": 1,
  "ticket_late_fee_percentage": 12,
  "ticket_late_fee_interest": 13,
  "ticket_discount": true,
  "ticket_discount_mode": "percentage",
  "ticket_discount_fixed": "123.20",
  "ticket_discount_percentage": "10",
  "ticket_discount_action": "business",
  "ticket_discount_days": 12,
  "protest": "{\"status\":\"PENDING\"}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.