Campos que podem ser usados na criação de boletos

 

name Nome do Pagador String 
cnpj_cpf CPG ou CNPJ do Pagador String, Retorna Objeto CPF
city Cidade do Pagador String
state Estado do Pagador String
address Endereço  do Pagador String
zipcode CEP String(formato 99999-999)
percent_fines Percetual de Multa Float
paid_amount Total Pago Float
guarantor Sacador / Avalista String
comments Comentários Text
acceptance Aceite (Sim= S ou Não=N) String
document_number Número do documento String
discount_amount Desconto Float
amount Valor do Boleto float
service_id ID do Modelo(Ver Menu Integração) Number
percent_interest_day Percentual de Juros ao Dia  Float 
neighborhood  Bairro  String
document_date  Data do Documento  String(formato 2013-1-20)
paid_at  Data de Pagamento  String(formato 2013-1-20)
document_type  Tipo do Documento "AP" => "Apólice de Seguro",
"CH" => "Cheque",
"DM" => "Duplicata Mercantil",
"DMI" => "Duplicata Mercantil p/ Indicação",
"DR" => "Duplicata Rural",
"DS" => "Duplicata de Serviço",
"DSI" => "Duplicata de Serviço p/ Indicação",
"FAT" => "Fatura",
"LC" => "Letra de Cambio",
"ME" => "Mensalidade Escolar",
"NCC" => "Nota de Crédito Comercial",
"NCE" => "Nota de Crédito A Exportação",
"NCI" => "Nota de Crédito Industrial",
"NCR" => "Nota de Crédito Rural",
"ND" => "Nota de Débito",
"NP" => "Nota Promissória",
"NPR" => "Nota Promissória Rural",
"NS" => "Nota de Seguro",
"Outros" => "Outros",
"PC" => "Parcela de Consórcio",
"RC" => "Recibo",
"TM" => "Triplicata Mercantil",
"TS" => "Triplicata de Serviço"
document_amount  Valor do Documento Float
description  Demonstrativo String
currency  Moeda Sempre R$
instructions  Instruções para o Caixa String
other_amount_to_add  Outros Acréscimos Float
expire_at  Data de Vencimento String(formato 2013-1-20)
bank_billet_account_id ID da Conta de Cobrança(Ver Menu Integração) Number 
customer_identification Identificação do Cliente String
customer_cc_addresses Email de Cópia(CC) String
customer_bcc_addresses Email de Cópia Oculta(CCO) String 
customer_email Email do Cliente String
save_customer Salvar Cliente Boolean (true or false)
customer_id ID do Cliente(Quando cliente está cadastrado) Number
customer_ids Lista de IDs de Clientes(Quando cliente está cadastrado) Array com Number [1,2,4]
generate_on_creation Gerar boleto Imediatamente Boolean (true or false)
send_email_on_creation Enviar por email após gerar o boleto Boolean (true or false)
kind Tipo(Normal=normal, Assinatura=recurrent, Carnê=parceled) String
end_at Data de Encerramento

Data onde a Assinatura irá parar de gerar e enviar boletos. Para casos que o contrato com o cliente tenha uma data de encerramento.

Formato 2013-1-20

recurrent_cycle Período (Somente em caso de Tipo Assinatura) String(biweekly monthly quarterly semiannual annual)
notify_overdue    
parcels Número de Parcelas  Number
email  Hash com opções de Email

Hash {
name: Nome do Cliente,
address: Email do Cliente,
cc_addresses: Email de Cópia(CC),
subject: Assunto,
email_body: Corpo do Email,
bank_billet_in_pdf: Anexar em PDF(true or false),
bank_billet_in_png: Anexar em PNG(true or false),
bcc_addresses: Email de Cópia Oculta(CCO)
}

bank_billet_subscription_id  ID da Assinatura  Number
 meta  Campo Genérico

 Aceita qualquer formato passado. Pode ser usado para salvar dados que não existam dentro do Cobre Grátis.

cnpj_cpf_string CNPJ ou CPF

String, retorna String

Tem mais dúvidas? Envie uma solicitação

0 Comentários

Artigo fechado para comentários.
Powered by Zendesk