🔗Criação de Carnê
Criando CarnÊ
Para criar um carnê, você pode fazer uma requisição POST com objetos JSON para o seguinte URL:
URL de Solicitação:
https://api.zsystems.com.br/carnes
Certifique-se de incluir os detalhes necessários no corpo da requisição em formato JSON, como os dados do carnê.
Além disso, é importante incluir os cabeçalhos de requisição necessários para garantir uma comunicação adequada:
ContentType
: application/jsonauthorization
: Bearer 'Token API'
Id
Tipo
Descrição
cliente
nome: Nome do cliente cpf = Cpf do cliente dataNascimento = data de nascimento do cliente email = Email do cliente celular = Nº de telefone celular do cliente
descontos
mode: Tipo de desconto value = valor do desconto limitDate = expiração do desconto
descricao
Descrição do carnê
diaVencimento
Data de validade do carnê
endereco
Endereço de cobrança logradouro: Logradouro numero = Nº Residencial cep = cep do endereço cidade = cidade estado = estado complemento = complemento
estabelecimentoId
Id do estabelecimento
parcelas
parcelas do carnê
splits
estabelecimentoId: Id do estavelecimento de referencia cpfcnpj: Documento identificador do indiciduo splitado nome: Nome do individuo ou estabelecimento email = email do individuo ou estabelecimento value = valor do split tipoSplit = tipo de split chargeProcessingFree = 0=Bruto / 1=Líquido
tipoPagamentoId
ID do tipo de pagamento
titulo
titulo do carnê
valor
valor total do carnê
percentual
Percentual de juros
repassarTaxaCliente
Vai repassar a taxa para o cliente?
split
Haverá split? (true ou false)
splits
[{estabelecimentoId: false, Há estabelecimento vinculado? (true ou false)
cnfcnpj = Cpf ou Cnpj do estabelecimento nome = Nome do estabelecimento email = Email do estabelecimento valeu = Valor do split
tipoSplit: 2 = Informar id do tipo do split]}
titulo
Título do link do pagamento
Exemplo de requisição:
{
"cliente": {
"nome": "LUCAS COELHO",
"cpf": "03927561029",
"dataNascimento": "2000-02-08",
"email": "RUA SAO JOSEMARIA ESCRIVA",
"celular": "99562909"
},
"clienteId:2666",
"descontos": [
{
"mode": "",
"value": 0,
"limitDate": "2023-09-13T19:24:05.619Z"
}
],
"descricao":"descricaoteste",
"diaVencimento":"2023-09-18",
"endereco": {
"logradouro": "Rua São Josemaría Escrivá",
"numero": " 669 ",
"cep": "91410-470",
"cidade": "Porto Alegre",
"estado": "RS",
"complemento": ""
}
"estabelecimentoId":155,
"parcelas":1,
"splits": [
{
"estabelecimentoId": false,
"cpfcnpj": "",
"nome": "",
"email": "",
"value": 0,
"tipoSplit": 2,
"chargeProcessingFee": true
}
],
"tipoPagamentoId": 4,
"titulo": "tete",
"valor": 10,
}
Exemplo de resultado:
{
"success": true,
"carne": {
"id": 8441,
"estabelecimento_id": 158,
"usuario_id": 125,
"cliente_id": 27432251,
"titulo": "tete",
"descricao": "teste",
"parcelas": 1,
"dia_vencimento": "18",
"valor": 10,
"modified": "2023-09-13T19:26:23.154Z",
"created": "2023-09-13T19:26:23.154Z"
}
}
Last updated