Cadastrar uma nova cobrança

Esse endpoint permite o cadastro de uma nova cobrança na carteira.

Parâmetros da URL

• wallet_id (string): ID da carteira

Parâmetros da requisição

• dueDate (datetime): Data de vencimento.

• amount (float): Valor da cobrança.

• fine (float): Taxa percentual de multa em caso de atraso no pagamento.

• discountLimitDate (datetime): Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20.

• discountValue (float): Valor de desconto a ser aplicado.

• interest (float): Taxa de juros a ser aplicada em caso de atraso.

• daysToExpireAfterPayment (integer): Dias após o vencimento que a cobraça pode ser paga.

• discountModality (string): Modalidade de desconto. Possíveis valores: PERCENT, FIXED

• chargeDebtor (object): Objeto contendo os dados do devedor.

Objeto 'chargeDebtor'

• name (string): Nome do pagador.

• document (string): CPF do pagador.

• email (string): E-mail de contato.

• publicArea (string): Nome da rua.

• number (string): Número do endereço informado.

• postalCode (string): Código de CEP para o endereço.

• neighborhood (string): Campo para informar o bairro.

• city (string): Nome da cidade.

• state (string): Código da UF para o estado do endereço.

• complement (string): Complemento do endereço.

Exemplo de JSON:

{
  "dueDate": "2024-08-30",
  "amount": "<number>",
  "fine": "<number>",
  "discountLimitDate": "2024-08-30",
  "discountValue": "<number>",
  "interest": "<number>",
  "chargeDebtor": {
    "number": "<string>",
    "neighborhood": "<string>",
    "name": "<string>",
    "document": "<string>",
    "city": "<string>",
    "publicArea": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "phone": {
      "countryCode": "+200",
      "areaCode": "<string>",
      "number": "<string>"
    },
    "email": "<string>"
  },
  "daysToExpireAfterPayment": "<number>",
  "discountModality": "PERCENT"
}