Objetivo

Esta API tem o objetivo de retornar o extrato com as comissões do corretor.
O Resultado desta API trará uma lista com os documentos emitidos pelo corretor

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos
Nome do Serviçocommission/list
Extrato de comissões do corretor
Descrição ResumidaExtrato de Comissões do corretor
URLBase Path:
openapi.hdi.com.br/corporate/finance/v1

URI:
/commission/list
StatusAtivo
Versão1.0
Exemplo de Payload
key=AIzaSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
companyId="01"
startDate=17-12-2022
endDate=17-12-2022
Content-Type
X-Company-Id=application/json
X-Application-Id=01
X-User-Id=7777777777
X-Susep-Code="00000000000000"
X-Sucursal-Code=100
X-Trace-Id=abcAPP02
{
    "demonstrative": {
        "statementNum": 9999,
        "paymentDate": "19/12/2022",
        "irrfAmount": {
            "amount": 71007.0,
            "amountFormatted": "710,07",
            "currency": "R$"
        },
        "issAmount": {
            "amount": 1.42,
            "amountFormatted": "1.420,14",
            "currency": "R$"
        },
        "grossValue": {
            "amount": 47.338,
            "amountFormatted": "47.338,24",
            "currency": "R$"
        },
        "difference": {
            "amount": 0.0,
            "amountFormatted": "0,00",
            "currency": "R$"
        },
        "commissionValue": {
            "amount": 59.99,
            "amountFormatted": "59.990,98",
            "currency": "R$"
        },
        "netValue": {
            "amount": 45.208,
            "amountFormatted": "45.208,03",
            "currency": "R$"
        },
        "details": [
            {
                "statementNum": 9999,
                "paymentDate": "19/12/2022",
                "brokerageUnion": null,
                "commission": {
                    "commissionType": {
                        "description": "Corretagem"
                    },
                    "commissionValue": {
                        "amount": 59.99,
                        "amountFormatted": "59.990,98",
                        "currency": "R$"
                    },
                    "percentage": 8000.0
                },
                "policy": {
                    "code": "01.102.005.292428.000000 - 1/4",
                    "product": {
                        "code": "01"
                    },
                    "customer": {
                        "name": "DESCONTINUIDADE DE OCTXXXX PATRIMO"
                    }
                }
            },
            {
                "statementNum": 9999,
                "paymentDate": "19/12/2022",
                "brokerageUnion": null,
                "commission": {
                    "commissionType": {
                        "description": "Corretagem"
                    },
                    "commissionValue": {
                        "amount": 59.99,
                        "amountFormatted": "59.990,98",
                        "currency": "R$"
                    },
                    "percentage": 10000.0
                },
                "policy": {
                    "code": "01.102.131.099999.000000 - 1/10",
                    "product": {
                        "code": "01"
                    },
                    "customer": {
                        "name": "CLIENTE XXXXX DA SILVA"
                    }
                }
            }
         ]
    },
    "total": {
        "irrfAmount": {
            "amount": 71007.0,
            "amountFormatted": "710,07",
            "currency": "R$"
        },
        "inssAmount": {
            "amount": 0.0,
            "amountFormatted": "0,00",
            "currency": "R$"
        },
        "issAmount": {
            "amount": 1.42,
            "amountFormatted": "1.420,14",
            "currency": "R$"
        },
        "commissionValue": {
            "amount": 59.99,
            "amountFormatted": "59.990,98",
            "currency": "R$"
        },
        "advanceValue": {
            "amount": 0.0,
            "amountFormatted": "0,00",
            "currency": "R$"
        },
        "deductionAmount": {
            "amount": 12.652,
            "amountFormatted": "12.652,74",
            "currency": "R$"
        },
        "grossValue": {
            "amount": 47.338,
            "amountFormatted": "47.338,24",
            "currency": "R$"
        },
        "differenceValue": {
            "amount": 0.0,
            "amountFormatted": "0,00",
            "currency": "R$"
        },
        "netValue": {
            "amount": 45.208,
            "amountFormatted": "45.208,03",
            "currency": "R$"
        }
    }
}

          
Informações de ambientes
Histórico de versões
AutorÁrea ou SetorVersãoDescrição da versão
OpenInsuranceIntegraçãoV1.0Versão Inicial