{"openapi":"3.0.1","info":{"title":"4966 - API's","version":"1.0.0"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/SANDOELLYTONSOUSA/4966-apis-estagio/1.0.0"},{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/SANDOELLYTONSOUSA/DebtStage/1.0.0"},{"url":"https://localhost/v2","description":"Generated server url"}],"security":[{"access_token":[],"client_id":[]}],"tags":[{"name":"Marcação de parada de acumulação","description":"Operações relacionadas à marcação de parada de acumulação"}],"paths":{"/api/accounts/{id}/debt-stage":{"get":{"tags":["Marcação de parada de acumulação"],"summary":"Consulta marcação de parada de acumulação de uma conta","description":"Consulta marcação de parada de acumulação de uma conta por seu identificador","operationId":"findByAccountId","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"},"example":15}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}}},"404":{"description":"Not Found. Mensagens possíveis:<ul><li>Nenhum registro encontrado para a conta informada</li>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiError"}}}}}},"post":{"tags":["Marcação de parada de acumulação"],"summary":"Inclui a marcação de um estágio de dívida de uma conta","description":"Inclui a marcação de um estágio de dívida de uma conta","operationId":"includeMarking","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingPersist"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>Data de vigência só é permitida para o estágio 3</li><li>A data de vigência informada deve ser diferente da data de requisição</li><li>A data de vigência não pode ser anterior ao primeiro dia do mês atual</li><li>Data de vigência informada não é um dia útil</li><li>Marcação do estágio já encontra-se habilitada para a conta informada</li><li>Não é possível informar a data de vigência para contas que já entraram em Stop Accrual pela Dock</li><li>O prazo para inclusão de data de vigência retroativa foi excedido</li>"},"500":{"description":"Erro Interno do Serviço"}}},"patch":{"tags":["Marcação de parada de acumulação"],"summary":"Altera a marcação de um estágio de dívida de uma conta","description":"Altera a marcação de um estágio de dívida de uma conta","operationId":"updateMarking","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingUpdate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found. Mensagens possíveis:<ul><li>Conta não encontrada para o código de identificação informado</li><li>Não existe definição de estágio para a conta informada</li></ul>"},"422":{"description":"Not Found. Mensagens possíveis:<ul><li>É necessário informar o estágio emissor ou a data de vigência</li><li>Conta informada não contém estágio emissor definido</li><li>Estágio informado já encontra-se definido para essa conta</li><li>A data de vigência não pode ser informada para contas que já estão em Stop Accrual pela Dock ou possuem o estágio 3 atribuído pelo Emissor</li><li>Data de vigência só é permitida para o estágio 3</li><li>A data de vigência informada deve ser diferente da data de requisição</li><li>A data de vigência não pode ser anterior ao primeiro dia do mês atual</li><li>Data de vigência informada não é um dia útil</li><li>Existe uma marcação de estágio 3 com data de vigência agendada para processamento na conta informada</li><li>Não é possível realizar marcações com data de vigência enquanto houver um processo de cancelamento de marcação com vigência em andamento</li><li>Existe uma marcação de estágio 3 com data de vigência agendada para ser processada hoje na conta informada</li><li>A data de vigência informada deve ser diferente da data definida no agendamento</li><li>A data de vigência não pode ser informada para contas que já estão em Stop Accrual pela Dock ou possuem o estágio 3 atribuído pelo Emissor</li><li>O prazo para inclusão de data de vigência retroativa foi excedido</li><li>Não existe uma marcação com data de vigência para a conta informada</li><li>Não é permitido alterar a data de vigência de uma marcação já processada</li><li>Não é possível associar o estágio 3 enquanto houver um processo de cancelamento de marcação com vigência em andamento</li></ul>"},"500":{"description":"Erro Interno do Serviço"}}}},"/api/accounts/{id}/curing-stage":{"post":{"tags":["Marcação de parada de acumulação"],"summary":"Inclui a marcação de um estágio de cura de uma conta","description":"Inclui a marcação de um estágio de cura de uma conta","operationId":"includeCuring","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CuringStagePersist"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}}},"400":{"description":"Not Found"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>Não existe registro de parada de acumulação para a conta informada</li><li>Status da conta não está definido com flagPerda ativada</li><li>Conta não está com a marcação da dockFlagStop ativada</li><li>Estágio de cura já encontra-se definido para essa conta</li><li>Estágio de cura informado é inválido, estágios válidos são 1 ou 2</li>"},"500":{"description":"Erro Interno do Serviço"}}},"delete":{"tags":["Marcação de parada de acumulação"],"summary":"Remove a marcação de um estágio de cura de uma conta","description":"Remove a marcação de um estágio de cura de uma conta","operationId":"removeMarking","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"404":{"description":"Não existe registro de parada de acumulação para a conta informada"},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>Conta informada não contém estágio de cura definido</li>"},"500":{"description":"Erro Interno do Serviço"}}},"patch":{"tags":["Marcação de parada de acumulação"],"summary":"Altera a marcação de um estágio de cura de uma conta","description":"Altera a marcação de um estágio de cura de uma conta","operationId":"updateCuringStage","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CuringStagePersist"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"Não existe registro de parada de acumulação para a conta informada"},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>Status da conta não está definido com flagPerda ativada</li><li>Conta não está com a marcação da dockFlagStop ativada</li><li>Estágio informado já encontra-se definido para essa conta</li><li>Conta informada não contém estágio de cura definido</li><li>Estágio de cura informado é inválido, estágios válidos são 1 ou 2</li><ul>"},"500":{"description":"Erro Interno do Serviço"}}}},"/api/accounts/debt-stage":{"get":{"tags":["Marcação de parada de acumulação"],"summary":"Lista todas as marcações de parada de acumulação","description":"Lista todas as marcações de parada de acumulação no intervalo de datas informado","operationId":"findAll_3","parameters":[{"name":"page","in":"query","description":"Página a ser mostrada (inicia em 0)","required":false,"schema":{"minimum":0,"type":"string","description":"Página a ser mostrada (inicia em 0)","example":0,"default":"0"},"example":0},{"name":"limit","in":"query","description":"Quantidade de elementos em cada página","required":false,"schema":{"maximum":50,"minimum":1,"type":"string","description":"Quantidade de elementos em cada página","example":50,"default":"50"},"example":50},{"name":"sort","in":"query","description":"Nome do campo a ser utilizado na ordenação","required":true,"schema":{"type":"string","description":"Nome do campo a ser utilizado na ordenação","example":"id"},"example":"id"},{"name":"order","in":"query","description":"Direção da ordenação. Utilize ASC para ordenação ascendente e DESC para descendente. Padrão ASC. Sem distinção de maiúsculas e minúsculas","required":false,"schema":{"type":"string","description":"Direção da ordenação. Utilize ASC para ordenação ascendente e DESC para descendente. Padrão ASC. Sem distinção de maiúsculas e minúsculas","example":"desc","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"dock_flag_stop","in":"query","description":"Marcação de parada de acumulação Dock","required":false,"schema":{"type":"boolean"}},{"name":"issuer_stage","in":"query","description":"Marcação de estágio de parada de acumulação do emissor","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"curing_stage","in":"query","description":"Marcação de estágio de cura de uma conta","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"is_processed","in":"query","description":"Indicador de que a marcação foi processada pelo batch","required":false,"schema":{"type":"boolean"}},{"name":"operator","in":"query","description":"Permite que os usuários especifiquem o operador lógico a ser aplicado em relação aos campos dockFlagStop, issuerStage e curingStage em suas consultas. Este campo aceita os valores AND ou OR","required":false,"schema":{"type":"string","default":"AND","enum":["AND","OR"]}},{"name":"start_date","in":"query","description":"Data inicial para busca da marcação de parada de acumulação no formato yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2024-03-20T16:49:00.000Z)","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end_date","in":"query","description":"Data final para busca da marcação de parada de acumulação no formato yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2024-03-20T16:49:00.000Z)","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResponseAccrualStopMarkingResponse"}}}},"400":{"description":"Bad Request. Mensagens possíveis:<ul><li>Data inicial deve ser anterior a data final</li>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiError"}}}},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>Intervalo de datas deve ser inferior a um ano</li>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiError"}}}},"500":{"description":"Erro Interno do Serviço"}}}},"/api/accounts/{id}/debt-stage/effective-date":{"delete":{"tags":["Marcação de parada de acumulação"],"summary":"Apaga a data de vigência","description":"Apaga a data de vigência de uma marcação de parada de acumulação em estágio 3","operationId":"deleteEffecticeDate","parameters":[{"name":"id","in":"path","description":"Código de identificação da conta","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Alguma coisa não foi encontrada. Mensagens possíveis:<ul><li>Não existe registro de parada de acumulação para a conta informada</li><li>Conta não encontrada para esta solicitação</li><li></li>Não foi encontrada uma data efetiva para esta marcação de parada de acumulação</ul>"},"422":{"description":"Unprocessable Entity. Mensagens possíveis:<ul><li>A marcação com data de vigência já foi processada e não pode ser excluída</li><li>A marcação com data de vigência não pode ser excluída porque não está no estágio 3</li>"},"500":{"description":"Erro Interno do Serviço"}}}},"/api/accounts/debt-stage/effective-date":{"get":{"tags":["Marcação de parada de acumulação"],"summary":"Lista somente marcações de parada de acumulação que contenham data de vigência","description":"Lista somente marcações de parada de acumulação que contenham data de vigência","operationId":"findAll_effective_date","parameters":[{"name":"page","in":"query","description":"Página a ser mostrada (inicia em 0)","required":false,"schema":{"minimum":0,"type":"string","description":"Página a ser mostrada (inicia em 0)","example":0,"default":"0"},"example":0},{"name":"limit","in":"query","description":"Quantidade de elementos em cada página","required":false,"schema":{"maximum":50,"minimum":1,"type":"string","description":"Quantidade de elementos em cada página","example":50,"default":"50"},"example":50},{"name":"sort","in":"query","description":"Nome do campo a ser utilizado na ordenação","required":true,"schema":{"type":"string","description":"Nome do campo a ser utilizado na ordenação","example":"id"},"example":"id"},{"name":"order","in":"query","description":"Direção da ordenação. Utilize ASC para ordenação ascendente e DESC para descendente. Padrão ASC. Sem distinção de maiúsculas e minúsculas","required":false,"schema":{"type":"string","description":"Direção da ordenação. Utilize ASC para ordenação ascendente e DESC para descendente. Padrão ASC. Sem distinção de maiúsculas e minúsculas","example":"desc","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"issuer_stage","in":"query","description":"O estágio da Marcação de Parada de Acumulação, atribuído pelo emissor","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"issuer_update_date_start","in":"query","description":"Filtra as Marcações de Parada de Acumulação atualizadas pelo emissor a partir da data especificada","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"issuer_update_date_end","in":"query","description":"Filtra as Marcações de Parada de Acumulação atualizadas pelo emissor até a data especificada","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"effective_date_start","in":"query","description":"Filtra as Marcações de Parada de Acumulação cuja data de vigência é a partir da data especificada","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"effective_date_end","in":"query","description":"Filtra as Marcações de Parada de Acumulação cuja data de vigência é até a data especificada","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"is_processed","in":"query","description":"Indica se a Marcação de Parada de Acumulação já foi processada","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResponseAccrualStopMarkingResponse"}}}},"400":{"description":"Bad Request. Mensagens possíveis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiError"}}}},"422":{"description":"Unprocessable Entity. Mensagens possíveis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformApiError"}}}},"500":{"description":"Erro Interno do Serviço"}}}}},"components":{"schemas":{"AccrualStopMarkingPersist":{"required":["issuer_stage"],"type":"object","properties":{"issuer_stage":{"type":"integer","description":"Estágio para inclusão Stop Accrual","format":"int32","example":3},"effective_date":{"type":"string","description":"Data de vigência do estágio de dívida informado pelo emissor","format":"date-time","example":"2023-12-15"}},"description":"Objeto de requisição para inclusão de estágio"},"CuringStagePersist":{"required":["curing_stage"],"type":"object","properties":{"curing_stage":{"type":"integer","description":"Estágio de cura","format":"int32","example":1}},"description":"Objeto de requisição para inclusão de estágio"},"AccrualStopMarkingResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Código de identificação da marcação de parada de acumulação","format":"int64","example":1},"account_id":{"type":"integer","description":"Código de identificação da conta","format":"int64","example":1},"dock_flag_stop":{"type":"boolean","description":"Marcação realizada pela Dock","example":false},"dock_update_date":{"type":"string","description":"Data de marcação realizada pela Dock","format":"date-time","example":"2023-12-15T11:00:00Z"},"issuer_stage":{"type":"integer","description":"Estagio incluido pelo emissor","format":"int32","example":1},"issuer_update_date":{"type":"string","description":"Data de marcação realizada pelo emissor","format":"date-time","example":"2023-12-15T11:00:00Z"},"curing_stage":{"type":"integer","description":"Estagio de cura","format":"int32","example":1},"curing_update_date":{"type":"string","description":"Data de marcação realizada pelo emissor","format":"date-time","example":"2023-12-15T11:00:00Z"},"is_processed":{"type":"boolean","description":"Indicador de que a marcação foi processada pelo batch","example":true},"effective_date_marking_accrual_stop":{"$ref":"#/components/schemas/AccrualStopMarkingEffectiveResponse"}},"description":"Objeto de resposta de marcação do Stop Accrual"},"AccrualStopMarkingEffectiveResponse":{"type":"object","properties":{"issuer_stage":{"type":"integer","description":"Estagio incluido pelo emissor","format":"int32","example":1},"effective_date":{"type":"string","description":"Data de vigência do estágio de dívida informado pelo emissor","format":"date-time","example":"2023-12-15T11:00:00Z"},"is_processed":{"type":"boolean","description":"Indicador de que a marcação foi processada pelo batch","example":true}},"description":"Objeto de resposta de marcação do Stop Accrual"},"PlatformApiError":{"type":"object","properties":{"error":{"required":["code","description","id"],"type":"object","properties":{"id":{"type":"string","description":"Código rastreador da requisição","example":"a3e6e02b-8f20-4c4e-8e40-c4aa8083d070"},"description":{"type":"string","description":"Descrição amigável do erro","example":"Dado informado inválido"},"code":{"type":"string","description":"Código do erro. Em caso de erro negocial, este campo assume o seguinte formato: [APP]-[CODE]. Para demais erros, será preenchido com o código de status HTTP","example":"DOCK-0001-RNF"},"error_details":{"uniqueItems":true,"type":"array","description":"Descrição de cada campo que possui um erro de contrato","items":{"$ref":"#/components/schemas/PlatformApiErrorDetail"}}},"description":"Resultado de erro para uma chamada http"}}},"PlatformApiErrorDetail":{"required":["attribute","messages"],"type":"object","properties":{"attribute":{"type":"string","description":"Nome do atributo que originou o erro","example":"birthdate"},"messages":{"uniqueItems":true,"type":"array","description":"Lista de causas do erro","example":["INVALID_FORMAT"],"items":{"type":"string","description":"Lista de causas do erro","example":"[\"INVALID_FORMAT\"]","enum":["INVALID_DATA_TYPE","INVALID_LENGTH","INVALID_FORMAT","INVALID_VALUE","REQUIRED_ATTRIBUTE_MISSING"]}}},"description":"Contém informações sobre erros de contrato"},"AccrualStopMarkingUpdate":{"required":["issuer_stage"],"type":"object","properties":{"issuer_stage":{"type":"integer","description":"Estágio para atualizar a marcação de dívida","format":"int32","example":1},"effective_date":{"type":"string","description":"Data de vigência do estágio de dívida informado pelo emissor","format":"date-time","example":"2023-12-15"}},"description":"Objeto para atualização de estágio"},"SortRequest":{"required":["sort"],"type":"object","properties":{"sort":{"type":"string","description":"Nome do campo a ser utilizado na ordenação","example":"id"},"order":{"type":"string","description":"Direção da ordenação. Utilize ASC para ordenação ascendente e DESC para descendente. Padrão ASC. Sem distinção de maiúsculas e minúsculas","example":"desc","default":"asc","enum":["ASC","DESC","asc","desc"]}},"description":"Ordenação da lista de dados. Ordenação padrão é ascendente"},"Ordination":{"type":"object","properties":{"sort":{"type":"string","description":"Nome do campo utilizado na ordenação","example":"id"},"order":{"type":"string","description":"Direção utilizada na ordenação","example":"desc","enum":["asc","desc"]}},"description":"Metadados da ordenação"},"PageMetadataResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"ordination":{"$ref":"#/components/schemas/Ordination"}},"description":"Metadados da listagem"},"Pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Página atual (inicia em 0)","format":"int32"},"limit":{"type":"integer","description":"Quantidade de elementos em cada página, não necessariamente igual ao tamanho da página atual","format":"int32"},"first":{"type":"boolean","description":"Flag que sinaliza se a página atual é a primeira"},"last":{"type":"boolean","description":"Flag que sinaliza se a página atual é a última"},"total_elements_count":{"type":"integer","description":"Quantidade total de elementos","format":"int64"},"page_count":{"type":"integer","description":"Quantidade de páginas resultantes","format":"int32"}},"description":"Metadados da paginação"},"PageResponseAccrualStopMarkingResponse":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/PageMetadataResponse"},"content":{"type":"array","description":"Conteúdo da página (pode ser vazio)","items":{"$ref":"#/components/schemas/AccrualStopMarkingResponse"}}},"description":"Conteúdo paginado"}},"securitySchemes":{"access_token":{"type":"apiKey","name":"access_token","in":"header"},"client_id":{"type":"apiKey","name":"client_id","in":"header"}}}}