API Refunds - v1.000 (Attendance)

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"healthInsurerCode\" : \"0001\",\r\n\t\"subscriberId\" : \"00011008000027010\",\r\n    \"refundReceipts\" : [\r\n        {\r\n            \"unreferencedNetworkIdentifier\" : \"77077733000159\",\r\n            \"unreferencedNetworkName\" : \"JOSE\",\r\n            \"stateAbbreviation\" : \"SP\",\r\n            \"cityCode\" : \"3500105\",\r\n            \"documentCode\" : \"03\",\r\n            \"documentNumber\" : \"000001235\",\r\n            \"documentDate\" : \"2023-06-07\",\r\n            \"expenses\" : [\r\n                {\r\n                    \"subscriberId\" : \"00011008000027010\",\r\n                    \"procedureClass\" : \"000005\",\r\n                    \"tableCode\" : \"04\",\r\n                    \"procedureCode\": \"0490173961\",\r\n                    \"continuousUse\" : \"1\",\r\n                    \"prescriptionCode\" : \"41750520230419000001\",\r\n                    \"expenseAmount\": 250,\r\n                    \"quantity\" : 1,\r\n                    \"executionDate\" : \"2023-06-07\"\t\t\r\n                }\r\n            ],\r\n            \"attachments\" : [\r\n                {\r\n                    \"href\" : \"https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}<<"
}

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo status",
            "detailedMessage": "O valor do campo status deve ser do tipo (C)."
        },
        {
            "code": "E002F-406",
            "message": "Valor inválido para o campo status",
            "detailedMessage": "O valor do campo status deve ser: 0;1"
        },
        {
            "code": "E002B-406",
            "message": "Campo healthInsurerCode obrigatório",
            "detailedMessage": "Não foi informado valor do campo healthInsurerCode."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo healthInsurerCode",
            "detailedMessage": "O valor do campo healthInsurerCode deve ter o tamanho 4."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        },
        {
            "code": "E002B-406",
            "message": "Campo refundReceipts obrigatório",
            "detailedMessage": "Não foi informado valor do campo refundReceipts."
        }
    ]
}

{
    "code": "E003",
    "message": "Dados inválidos para realizar a solicitação de reembolso",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E004A-404",
            "message": "Operadora de saúde não encontrada",
            "detailedMessage": "Não foi encontrada nenhuma operadora de saúde com o código 0099 no cadastro (BA0)"
        },
        {
            "code": "E004B-404",
            "message": "Beneficiário solicitante não encontrado",
            "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012 no cadastro (BA1)"
        }
    ]
}

{
    "code": "E001",
    "message": "as chaves do query param estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001A-406",
            "message": "Campo requestDateInitial não informado",
            "detailedMessage": "Não foi informado o campo request-date-initial."
        },
        {
            "code": "E001A-406",
            "message": "Campo requestDateFinal não informado",
            "detailedMessage": "Não foi informado o campo request-date-final."
        },
        {
            "code": "E001A-406",
            "message": "Campo subscriberId não informado",
            "detailedMessage": "Não foi informado o campo subscriber-id."
        }
    ]
}

{
    "code": "E002",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027013 no cadastro (BA1)"
}

{
    "code": "E001",
    "message": "A chave do path param esta inválida",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        }
    ]
}

{
    "code": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000019 na base de dados (BOW)"
}

{
    "code": "E003",
    "message": "Não foi possível excluir esta solicitação pois já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente excluir protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>}<<"
}

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ser do tipo (C)."
        }
    ]
}

{
    "code": "E003",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000019 na base de dados (BOW)"
}

{
    "code": "E004",
    "message": "Permite finalizar protocolo de reembolso somente com o status de solicitação não concluida",
    "detailedMessage": "Permitido somente finalizar protocolos com o status (BOW_STATUS) igual a 0 (Solicitação não concluida)"
}

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave protocol obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave protocol."
        }
    ]
}

{
    "code": "E002",
    "message": "Protocolo não encontrado",
    "detailedMessage": "Não foi encontrada na tabela BOW o protocol 41750520230607000099 (BOW_PROTOC)."
}

{
    "code": "E001",
    "message": "as chaves do query param estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001A-406",
            "message": "Campo requestDateInitial não informado",
            "detailedMessage": "Não foi informado o campo requestDateInitialrequestDateInitial."
        },
        {
            "code": "E001A-406",
            "message": "Campo requestDateFinal não informado",
            "detailedMessage": "Não foi informado o campo requestDateFinal."
        },
        {
            "code": "E001A-406",
            "message": "Campo subscriberId não informado",
            "detailedMessage": "Não foi informado o campo subscriberId."
        }
    ]
}

{
    "code": "E002",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027013 no cadastro (BA1)"
}

{
    "code": "E001",
    "message": "As chaves do path param estão inválidas",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E001B-406",
            "message": "Campo sequential obrigatório",
            "detailedMessage": "Não foi informado valor do campo sequential."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo sequential",
            "detailedMessage": "O valor do campo sequential deve ter o tamanho 3."
        }
    ]
}

{
    "code": "E004",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230605000100 (BOW_PROTOC) na base de dados (BOW)"
}

{
    "code": "E005",
    "message": "Não permitido incluir, alterar ou excluir despesa pois a solicitação já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente incluir, alterar, excluir despesas para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

{
    "code": "E006",
    "message": "Despesa não encontrada para o protocolo de reembolso 41750520230607000014",
    "detailedMessage": "Não foi encontrada a despesa de sequencial 002 (B1N_SEQUEN) para o protocolo 41750520230607000014 (BOW_PROTOC)"
}

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"subscriberId\": \"00011008000027010\",\r\n    \"unreferencedNetworkIdentifier\": \"77077733000159\",\r\n    \"unreferencedNetworkName\": \"JOSE\",\r\n    \"stateAbbreviation\": \"SP\",\r\n    \"cityCode\": \"3500105\",\r\n    \"documentCode\": \"03\",\r\n    \"documentNumber\": \"0000012350\",\r\n    \"documentDate\": \"2023-04-23\",\r\n    \"procedureClass\": \"000001\",\r\n    \"tableCode\": \"01\",\r\n    \"procedureCode\": \"10101012\",\r\n    \"continuousUse\": \"0\",\r\n    \"prescriptionCode\" : \"\",\r\n    \"expenseAmount\": 500,\r\n    \"quantity\": 1,\r\n    \"executionDate\": \"2023-04-23\"\r\n}<<"
}

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E002B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        },
        {
            "code": "E002A-406",
            "message": "Campo stateAbbreviation não informado",
            "detailedMessage": "Não foi informado o campo stateAbbreviation."
        },
        {
            "code": "E002F-406",
            "message": "Valor inválido para o campo continuousUse",
            "detailedMessage": "O valor do campo continuousUse deve ser: 0;1"
        }
    ]
}

{
    "code": "E004",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000099 (BOW_PROTOC) na base de dados (BOW)"
}

{
    "code": "E005",
    "message": "Não permitido incluir, alterar ou excluir despesa pois a solicitação já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente incluir, alterar, excluir despesas para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

{
    "code": "E003",
    "message": "Dados inválidos para realizar a inclusão da despesa",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E005C-404",
            "message": "Código do documento não encontrado",
            "detailedMessage": "Não foi encontrado nenhum documento com o código 99 no cadastro (BBS)"
        },
        {
            "code": "E005D-404",
            "message": "Estado e Cidade não encontrado",
            "detailedMessage": "Não foi encontrado nenhum estado SP e cidade 3500106 no cadastro (BID)"
        }
    ]
}

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"subscriberId\": \"00011008000027010\",\r\n    \"unreferencedNetworkIdentifier\": \"77077733000159\",\r\n    \"unreferencedNetworkName\": \"JOSE\",\r\n    \"stateAbbreviation\": \"SP\",\r\n    \"cityCode\": \"3500105\",\r\n    \"documentCode\": \"03\",\r\n    \"documentNumber\": \"0000012350\",\r\n    \"documentDate\": \"2023-04-23\",\r\n    \"procedureClass\": \"000001\",\r\n    \"tableCode\": \"01\",\r\n    \"procedureCode\": \"10101012\",\r\n    \"continuousUse\": \"0\",\r\n    \"prescriptionCode\" : \"\",\r\n    \"expenseAmount\": 500,\r\n    \"quantity\": 1,\r\n    \"executionDate\": \"2023-04-23\"\r\n}<<"
}

{
    "code": "E002",
    "message": "As chaves do path param estão inválidas",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E002B-406",
            "message": "Campo sequential obrigatório",
            "detailedMessage": "Não foi informado valor do campo sequential."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo sequential",
            "detailedMessage": "O valor do campo sequential deve ter o tamanho 3."
        }
    ]
}

{
    "code": "E003",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E003E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E003B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E003E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        },
        {
            "code": "E003A-406",
            "message": "Campo stateAbbreviation não informado",
            "detailedMessage": "Não foi informado o campo stateAbbreviation."
        },
        {
            "code": "E003F-406",
            "message": "Valor inválido para o campo continuousUse",
            "detailedMessage": "O valor do campo continuousUse deve ser: 0;1"
        }
    ]
}

{
    "code": "E004",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000099 (BOW_PROTOC) na base de dados (BOW)"
}

{
    "code": "E005",
    "message": "Não permitido incluir, alterar ou excluir despesa pois a solicitação já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente incluir, alterar, excluir despesas para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

{
    "code": "E003",
    "message": "Dados inválidos para realizar a inclusão da despesa",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E005C-404",
            "message": "Código do documento não encontrado",
            "detailedMessage": "Não foi encontrado nenhum documento com o código 99 no cadastro (BBS)"
        },
        {
            "code": "E005D-404",
            "message": "Estado e Cidade não encontrado",
            "detailedMessage": "Não foi encontrado nenhum estado SP e cidade 3500106 no cadastro (BID)"
        }
    ]
}

{
    "code": "E001",
    "message": "As chave do path param está inválida",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E001B-406",
            "message": "Campo sequential obrigatório",
            "detailedMessage": "Não foi informado valor do campo sequential."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo sequential",
            "detailedMessage": "O valor do campo sequential deve ter o tamanho 3."
        }
    ]
}

{
    "code": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230607000088 (BOW_PROTOC)"
}

{
    "code": "E003",
    "message": "Despesa não encontrada para o protocolo de reembolso 41750520230607000006",
    "detailedMessage": "Não foi encontrada a despesa de sequencial 002 (B1N_SEQUEN) para o protocolo 41750520230607000006 (BOW_PROTOC)"
}

{
    "code": "E004",
    "message": "Não encontrada motivo de glosa para a despesa",
    "detailedMessage": "Não foi encontrada nenhum motivo de glosa do sequencial 001 (B1N_SEQUEN) para o protocolo 41750520230607000015 (BOW_PROTOC) na tabela B14"
}

{
    "code": "E001",
    "message": "A chave do path param está inválida",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        }
    ]
}

{
    "code": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230602000070 (BOW_PROTOC)"
}

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>{\r\n            \"href\" : \"https://www.totvs.com/wp-content/uploads/2022/03/sistema-de-gestao-erp-protheus-01-financeiro.jpg\"\r\n        }\r\n    ]\r\n}<<"
}

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E002B-406",
            "message": "Campo attachments obrigatório",
            "detailedMessage": "Não foi informado valor do campo attachments."
        }
    ]
}

{
    "code": "E003",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo de reembolso com o numero 41750520230607000099 (BOW_PROTOC)"
}

{
    "code": "E007",
    "message": "Permitido anexar documentos no protocolo somente no status de solicitação não concluida e aguardando informação do beneficiário",
    "detailedMessage": "Permitido somente anexar documentos no protocolo com o status (BOW_STATUS) igual a A (Solicitação não concluida) ou B (Aguardando informação do beneficiário)"
}

{
    "code": "E006",
    "message": "Dados inválidos para realizar a inclusão dos anexos",
    "detailedMessage": "Verifique os detalhes dos erros no campo details",
    "details": [
        {
            "code": "E005-400",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://www.totvs.com/wp-content/uploads/2021/09/totvs-shared.png"
        }
    ]
}

{
    "code": "E001",
    "message": "As chaves do path param estão inválidas",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo protocol obrigatório",
            "detailedMessage": "Não foi informado valor do campo protocol."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ter o tamanho 20."
        },
        {
            "code": "E001B-406",
            "message": "Campo code obrigatório",
            "detailedMessage": "Não foi informado valor do campo code."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo code",
            "detailedMessage": "O valor do campo code deve ter o tamanho 10."
        }
    ]
}

{
    "code": "E002",
    "message": "Protocolo de reembolso não encontrado",
    "detailedMessage": "Não foi encontrado o protocolo de reembolso 41750520230607000099 (BOW_PROTOC) na base de dados (BOW)"
}

{
    "code": "E003",
    "message": "Não foi possível excluir o anexo pois a solicitação já esta protocolada, entre em contato com a operadora",
    "detailedMessage": "Permitido somente excluir anexos para protocolos com o status (BOW_STATUS) igual a A (Solicitação não concluida)"
}

{
    "code": "E004",
    "message": "Anexo não encontrada para o protocolo de reembolso 41750520230607000012",
    "detailedMessage": "Não foi encontrada o anexo de código 0000000999 (ACB_CODOBJ) para o protocolo 41750520230607000012 (BOW_PROTOC)"
}