erp_scv

aqs_aquisicao

27 views 22/10/2018 13/11/2019 integrador 0

2.0info: 3.3.0 aqs_aquisicao description: \n Siscoserv – Aquisição/Venda\n \n ### Documentação:\n – [Siscoserv](https://documentacao.senior.com.br/gestaoempresarialerp/7.0.0/index.htm#compliance/siscoserv/introducao.htm)\n – [Aquisição](https://documentacao.senior.com.br/gestaoempresarialerp/7.0.0/compliance/siscoserv/introducao.htm#Aquisi%C3%A7%C3%A3o)\n – [Venda](https://documentacao.senior.com.br/gestaoempresarialerp/7.0.0/index.htm#compliance/siscoserv/introducao.htm#Venda) x-senior-domain: erp_scv x-senior-domain-path: erp_scv x-senior-service-path: aqs_aquisicao contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_scvsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /aqs_aquisicao/queries/pesquisarRAS: post: description: \n Realizar pesquisa de registros de aquisição de serviço (RAS).\n Retorna uma lista paginada de RAS.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: idsEmpresas: type: array items: type: integer format: int64 description: Identificação da Empresa idsFiliais: type: array items: type: integer format: int64 description: Identificação da Filial numeroRASEmpresa: type: string maxLength: 100 description: Identificador unívoco do RAS idsParticipantes: type: array items: type: integer format: int64 description: Identificação do adquirente dataInicioDe: type: string format: date description: Data de início da prestação do serviço vendido (a partir de) dataInicioAte: type: string format: date description: Data de início da prestação do serviço vendido (Até) dataConclusaoDe: type: string format: date description: Data de conclusão da prestação do serviço vendido (a partir de) dataConclusaoAte: type: string format: date description: Data de conclusão da prestação do serviço vendido (Até) situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do registro pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação integradoGoverno: type: string allOf: – #/definitions/enumOpcaoIntegradoGoverno description: Exibir registros integrados com o governo? responses: 200: description: Ok schema: type: object required: – listaRAS – totalRegistros properties: listaRAS: type: array items: type: object allOf: – #/definitions/recPesquisaRAS minimum: 1 description: Lista de RAS totalRegistros: type: integer format: int64 description: Total de registros para paginação default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarRVS: post: description: \n Realizar pesquisa de registros de venda de serviço (RVS).\n Retorna uma lista paginada de RVS.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: idsEmpresas: type: array items: type: integer format: int64 description: Identificação da Empresa idsFiliais: type: array items: type: integer format: int64 description: Identificação da Filial numeroRVSEmpresa: type: string maxLength: 100 description: Identificador unívoco do RVS idsParticipantes: type: array items: type: integer format: int64 description: Identificação do adquirente dataInicioDe: type: string format: date description: Data de início da prestação do serviço vendido (a partir de ) dataInicioAte: type: string format: date description: Data de início da prestação do serviço vendido (Até) dataConclusaoDe: type: string format: date description: Data de conclusão da prestação do serviço vendido (a partir de ) dataConclusaoAte: type: string format: date description: Data de conclusão da prestação do serviço vendido (Até) situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do registro pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação integradoGoverno: type: string allOf: – #/definitions/enumOpcaoIntegradoGoverno description: Exibir registros integrados com o governo? responses: 200: description: Ok schema: type: object required: – listaRVS – totalRegistros properties: listaRVS: type: array items: type: object allOf: – #/definitions/recPesquisaRVS minimum: 1 description: Lista de RVS totalRegistros: type: integer format: int64 description: Total de registros para paginação default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarFaturamentoCancelar: post: description: \n Pesquisar Registros de Faturamentos (RF) para cancelar.\n Retorna uma lista paginada de RF.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idsEmpresas: type: array items: type: integer format: int64 description: Identificação da Empresa idsFiliais: type: array items: type: integer format: int64 description: Identificação da Filial idsParticipantes: type: array items: type: integer format: int64 description: Identificação do adquirente numeroRVSEmpresa: type: string maxLength: 100 description: Identificador unívoco do RVS numeroTituloEmpresa: type: string maxLength: 100 description: Identificador unívoco do Titulo dataTituloDe: type: string format: date description: Data de início da prestação do serviço vendido (a partir de ) dataTituloAte: type: string format: date description: Data de início da prestação do serviço vendido (Até) responses: 200: description: Ok schema: type: object required: – listaFaturamento properties: listaFaturamento: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Lista de Faturamentos default: description: Error response schema: #/definitions/genericError get: description: \n Pesquisar Registros de Faturamentos (RF) para cancelar.\n Retorna uma lista paginada de RF.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idsEmpresas description: Identificação da Empresa in: query type: array items: type: integer format: int64 – name: idsFiliais description: Identificação da Filial in: query type: array items: type: integer format: int64 – name: idsParticipantes description: Identificação do adquirente in: query type: array items: type: integer format: int64 – name: numeroRVSEmpresa description: Identificador unívoco do RVS in: query type: string maxLength: 100 – name: numeroTituloEmpresa description: Identificador unívoco do Titulo in: query type: string maxLength: 100 – name: dataTituloDe description: Data de início da prestação do serviço vendido (a partir de ) in: query type: string format: date – name: dataTituloAte description: Data de início da prestação do serviço vendido (Até) in: query type: string format: date responses: 200: description: Ok schema: type: object required: – listaFaturamento properties: listaFaturamento: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Lista de Faturamentos default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarPagamentoCancelar: post: description: \n Pesquisar Registros de Pagamentos (RP) para Cancelar.\n Retorna uma lista paginada de RP.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idsEmpresas: type: array items: type: integer format: int64 description: Identificação da Empresa idsFiliais: type: array items: type: integer format: int64 description: Identificação da Filial idsParticipantes: type: array items: type: integer format: int64 description: Identificação do adquirente numeroRASEmpresa: type: string maxLength: 100 description: Identificador unívoco do RVS numeroTituloEmpresa: type: string maxLength: 100 description: Identificador unívoco do Titulo dataTituloDe: type: string format: date description: Data de início da prestação do serviço vendido (a partir de ) dataTituloAte: type: string format: date description: Data de início da prestação do serviço vendido (Até) responses: 200: description: Ok schema: type: object required: – listaPagamento properties: listaPagamento: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Lista de Pagamentos default: description: Error response schema: #/definitions/genericError get: description: \n Pesquisar Registros de Pagamentos (RP) para Cancelar.\n Retorna uma lista paginada de RP.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idsEmpresas description: Identificação da Empresa in: query type: array items: type: integer format: int64 – name: idsFiliais description: Identificação da Filial in: query type: array items: type: integer format: int64 – name: idsParticipantes description: Identificação do adquirente in: query type: array items: type: integer format: int64 – name: numeroRASEmpresa description: Identificador unívoco do RVS in: query type: string maxLength: 100 – name: numeroTituloEmpresa description: Identificador unívoco do Titulo in: query type: string maxLength: 100 – name: dataTituloDe description: Data de início da prestação do serviço vendido (a partir de ) in: query type: string format: date – name: dataTituloAte description: Data de início da prestação do serviço vendido (Até) in: query type: string format: date responses: 200: description: Ok schema: type: object required: – listaPagamento properties: listaPagamento: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Lista de Pagamentos default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarTitulos: post: description: \n Pesquisar Registros de Faturamento (RF) / Pagamento (RP).\n Retorna o documento (RVS/RAS) com suas respectivas operações juntamente com seus títulos (RF/RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento properties: idDocumento: type: integer format: int64 description: Identificao Documento (RVS/RAS) responses: 200: description: Ok schema: type: object required: – documentoTitulo – ultimoNumeroTituloCadastrado properties: documentoTitulo: type: object allOf: – #/definitions/recDocumentoTitulos description: Títulos (RF/RP) por documentos ultimoNumeroTituloCadastrado: type: string description: Ultimo faturamento/pagamento cadastrado para a operação default: description: Error response schema: #/definitions/genericError get: description: \n Pesquisar Registros de Faturamento (RF) / Pagamento (RP).\n Retorna o documento (RVS/RAS) com suas respectivas operações juntamente com seus títulos (RF/RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idDocumento description: Identificao Documento (RVS/RAS) in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – documentoTitulo – ultimoNumeroTituloCadastrado properties: documentoTitulo: type: object allOf: – #/definitions/recDocumentoTitulos description: Títulos (RF/RP) por documentos ultimoNumeroTituloCadastrado: type: string description: Ultimo faturamento/pagamento cadastrado para a operação default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/consultaRVSxRF: post: description: \n Consulta Registro de Venda (RVS) x Registro de Faturamento (RF).\n Retorna o RVS com sua situação atual e valores totalizados.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pagina properties: filtro: type: object allOf: – #/definitions/recFiltroConsulta description: Filtro para consulta pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação responses: 200: description: Ok schema: type: object required: – quantidadeRegistros – registros properties: quantidadeRegistros: type: integer format: int64 description: Quantidade de registros retornados registros: type: array items: type: object allOf: – #/definitions/recConsulta minimum: 1 description: Dados consulta RVS x RF default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/consultaRASxRP: post: description: \n Consulta Registro de Aquisição de Serviço (RAS) x Registro de Pagamento (RP).\n Retorna o RAS com sua situação atual e valores totalizados.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pagina properties: filtro: type: object allOf: – #/definitions/recFiltroConsulta description: Filtro para consulta pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação responses: 200: description: Ok schema: type: object required: – quantidadeRegistros – registros properties: quantidadeRegistros: type: integer format: int64 description: Quantidade de registros retornados registros: type: array items: type: object allOf: – #/definitions/recConsulta minimum: 1 description: Dados consulta RVS x RF default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/relatorioConsulta: post: description: \n Relatório Consulta Documento (RVS/RAS) x Titulo (RF/RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modulo – filtro properties: modulo: type: string allOf: – #/definitions/enumModulo description: Módulo do relatório a ser gerado filtro: type: object allOf: – #/definitions/recFiltroConsulta description: Filtro para consulta responses: 200: description: Ok schema: type: object required: – relatorio properties: relatorio: type: string format: byte description: Relatório codificado como Base64, sendo necessário decodifica-lo para impressão default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/ultimoLog: post: description: \n Retorna o último log para um determinado processo.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processo properties: processo: type: string allOf: – #/definitions/enumProcesso description: Processo filialId: type: integer format: int64 description: Identificação da Filial responses: 200: description: Ok schema: type: object required: – log properties: log: type: string description: Log do processo default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarArquivosGerados: post: description: \n Pesquisar arquivos gerados.\n Retorna a lista paginada de arquivos gerados.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: periodoGeracao: type: object allOf: – #/definitions/recPeriodoOpcional description: Período da geração do arquivo periodo: type: object allOf: – #/definitions/recPeriodo description: Período aplicado ao filtro idsFiliais: type: array items: type: integer format: int64 description: Identificação da Filial modulo: type: array items: type: string allOf: – #/definitions/enumModulo description: Módulo tipoArquivo: type: array items: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo de arquivo pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação responses: 200: description: Ok schema: type: object required: – totalRegistros properties: listaArquivo: type: array items: type: object allOf: – #/definitions/recArquivoLote description: Lista de arquivos gerados totalRegistros: type: integer format: int64 description: Total de registros para paginação default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/pesquisarTitulo: post: description: \n Pesquisar Registro de Faturamento (RF) / Pagamento (RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idDocumento: type: integer format: int64 description: Identificação do Documento (RVS/RAS) numeroTitulo: type: string maxLength: 60 description: Identificação do Titulo (RF/RP) responses: 200: description: Ok schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Titulos encontrados default: description: Error response schema: #/definitions/genericError get: description: \n Pesquisar Registro de Faturamento (RF) / Pagamento (RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idDocumento description: Identificação do Documento (RVS/RAS) in: query type: integer format: int64 – name: numeroTitulo description: Identificação do Titulo (RF/RP) in: query type: string maxLength: 60 responses: 200: description: Ok schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Titulos encontrados default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/detalharTituloConsulta: post: description: \n Exibir detalhes dos Registros de Pagamentos (RP) / Faturamentos (RF) a partir de um identificador de Registro de Aquisição de Serviço (RAS) / Venda de Serviço (RVS).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – pagina properties: idDocumento: type: integer format: int64 description: Identificador do RAS/RVS pagina: type: object allOf: – #/definitions/recPagina description: Informações de paginação responses: 200: description: Ok schema: type: object required: – quantidadeRegistros – dados properties: quantidadeRegistros: type: integer format: int64 description: Quantidade total de registros dados: type: array items: type: object allOf: – #/definitions/recDetalheTituloConsulta minimum: 1 description: Detalhamento do RP/RF default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/processarItemTitulo: post: description: \n Processar Item Título (RF/RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumento – itemTitulo properties: idDocumento: type: integer format: int64 description: Identificao Documento (RVS/RAS) itemTitulo: type: array items: type: object allOf: – #/definitions/recItemTitulo minimum: 1 description: Item título responses: 200: description: Ok schema: type: object required: – documentoTitulo – ultimoNumeroTituloCadastrado properties: documentoTitulo: type: object allOf: – #/definitions/recDocumentoTitulos description: Documento Título ultimoNumeroTituloCadastrado: type: string description: Ultimo Faturamento cadastrado para a Operação default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/cancelarPagamento: post: description: \n Solicitação de cancelamento de Pagamento (RP).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPagamento properties: idPagamento: type: array items: type: integer format: int64 minimum: 1 description: Identificação do Pagamento a ser cancelado responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: string description: Mensagem de retorno do cancelamento default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/cancelarFaturamento: post: description: \n Solicitação de cancelamento para o Faturamento (RF).\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFaturamento properties: idFaturamento: type: array items: type: integer format: int64 minimum: 1 description: Identificação do Faturamento a ser cancelado responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: string description: Mensagem de retorno do cancelamento default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/obterUriDownloadArquivo: post: description: \n Obter URI para download de arquivo armazenado no blob-service.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – diretorio – nomeArquivo properties: diretorio: type: string description: Diretório do arquivo no blob-service nomeArquivo: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – uri properties: uri: type: string description: URI para download do arquivo default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/obterUriUploadArquivo: post: description: \n Obter URI para upload de arquivo no blob-service.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – diretorio – nomeArquivo properties: diretorio: type: string description: Diretório do arquivo no blob-service nomeArquivo: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – uploadInfo properties: uploadInfo: type: object allOf: – #/definitions/recUploadInfo description: Dados para upload no blob-service default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/actions/importarRetornoLote: post: description: \n Importar retorno lote XML.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFilial – uploadInfo properties: idFilial: type: integer format: int64 description: Identificação filial uploadInfo: type: object allOf: – #/definitions/recUploadInfo description: Dados de upload do arquivo responses: 200: description: Ok schema: type: object required: – tipoArquivo – retorno properties: tipoArquivo: type: string allOf: – #/definitions/enumTipoRetornoLote description: Tipo de arquivo do lote retorno: type: array items: type: object allOf: – #/definitions/recRetorno minimum: 1 description: Lista de itens do lote default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/signals/gerarArquivosSiscoserv: post: description: \n Gerar Arquivos para SISCOSERV.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – listaFiliais – modulos – periodo properties: listaFiliais: type: array items: type: object allOf: – #/definitions/recEmpresaFilial minimum: 1 description: Lista de Identificação de Filiais modulos: type: array items: type: string allOf: – #/definitions/enumModulo minimum: 1 description: Módulo periodo: type: object allOf: – #/definitions/recPeriodo description: Período responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/signals/retornarDadosG5: post: description: \n Retornar Dados do Gestão Empresarial Senior.\n \n ### Resources:\n – res://senior.com.br/erp_scv/aqs_aquisicao/siscoserv\n – Action: Visualizar\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dataInicial – dataFinal – tipoDocumento properties: empresaFilial: type: array items: type: object allOf: – #/definitions/recEmpresasFilial description: Abrangência de Empresa/Filial dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo Documento notaComoRFeRVS: type: boolean description: Nota fiscal de saída deverá ser Registro de Venda de Serviços (RVS) e Regitro de Faturamento (RF) no Siscoserv? atualizarEmpresaFilial: type: boolean description: Atualizar cadastros das empresas e filiais no Siscosrv? responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRAS: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entRAS responses: 200: description: The created resource schema: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entRAS responses: 200: description: The created resource schema: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRAS/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entRAS responses: 200: description: Ok schema: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entRAS responses: 200: description: Ok schema: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entRAS default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRAS/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entRAS responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRVS: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entRVS responses: 200: description: The created resource schema: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entRVS responses: 200: description: The created resource schema: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRVS/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entRVS responses: 200: description: Ok schema: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entRVS responses: 200: description: Ok schema: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entRVS default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entRVS/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entRVS responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entOperacao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entOperacao responses: 200: description: The created resource schema: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entOperacao responses: 200: description: The created resource schema: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entOperacao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entOperacao responses: 200: description: Ok schema: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entOperacao responses: 200: description: Ok schema: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entOperacao default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entOperacao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entOperacao responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entEnquadramento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEnquadramento responses: 200: description: The created resource schema: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEnquadramento responses: 200: description: The created resource schema: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entEnquadramento/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entEnquadramento responses: 200: description: Ok schema: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entEnquadramento responses: 200: description: Ok schema: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entEnquadramento default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entEnquadramento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entEnquadramento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entNumeroRCEnquadramento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entNumeroRCEnquadramento responses: 200: description: The created resource schema: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entNumeroRCEnquadramento responses: 200: description: The created resource schema: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entNumeroRCEnquadramento/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entNumeroRCEnquadramento responses: 200: description: Ok schema: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entNumeroRCEnquadramento responses: 200: description: Ok schema: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entNumeroRCEnquadramento default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entNumeroRCEnquadramento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entNumeroRCEnquadramento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumRE: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entVinculacaoNumRE responses: 200: description: The created resource schema: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entVinculacaoNumRE responses: 200: description: The created resource schema: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumRE/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entVinculacaoNumRE responses: 200: description: Ok schema: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entVinculacaoNumRE responses: 200: description: Ok schema: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entVinculacaoNumRE default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumRE/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entVinculacaoNumRE responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumDI: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entVinculacaoNumDI responses: 200: description: The created resource schema: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entVinculacaoNumDI responses: 200: description: The created resource schema: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumDI/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entVinculacaoNumDI responses: 200: description: Ok schema: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entVinculacaoNumDI responses: 200: description: Ok schema: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entVinculacaoNumDI default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /aqs_aquisicao/entities/entVinculacaoNumDI/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entVinculacaoNumDI responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoRetornoLote: description: Tipo de retorno do lote type: string enum: – RVS – RF – RAS – RP enumIdentificadorFiscal: description: Motivo de não preenchimento do NIF type: string enum: – Dispensado – PaisNaoExige – ComNIF enumModoPrestacao: description: Modo de prestação segundo a localização do prestador ou tomador type: string enum: – Transfronteirico – ConsumoExterior – MovimentoTemporarioPessoasFisicas enumSituacao: description: Indicativo da situação do RAS quanto a entrega ao governo type: string enum: – Pendente – EmProcessamento – Processado enumTipoVinculoEmpresa: description: Vinculação do adquirente residente ou domiciliado no Brasil ao vendedor do serviço residente ou domiciliado no exterior type: string enum: – SemVinculo – Filial – Sucursal – Controlada – Outros enumModulo: description: Módulos para geração dos arquivos type: string enum: – AQUISICAO – VENDA enumTipoArquivo: description: Tipos de arquivos a serem gerados type: string enum: – CANCELAR_PAGAMENTO – INCLUIR_ADITIVO_RAS – INCLUIR_RAS – INCLUSAO_PAGAMENTO – RETIFICAR_ADITIVO_RAS – RETIFICAR_PAGAMENTO – RETIFICAR_RAS – CANCELAR_FATURAMENTO – INCLUIR_ADITIVO_RVS – INCLUIR_FATURAMENTO – INCLUIR_RVS – RETIFICAR_ADITIVO_RVS – RETIFICAR_FATURAMENTO – RETIFICAR_RVS enumSituacaoArquivo: description: Situação referente ao download do arquivo type: string enum: – PROCESSANDO – DISPONIVEL – FALHA enumOpcaoIntegradoGoverno: description: Registros integrados com o governo? type: string enum: – SIM – NAO – AMBOS enumTipoDocumento: description: Tipo de Documento type: string enum: – RAS – RVS enumProcesso: description: Tipo de processo type: string enum: – INTEGRACAO_G5 upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recEmpresasFilial: description: Empresa/Filial para o Filtro type: object required: – empresa – filial properties: empresa: type: string description: Código da Empresa filial: type: array items: type: string minimum: 1 description: Código da Filial recUploadInfo: description: Informações de upload type: object required: – diretorio – nomeArquivo – versao – uri properties: diretorio: type: string description: Diretório nomeArquivo: type: string description: Nome do arquivo versao: type: string description: Versão uri: type: string description: URI recConsulta: description: Dados de retorno para consulta de RVS x RF type: object required: – idDocumento – numeroDocumento – participante – total – saldo – situacaoDocumento – situacaoTitulo – numeroDocumentoGoverno properties: idDocumento: type: integer format: int64 description: Identificação do Documento numeroDocumento: type: string description: Número Documento participante: type: string description: Participante total: type: string description: Valor total saldo: type: string description: Saldo situacaoDocumento: type: object allOf: – #/definitions/recStatusDocumento description: Situação Documento situacaoTitulo: type: object allOf: – #/definitions/recStatusTitulo description: Situação Titulo numeroDocumentoGoverno: type: string description: Número Documento do Siscoserv recStatusDocumento: description: Dados status RVS type: object required: – situacao – incluir – retificar – incluirAditivo – retificarAditivo properties: situacao: type: string allOf: – #/definitions/enumSituacao description: Situacao incluir: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Incluir retificar: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Retificar incluirAditivo: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Incluir aditivo retificarAditivo: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Retificar aditivo recStatusTitulo: description: Dados status RF type: object required: – situacao – incluir – retificar – cancelar properties: situacao: type: string allOf: – #/definitions/enumSituacao description: Situacao incluir: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Incluir retificar: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Retificar cancelar: type: array items: type: string allOf: – #/definitions/enumSituacao minimum: 1 description: Cancelar recEmpresaFilial: description: Par composto pela identificação da empresa, e identificação da filial type: object required: – idEmpresa – idFilial properties: idEmpresa: type: integer format: int64 description: Identificação da empresa idFilial: type: integer format: int64 description: Identificação da filial recPeriodoOpcional: description: Período opcional type: object properties: de: type: string format: date description: Data inicial ate: type: string format: date description: Data final recPeriodo: description: Período type: object required: – de – ate properties: de: type: string format: date description: Data inicial ate: type: string format: date description: Data final recEmpresa: description: Empresa type: object properties: id: type: integer format: int64 description: Identificação da empresa codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 10 description: Nome fantasia recPagina: description: Paginação type: object required: – offset – limit properties: offset: type: integer format: int64 description: A partir de qual registro limit: type: integer format: int64 description: Máximo de registros recPesquisaRAS: description: Pesquisa do Registro de Aquisição do Serviço (RAS) type: object required: – id – filial – numeroRASEmpresa – numeroRASGoverno – participante – situacao – integradoGoverno properties: id: type: integer format: int64 description: Identificação do RAS filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial numeroRASEmpresa: type: string maxLength: 100 description: Identificador unívoco do RAS numeroRASGoverno: type: string maxLength: 100 description: Identificador unívoco do RAS (Governo) participante: type: object allOf: – #/definitions/recParticipante description: Identificação do adquirente situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do RAS aditivo: type: boolean description: Indicativo se o RAS possui aditivos default: false retificacao: type: boolean description: Indicativo se o RAS é uma retificação default: false integradoGoverno: type: boolean description: Indicativo se o RAS já foi integrado com o governo recPesquisaRVS: description: Pesquisa do Registro de Venda de Serviço (RVS) type: object required: – id – filial – numeroRVSEmpresa – numeroRVSGoverno – participante – situacao – integradoGoverno properties: id: type: integer format: int64 description: Identificação do RVS filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial numeroRVSEmpresa: type: string maxLength: 100 description: Identificador unívoco do RVS numeroRVSGoverno: type: string maxLength: 100 description: Identificador unívoco do RVS (Governo) participante: type: object allOf: – #/definitions/recParticipante description: Identificação do adquirente situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do RVS aditivo: type: boolean description: Indicativo se o RVS possui aditivos default: false retificacao: type: boolean description: Indicativo se o RVS é uma retificação default: false integradoGoverno: type: boolean description: Indicativo se o RVS já foi integrado com o governo recFilial: description: Filial type: object properties: id: type: integer format: int64 description: Identificação da filial empresa: type: object allOf: – #/definitions/recEmpresa description: Identificação da empresa codigo: type: string maxLength: 6 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 30 description: Nome fantasia recNBS: description: Nomenclatura Brasileira de Serviços (NBS) type: object properties: id: type: integer format: int64 description: Identificação do NBS codigo: type: string maxLength: 9 description: Código descricao: type: string maxLength: 250 description: Descrição recPais: description: País type: object properties: id: type: integer format: int64 description: Identificação do país codigo: type: integer format: int64 description: Código nome: type: string maxLength: 50 description: Nome recMoeda: description: Moeda type: object properties: id: type: integer format: int64 description: Identificação da moeda codigo: type: integer format: int64 description: Código da moeda do BACEN nome: type: string maxLength: 50 description: Nome simbolo: type: string maxLength: 10 description: Símbolo pais: type: object allOf: – #/definitions/recPais description: País de origem recEnquadramentoServico: description: Mecanismo de fomento/apoio utilizado pela operação type: object properties: id: type: integer format: int64 description: Identificação do enquadramento do serviço codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 250 description: Descrição recParticipante: description: Participante type: object properties: id: type: integer format: int64 description: Identificação do participante codigo: type: string maxLength: 10 description: Código nome: type: string maxLength: 150 description: Nome endereco: type: string maxLength: 150 description: Endereço pais: type: object allOf: – #/definitions/recPais description: Código do país de residência ou domicílio do participante ativo: type: boolean description: Participante ativo default: true recTitulo: description: Itens que compõem o Titulo type: object required: – numeroTitulo – idDocumento – numeroDocumento – filial – dataTitulo – valorItens – valorItensExt – integradoGoverno – participante properties: id: type: integer format: int64 description: Identificação do titulo numeroTitulo: type: string maxLength: 60 description: Identificação do Titulo idDocumento: type: integer format: int64 description: Identificação do Documento identTituloGoverno: type: string maxLength: 10 description: Identificação única titulo numeroDocumento: type: string maxLength: 100 description: Identificação do Documento filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial dataTitulo: type: string format: date description: Data do titulo da operação valorItens: type: string description: Valor dos items no título valorItensExt: type: string description: Valor dos items mantidos no exterior no título integradoGoverno: type: boolean description: Indicativo se o Titulo já foi integrado com o governo participante: type: object allOf: – #/definitions/recParticipante description: Participante recArquivoLote: description: Arquivo Lote type: object required: – id – filial – diretorio – nomeArquivo – situacaoArquivo – periodo – modulo – tipoArquivo – observacoes properties: id: type: integer format: int64 description: Identificação do arquivo filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial diretorio: type: string description: Diretorio nomeArquivo: type: string description: Nome do arquivo situacaoArquivo: type: string allOf: – #/definitions/enumSituacaoArquivo description: Situação referente a geração do arquivo periodo: type: object allOf: – #/definitions/recPeriodo description: Período utilizado no filtro modulo: type: string allOf: – #/definitions/enumModulo description: Módulo tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo de arquivo observacoes: type: string maxLength: 5000 description: Observações dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração recOperacaoTitulo: description: Operações para Faturamento (RF) / Pagamentos (RP) type: object required: – nbs – paisDestino – modoPrestacao – dataInicio – dataConclusao – valor properties: id: type: integer format: int64 description: Identificação da operação numeroOperacaoEmpresa: type: string maxLength: 10 description: Identificador unívoco da operação dentro do Documento nbs: type: object allOf: – #/definitions/recNBS description: NBS paisDestino: type: object allOf: – #/definitions/recPais description: Código do país de destino da prestação do serviço, podendo ser diferente do país do vendedor modoPrestacao: type: string allOf: – #/definitions/enumModoPrestacao description: Modo de prestação segundo a localização do prestador ou tomador dataInicio: type: string format: date description: Data de início da prestação do serviço vendido dataConclusao: type: string format: date description: Data de conclusão da prestação do serviço vendido valor: type: string description: Valor da operação itemTitulo: type: array items: type: object allOf: – #/definitions/recItemTitulo description: Faturamentos/Pagamentos da Operação recDocumentoTitulos: description: Titulos (RF/RP) que compõem o Documento (RVS/RAS) type: object required: – filial – numeroDocumentoEmpresa – participante – motivoNaoPreenchimentoNIF – moeda properties: id: type: integer format: int64 description: Identificação do Documento filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial numeroDocumentoEmpresa: type: string maxLength: 100 description: Identificador unívoco do Documento participante: type: object allOf: – #/definitions/recParticipante description: Identificação do adquirente nif: type: string maxLength: 40 description: Número de identificação fiscal motivoNaoPreenchimentoNIF: type: string allOf: – #/definitions/enumIdentificadorFiscal description: Quando o NIF não é preenchido, qual o motivo do não preenchimento infoComplementar: type: string description: Info complementar moeda: type: object allOf: – #/definitions/recMoeda description: Código da moeda da transação comercial operacoes: type: array items: type: object allOf: – #/definitions/recOperacaoTitulo description: Operações do Documento recItemTitulo: description: Itens Pagamento (RP) / Faturamento (RF) type: object required: – idOperacao – valor – valorMantidoExt – numeroTitulo – dataTitulo – situacao properties: id: type: integer format: int64 description: Identificação do item de Título remover: type: boolean description: Indicativo que o registro deve ser excluído default: false idOperacao: type: integer format: int64 description: Identificação da operação valor: type: string description: Valor do titulo da operação valorMantidoExt: type: string description: Valor mantido no exterior identTituloEmpresa: type: string maxLength: 10 description: Identificação Pagamento/Faturamento identItemTituloEmpresa: type: string maxLength: 10 description: Identificação item Pagamento/Faturamento numeroTitulo: type: string maxLength: 60 description: Número do documento que comprove o Titulo dataTitulo: type: string format: date description: Data Pagamento/Faturamento integradoGoverno: type: boolean description: Indicativo se o Titulo já foi integrado com o Governo cancelado: type: boolean description: Pagamento/Faturamento cancelado? default: false retificado: type: boolean description: Pagamento/Faturamento retificado? default: false situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do Pagamento/Faturamento recRetorno: description: Retorno Lote type: object required: – sistema properties: governo: type: object allOf: – #/definitions/recRetornoGoverno description: Retorno do governo sistema: type: array items: type: string minimum: 1 description: Retorno do sistema recRetornoGoverno: description: Retorno Lote Governo type: object required: – status – nomeArquivoXML – dataGeracaoProtocolo properties: status: type: string description: Status nomeArquivoXML: type: string description: Nome arquivo XML dataGeracaoProtocolo: type: object allOf: – #/definitions/recDataProtocolo description: Data de geração do protocolo numeroRASRVSEmpresa: type: string description: Número Empresa numero: type: string description: Número Governo idFaturaPagamentoEmpresa: type: string description: Identificação Fatura/Pagamento Empresa numeroRFRP: type: string description: Número Registro de Faturamento/Pagamento retornoOperacao: type: array items: type: object allOf: – #/definitions/recRetornoOperacao description: Retorno das Operações retornoItemFaturaPagamento: type: array items: type: object allOf: – #/definitions/recRetornoItemFaturaPagamento description: Retorno dos itens de Faturamento/Pagamento erroLote: type: array items: type: object allOf: – #/definitions/recErroLote description: Erros lote recDataProtocolo: description: Data protocolo type: object properties: year: type: integer format: int64 description: Ano month: type: integer format: int64 description: Mês day: type: integer format: int64 description: Dia timezone: type: integer format: int64 description: Fuso horário hour: type: integer format: int64 description: Hora minute: type: integer format: int64 description: Minuto second: type: integer format: int64 description: Segundo recRetornoOperacao: description: Retorno Operacao type: object required: – numeroOperacaoEmpresa properties: numeroOperacaoEmpresa: type: string description: Número operação empresa recRetornoItemFaturaPagamento: description: Retorno Item Faturamento (RF) / Pagamento (RP) type: object required: – idItemEmpresa – numeroOperacaoEmpresa properties: idItemEmpresa: type: string description: Identificação item faturamento/pagamento empresa numeroOperacaoEmpresa: type: string description: Número operacao empresa recErroLote: description: Erro lote type: object required: – codigoErro – descricaoErro – detalhamentoErro properties: codigoErro: type: string description: Código do erro descricaoErro: type: string description: Descrição do erro detalhamentoErro: type: object allOf: – #/definitions/recItemErro description: Detalhamento erro recItemErro: description: Item erro lote type: object required: – itemErro properties: itemErro: type: array items: type: string minimum: 1 description: Item erro recFiltroConsulta: description: Dados para filtro na consulta de RVS x RF / RAS X RP type: object required: – idFilial properties: idFilial: type: integer format: int64 description: Identificação da filial somenteSaldoMaiorZero: type: boolean description: Exibir somente RVS com saldo a faturar situacaoDocumento: type: string allOf: – #/definitions/enumSituacao description: Status RAS/RVS situacaoTitulo: type: string allOf: – #/definitions/enumSituacao description: Status RP/RF idsParticipante: type: array items: type: integer format: int64 description: Identificação dos participantes numeroDocumento: type: string description: Número RAS/RVS periodoInicioServico: type: object allOf: – #/definitions/recPeriodoOpcional description: Período de início do serviço periodoConclusaoServico: type: object allOf: – #/definitions/recPeriodoOpcional description: Período de conclusão do serviço periodoTitulo: type: object allOf: – #/definitions/recPeriodoOpcional description: Período do faturamento recDetalheTituloConsulta: description: Detalhamento Consulta RAS/RVS x RP/RF type: object required: – idTitulo – numeroTitulo – dataTitulo – situacao – valor – valorExt properties: idTitulo: type: integer format: int64 description: Identificador do RP/RF numeroTitulo: type: string description: Número do RP/RF dataTitulo: type: string format: date description: Data de pagamento/faturamento situacao: type: string allOf: – #/definitions/enumSituacao description: Situação valor: type: string description: Valor pago/faturado valorExt: type: string description: Valor mantido no exterior checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck entRAS: description: Entidade do Registro de Aquisição do Serviço (RAS) type: object required: – filial – numeroRASEmpresa – participante – motivoNaoPreenchimentoNIF – moeda properties: id: type: integer format: int64 description: Identificação do RAS filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial numeroRASEmpresa: type: string maxLength: 100 description: Identificador unívoco do RAS numeroRASGoverno: type: string maxLength: 100 description: Identificador unívoco do RAS (Governo) participante: type: object allOf: – #/definitions/recParticipante description: Identificação do adquirente nif: type: string maxLength: 40 description: Número de identificação fiscal motivoNaoPreenchimentoNIF: type: string allOf: – #/definitions/enumIdentificadorFiscal description: Quando o NIF não é preenchido, qual o motivo do não preenchimento infoComplementar: type: string description: Info complementar moeda: type: object allOf: – #/definitions/recMoeda description: Código da moeda da transação comercial situacao: type: string allOf: – #/definitions/enumSituacao description: Indicativo da situação do RAS quanto a entrega ao governo aditivo: type: boolean description: Indicativo se o RAS possui aditivos default: false retificacao: type: boolean description: Indicativo se o RAS é uma retificação default: false integradoGoverno: type: boolean description: Indicativo se o RAS já foi integrado com o governo default: false operacoes: type: array items: type: object allOf: – #/definitions/entOperacao description: Operações do RAS dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entRVS: description: Entidade do Registro de Venda de Serviço (RVS) type: object required: – filial – numeroRVSEmpresa – participante – motivoNaoPreenchimentoNIF – moeda properties: id: type: integer format: int64 description: Identificação do RVS filial: type: object allOf: – #/definitions/recFilial description: Identificação da Filial numeroRVSEmpresa: type: string maxLength: 100 description: Identificador unívoco do RVS numeroRVSGoverno: type: string maxLength: 100 description: Identificador unívoco do RVS (Governo) participante: type: object allOf: – #/definitions/recParticipante description: Identificação do adquirente nif: type: string maxLength: 40 description: Número de identificação fiscal motivoNaoPreenchimentoNIF: type: string allOf: – #/definitions/enumIdentificadorFiscal description: Quando o NIF não é preenchido, qual o motivo do não preenchimento infoComplementar: type: string description: Info complementar moeda: type: object allOf: – #/definitions/recMoeda description: Código da moeda da transação comercial situacao: type: string allOf: – #/definitions/enumSituacao description: Indicativo da situação do RVS quanto a entrega ao governo aditivo: type: boolean description: Indicativo se o RVS possui aditivos default: false retificacao: type: boolean description: Indicativo se o RVS é uma retificação default: false integradoGoverno: type: boolean description: Indicativo se o RVS já foi integrado com o governo default: false operacoes: type: array items: type: object allOf: – #/definitions/entOperacao description: Operações do RVS dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entOperacao: description: Operações que compõem o Documento (RVS/RAS) type: object required: – nbs – paisDestino – modoPrestacao – dataInicio – dataConclusao – valor properties: id: type: integer format: int64 description: Identificação da operação idDocumento: type: integer format: int64 description: Identificação do Documento remover: type: boolean description: Indicativo que o registro deve ser excluído default: false comGastoPessoal: type: boolean description: Com gasto pessoal a serviço do empregador comMecanismoDeApoio: type: boolean description: Com mecanismo de formento ou apoio ao comérico internacional de serviços comVinculoMovTemporario: type: boolean description: Com registro de movimentação temporária de bens numeroOperacaoEmpresa: type: string maxLength: 10 description: Identificador unívoco da operação dentro do Documento nbs: type: object allOf: – #/definitions/recNBS description: Nomenclatura Brasileira de Serviços (NBS) paisDestino: type: object allOf: – #/definitions/recPais description: Código do país de destino da prestação do serviço, podendo ser diferente do país do vendedor modoPrestacao: type: string allOf: – #/definitions/enumModoPrestacao description: Modo de prestação segundo a localização do prestador ou tomador dataInicio: type: string format: date description: Data de início da prestação do serviço vendido dataConclusao: type: string format: date description: Data de conclusão da prestação do serviço vendido valor: type: string description: Valor da operação cnpjGastoPessoal: type: string maxLength: 16 description: CNPJ da empresa brasileira em nome da qual os gastos pessoais, representados pela operação, foram incorridos aditivo: type: boolean description: Indicativo se a operação é um aditivo retificacao: type: boolean description: Indicativo se a operação é uma retificação enquadramentos: type: array items: type: object allOf: – #/definitions/entEnquadramento description: Enquadramentos da operação vinculacoesRE: type: array items: type: object allOf: – #/definitions/entVinculacaoNumRE description: Vinculações de registros de exportação vinculacoesDI: type: array items: type: object allOf: – #/definitions/entVinculacaoNumDI description: Vinculaçoes de declarações de importação integradoGoverno: type: boolean description: Indicativo se o Documento já foi integrado com o governo situacao: type: string allOf: – #/definitions/enumSituacao description: Indicativo da situação do RAS quanto a entrega ao governo dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entEnquadramento: description: Mecanismo de fomento ou apoio ao comércio internacional de serviço vinculado a operação type: object required: – enquadramentoServico properties: id: type: integer format: int64 description: Identificação do enquadramento idOperacao: type: integer format: int64 description: Identificação da operação enquadramentoServico: type: object allOf: – #/definitions/recEnquadramentoServico description: Identificação do enquadramento do serviço remover: type: boolean description: Indicativo que o registro deve ser excluído default: false numeroRCs: type: array items: type: object allOf: – #/definitions/entNumeroRCEnquadramento description: Números de registro de crédito do mecanismo de fomento/apoio dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entNumeroRCEnquadramento: description: Número de registro de crédito do mecanismo de fomento/apoio type: object properties: id: type: integer format: int64 description: Identificação do número de rc do enquadramento idEnquadramento: type: integer format: int64 description: Identificação do enquadramento remover: type: boolean description: Indicativo que o registro deve ser excluído default: false numeroRC: type: string maxLength: 10 description: Número de registro de crédito do mecanismo de fomento/apoio dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entVinculacaoNumRE: description: Registro de Exportação (RE) de movimentação temporária de bens vinculada à operação type: object required: – numeroRE properties: id: type: integer format: int64 description: Identificação do rgistro de exportação idOperacao: type: integer format: int64 description: Identificação da operação remover: type: boolean description: Indicativo que o registro deve ser excluído default: false numeroRE: type: string maxLength: 13 description: Número do registro de exportação dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração entVinculacaoNumDI: description: Declaração de Importação (DI) de movimentação temporária de bens vinculada à operação type: object required: – numeroDI properties: id: type: integer format: int64 description: Identificação da declaração de importação idOperacao: type: integer format: int64 description: Identificação da operação remover: type: boolean description: Indicativo que o registro deve ser excluído default: false numeroDI: type: string maxLength: 13 description: Número da declaração de importação dataGeracao: type: string format: date-time description: Data geração usuarioGeracao: type: string maxLength: 50 description: Usuário geração dataAlteracao: type: string format: date-time description: Data alteração usuarioAlteracao: type: string maxLength: 50 description: Usuário alteração notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment