Cadastro de débitos para corretores

Em desenvolvimento

POST

/api/v2/finance/incomes/debit

Este endpoint permite cadastrar débitos para um ou mais corretores. Nele são informados dados como código do corretor, data da cobrança, valor, método de pagamento, centro de custo, tipo de débito, competência e motivo. Também é possível definir recorrência da cobrança (ex.: semanal ou mensal), indicar se o valor será debitado em conta e adicionar uma descrição personalizada do lançamento

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://demo.corbee.com.br/api/v2/finance/incomes/debit' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "codigoCorretor": [
        12,
        45
    ],
    "dataCobranca": "2025-09-20",
    "valor": 500.75,
    "formaPagamento": 1,
    "numeroCheque": 0,
    "repetirCobrancaPor": 1,
    "formaRepeticao": "mensal",
    "centroCusto": 1,
    "tipoDebito": 4,
    "debitarDaConta": 0,
    "mesCompetencia": "09",
    "anoCompetencia": "2025",
    "codigoProposta": 1234,
    "codigoDigitoBanco": "33a",
    "motivo": 1,
    "descricao": "Lançamento de débito via api",
    "descontaPagamentoCarteira": false
}'

Response Example

{
    "status": true,
    "message": "Débitos criados com sucesso",
    "data": {
        "totalDebits": 2,
        "createdDebits": [
            {
                "debitId": 637,
                "brokerCode": 12,
                "value": 500.5,
                "dateCompensation": "2025-09-20",
                "description": "Lançamento de débito via api"
            },
            {
                "debitId": 638,
                "brokerCode": 690,
                "value": 500.5,
                "dateCompensation": "2025-09-20",
                "description": "Lançamento de débito via api"
            }
        ]
    }
}

Página anterior

Listar centros de custo

Próxima página

Listar Contas Bancárias