{"swagger":"2.0","info":{"description":"[Cooperado] Respons\u00e1vel pelo gerenciamento de demonstrativos de pagamento","version":"1.0.0","title":"API V1 Demonstrativo"},"host":"api-unimedsp.sensedia.com","basePath":"\/sandboxis\/api\/v1\/demonstrativo","schemes":["https"],"paths":{"\/pagamento\/futuro\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamentos Futuros","description":"Retorna Demonstrativo de Pagamentos Futuros","operationId":"GetDemonstrativoPagamentoFuturo","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoFuturo"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/api\/v1\/demonstrativo\/pagamento\/mensal\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}\/pdf":{"get":{"summary":"Gerar PDF Demonstrativo de pagamentos mensal","description":"Gerar PDF Demonstrativo de pagamentos mensal","parameters":[],"responses":{"200":{"description":"OK"}}},"parameters":[{"name":"codigoSingular","in":"path","description":"codigoSingular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"codigoPrestador","required":true,"type":"string"},{"name":"competencia","in":"path","description":"competencia","required":true,"type":"string"}]},"\/impostorenda\/email":{"post":{"tags":["Demonstrativos"],"summary":"Invoca o servi\u00e7o de envio do relat\u00f3rio de demonstrativo de imposto de renda por email para e email destino","description":"Invoca o servi\u00e7o de envio do relat\u00f3rio de demonstrativo de imposto de renda por email para e email destino","operationId":"PostDemonsIREmail","consumes":["application\/json-patch.json","application\/json","text\/json","application\/*.json"],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"in":"body","name":"impostoRendaEmail","description":"Formul\u00e1rio email","required":false,"schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosIREmail"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/pagamento\/inss\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Mensal","description":"Retorna Demonstrativo de Pagamento Mensal","operationId":"GetDemonstrativoINSS","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"competencia","in":"path","description":"Data Compet\u00eancia","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoINSS"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/pagamento\/mensal\/email":{"post":{"tags":["Demonstrativos"],"summary":"Invoca o servi\u00e7o de envio do relat\u00f3rio de demonstrativo de pagamento por email para o prestador","description":"Invoca o servi\u00e7o de envio do relat\u00f3rio de demonstrativo de pagamento por email para o prestador","operationId":"PostPagamentoMensal","consumes":["application\/json-patch.json","application\/json","text\/json","application\/*.json"],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"in":"body","name":"pagamentoMensalEmail","description":"Formul\u00e1rio email","required":false,"schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosPagamentoMensalEmail"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/cotas\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/cpf\/{cpf}":{"get":{"tags":["Demonstrativos"],"summary":"Permitir a aplica\u00e7\u00e3o de backend buscar o demonstrativo de cotas parte do prestador na singular","description":"Permitir a aplica\u00e7\u00e3o de backend buscar o demonstrativo de cotas parte do prestador na singular","operationId":"GetCotasParte","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"cpf","in":"path","description":"CPF","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoDiario"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/pagamento\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Di\u00e1rio","description":"Retorna Demonstrativo de Pagamento Di\u00e1rio","operationId":"GetDemonstrativoPagamentoDiario","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"competencia","in":"path","description":"Compet\u00eancia","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoDiario"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/prestador\/{codigoPrestador}\/impostorenda\/{ano}\/pdf":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Mensal","description":"Retorna Demonstrativo de Pagamento Mensal","operationId":"GetPdfImpostoRenda","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do prestador","required":true,"type":"integer","format":"int32"},{"name":"ano","in":"path","description":"Ano referente ao IR desejado","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success"}}},"parameters":[]},"\/pagamento\/producao\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competenciaInicial}\/{competenciaFim}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Produ\u00e7\u00e3o","description":"Retorna Demonstrativo de Pagamento Produ\u00e7\u00e3o","operationId":"GetDemonstrativoProducao","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"competenciaInicial","in":"path","description":"Data Compet\u00eancia Inicial","required":true,"type":"string"},{"name":"competenciaFim","in":"path","description":"Data Compet\u00eancia Fim","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoProducao"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/api\/v1\/demonstrativo\/pagamento\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}\/pdf":{"get":{"summary":"Gerar PDF Demonstrativo de pagamentos di\u00e1rio","description":"Gerar PDF Demonstrativo de pagamentos di\u00e1rio","parameters":[],"responses":{"200":{"description":"OK"}}},"parameters":[{"name":"codigoSingular","in":"path","description":"codigoSingular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"codigoPrestador","required":true,"type":"string"},{"name":"competencia","in":"path","description":"competencia","required":true,"type":"string"}]},"\/pagamento\/mensal\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Mensal","description":"Retorna Demonstrativo de Pagamento Mensal","operationId":"GetDemonstrativoPagamentoMensal","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"competencia","in":"path","description":"Data Compet\u00eancia","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoMensal"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/{codigoSingular}\/prestador\/{codigoPrestador}\/impostorenda\/{competencia}":{"get":{"tags":["Demonstrativos"],"summary":"Retorna Demonstrativo de Pagamento Mensal","description":"Retorna Demonstrativo de Pagamento Mensal","operationId":"GetDemonstrativoIR","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"codigoSingular","in":"path","description":"C\u00f3digo da Singular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"C\u00f3digo do Prestador","required":true,"type":"integer","format":"int32"},{"name":"competencia","in":"path","description":"Data Compet\u00eancia","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDemonstrativoIR"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/api\/v1\/demonstrativo\/pagamento\/inss\/codigoSingular\/{codigoSingular}\/prestador\/{codigoPrestador}\/competencia\/{competencia}\/pdf":{"get":{"summary":"Gerar PDF Demonstrativo de INSS","description":"Gerar PDF Demonstrativo de INSS","parameters":[],"responses":{"200":{"description":"OK"}}},"parameters":[{"name":"codigoSingular","in":"path","description":"codigoSingular","required":true,"type":"string"},{"name":"codigoPrestador","in":"path","description":"codigoPrestador","required":true,"type":"string"},{"name":"competencia","in":"path","description":"competencia","required":true,"type":"string"}]}},"definitions":{"UnivisionFespAPIApplicationFiltersHttpGlobalExceptionFilter.JsonError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"remoteAddress":{"type":"string"},"path":{"type":"string"},"developerMessage":{"type":"object","properties":[]}}},"UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoDiario":{"type":"object","properties":{"data":{"type":"string","description":"Data"},"valor":{"type":"number","format":"double","description":"Valor"},"linkDownload":{"type":"string","description":"Link Download"}},"description":"Representa\u00e7\u00e3o da entidade de Situa\u00e7\u00e3o do Benefici\u00e1rio"},"UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoFuturo":{"type":"object","properties":{"natureza":{"type":"string","description":"Natureza"},"dataVencimento":{"type":"string","format":"date-time","description":"Data"},"valor":{"type":"number","format":"double","description":"Valor"}},"description":"Representa\u00e7\u00e3o da entidade de Demonstrativo Pagamento Futuro"},"UnivisionFespAPIModelDemonstrativosDemonstrativoProducao":{"type":"object","properties":{"tipoServico":{"type":"string"},"valor":{"type":"number","format":"double","description":"Valor"},"quantidade":{"type":"integer","format":"int32"},"competencia":{"type":"string","description":"Compet\u00eancia"}},"description":"Representa\u00e7\u00e3o da entidade de Demonstrativo de pagamentos produ\u00e7\u00e3o do prestador na singular."},"UnivisionFespAPIModelDemonstrativosDemonstrativoPagamentoMensal":{"type":"object","properties":{"debitos":{"type":"array","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosDebito"}},"creditos":{"type":"array","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosCredito"}},"linkDownload":{"type":"string"}},"description":"Representa\u00e7\u00e3o da entidade de Demonstrativo de Pagamento Mensal"},"UnivisionFespAPIModelDemonstrativosDebito":{"type":"object","properties":{"descricao":{"type":"string","description":"Descricao"},"base":{"type":"number","format":"double","description":"Base"},"total":{"type":"number","format":"double","description":"Total"}},"description":"Representa\u00e7\u00e3o da entidade de D\u00e9bito"},"UnivisionFespAPIModelDemonstrativosCredito":{"type":"object","properties":{"descricao":{"type":"string","description":"Descricao"},"total":{"type":"number","format":"double","description":"Total"}},"description":"Representa\u00e7\u00e3o da entidade de Cr\u00e9dito"},"UnivisionFespAPIModelDemonstrativosDemonstrativoIR":{"type":"object","properties":{"nomePrestador":{"type":"string","description":"Nome Prestador"},"cpfPrestador":{"type":"string","description":"CPF Prestador"},"unimedDesc":{"type":"string","description":"Descri\u00e7\u00e3o Unimed"},"cnpj":{"type":"string","description":"CNPJ"},"rendimentosTributaveis":{"type":"array","description":"Rendimentos Tributaveis","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosRendimentoBase"}},"rendimentosIsentos":{"type":"array","description":"Rendimentos Isentos","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosRendimentoBase"}},"rendimentosTributacaoExclusiva":{"type":"array","description":"Rendimentos Tributacao Exclusiva","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosRendimentoBase"}},"rendimentosRecebidosAcumulante":{"type":"array","description":"Rendimentos Recebido Acumulante","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosRendimentoBase"}},"informacoesComplementares":{"description":"Informa\u00e7\u00f5es Complementares","$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosInformacaoComplementar"}},"description":"Representa\u00e7\u00e3o da entidade Demonstrativo de IR"},"UnivisionFespAPIModelDemonstrativosRendimentoBase":{"type":"object","properties":{"posicao":{"type":"integer","format":"int32","description":"Posi\u00e7\u00e3o"},"valor":{"type":"number","format":"double","description":"Valor"}}},"UnivisionFespAPIModelDemonstrativosInformacaoComplementar":{"type":"object","properties":{"itens":{"type":"array","description":"Itens","items":{"$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosItens"}}}},"UnivisionFespAPIModelDemonstrativosItens":{"type":"object","properties":{"item":{"type":"string","description":"Descri\u00e7\u00e3o do Item"},"lista":{"type":"array","description":"Lista","items":{"type":"string"}},"tabela":{"type":"array","description":"Tabela","items":{"type":"array","items":{"type":"string"}}}}},"UnivisionFespAPIModelDemonstrativosDemonstrativoINSS":{"type":"object","properties":{"baseCalculoPf":{"type":"number","format":"double","description":"Base de Calculo pessoa fisica"},"valorTeto":{"type":"number","format":"double","description":"Valor Teto"},"valorInss":{"type":"number","format":"double","description":"Valor INSS"},"valorBase":{"type":"number","format":"double","description":"Valor Base"},"competencia":{"type":"string","description":"Competencia"},"fontePagadora":{"description":"Fonte Pagadora","$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosFontePagadora"},"prestador":{"description":"Prestador","$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosPrestador"}},"description":"Representa\u00e7\u00e3o da entidade Demonstrativo de INSS"},"UnivisionFespAPIModelDemonstrativosFontePagadora":{"type":"object","properties":{"unimed":{"type":"integer","format":"int32","description":"Unimed"},"cnpj":{"type":"string","description":"CNPJ"},"razaoSocial":{"type":"string","description":"Raz\u00e3o Social"},"endereco":{"description":"Endereco","$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosEndereco"}}},"UnivisionFespAPIModelDemonstrativosPrestador":{"type":"object","properties":{"inscricaoInss":{"type":"string","description":"Inscricao Inss"},"cpf":{"type":"string","description":"CPF"},"nome":{"type":"string","description":"Nome"},"endereco":{"description":"Endereco","$ref":"#\/definitions\/UnivisionFespAPIModelDemonstrativosEndereco"}}},"UnivisionFespAPIModelDemonstrativosEndereco":{"type":"object","properties":{"uf":{"type":"string","description":"UF"},"cidade":{"type":"string","description":"Cidade"},"numero":{"type":"integer","format":"int32","description":"Numero"},"logradouro":{"type":"string","description":"Logradouro"},"bairro":{"type":"string","description":"Bairro"}},"description":"Representa\u00e7\u00e3o da entidade Endere\u00e7o"},"UnivisionFespAPIModelDemonstrativosPagamentoMensalEmail":{"type":"object","properties":{"codigoPrestador":{"type":"string"},"unimed":{"type":"string"},"competencia":{"type":"string"},"email":{"type":"string"}},"description":"Representa\u00e7\u00e3o da entidade Pagamento Mensal"},"UnivisionFespAPIModelDemonstrativosIREmail":{"type":"object","properties":{"codigoPrestador":{"type":"string"},"unimed":{"type":"string"},"competencia":{"type":"string"},"email":{"type":"string"}},"description":"Representa\u00e7\u00e3o da entidade Imposto de Renda"}},"parameters":{"client_id":{"name":"client_id","in":"header","description":"Token de identifica\u00e7\u00e3o do app","required":true,"type":"string"},"authorization":{"name":"authorization","in":"header","description":"Credenciais para autenticar o agente de usu\u00e1rio com o servidor","required":true,"type":"string"}},"x-servers":{"4":"https:\/\/api-unimedsp.sensedia.com\/sandboxis\/"}}