erp_scv

ig5_siscoserv

30 views 22/10/2018 integrador 0

2.0info: 0.1.1 ig5_siscoserv description: Serviço de comunicação com o ERP (Siscoserv) x-senior-domain: erp_scv x-senior-domain-path: erp_scv x-senior-service-path: ig5_siscoserv 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: /ig5_siscoserv/queries/obterSiscoserv: post: description: Obter informações do Siscoserv no ERP tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros properties: parametros: type: object allOf: – #/definitions/recParametros description: Parâmetros de entrada para os filtros responses: 200: description: Ok schema: type: object required: – execucao properties: execucao: type: object allOf: – #/definitions/recRetornoSiscoserv description: Retorno Registros de RVS default: description: Error response schema: #/definitions/genericError get: description: Obter informações do Siscoserv no ERP tags: – Queries x-senior-visibility: PRIVATE parameters: – name: parametros in: query required: true type: object allOf: – #/definitions/recParametros responses: 200: description: Ok schema: type: object required: – execucao properties: execucao: type: object allOf: – #/definitions/recRetornoSiscoserv description: Retorno Registros de RVS default: description: Error response schema: #/definitions/genericError /ig5_siscoserv/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 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 /ig5_siscoserv/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 definitions: enumIdentificadorFiscal: description: Motivo de não preenchimento do NIF type: string enum: – Nenhum – Dispensado – PaisNaoExige – ComNIF enumModoPrestacao: description: Modo de prestação segundo a localização do prestador ou tomador type: string enum: – Nenhum – Transfronteirico – ConsumoExterior – MovimentoTemporarioPessoasFisicas enumTipoDocumento: description: Tipo de Documento type: string enum: – RAS – RVS 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 recParametros: description: Lista de parâmetros type: object required: – empresaFilial – dataInicial – dataFinal – tipoDocumento properties: empresaFilial: type: array items: type: object allOf: – #/definitions/recEmpresasFilial minimum: 1 description: Abrangência 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 RVS RF 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 recRetornoSiscoserv: description: Retorno de mensagens do ERP type: object required: – cadastroEmpresa – cadastroParticipante – documento – nbs – moeda – pais – log properties: cadastroEmpresa: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Registros de Empresas cadastroParticipante: type: array items: type: object allOf: – #/definitions/recParticipante minimum: 1 description: Registros de Particietes documento: type: array items: type: object allOf: – #/definitions/recDocumento minimum: 1 description: Registros de Documentos nbs: type: array items: type: object allOf: – #/definitions/recNBS minimum: 1 description: Lista de NBS moeda: type: array items: type: object allOf: – #/definitions/recMoeda minimum: 1 description: Lista de Moeda pais: type: array items: type: object allOf: – #/definitions/recPais minimum: 1 description: Lista Pais log: type: array items: type: string minimum: 1 description: Lista de Logs recFilialEmpresa: description: Empresa e Filial do Documento type: object required: – codigoFilial – codigoEmpresa properties: codigoFilial: type: string description: Código da Filial codigoEmpresa: type: string description: Código da Empresa recNBS: description: Serviços type: object required: – codigo – descricao properties: codigo: type: string maxLength: 9 description: Código descricao: type: string maxLength: 250 description: Descrição recPais: description: País type: object required: – paiSIS – nome properties: paiSIS: type: integer format: int64 description: País de origem nome: type: string maxLength: 50 description: Nome recMoeda: description: Moeda type: object required: – codigoBacen – nome – simbolo – paiSIS properties: codigoBacen: 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 paiSIS: type: integer format: int64 description: País de origem recParticipante: description: Participante type: object required: – codigo – nome – motivoNaoPreenchimentoNIF – endereco – paisSIS – tipoVinculo properties: codigo: type: string maxLength: 10 description: Código nome: type: string maxLength: 150 description: Nome 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 endereco: type: string maxLength: 150 description: Endereço paisSIS: type: integer format: int64 description: Código do país de residência ou domicílio do participante tipoVinculo: type: integer format: int64 description: Indicativo do tipo de vinculo do participante com a empresa nos termos do art. 23 da Lei 9.430, de 27 de dexembro de 1996 recFilial: description: Registro da Filial type: object properties: codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 30 description: Nome fantasia recEmpresa: description: Registro da Empesa type: object required: – filial properties: codigo: type: string maxLength: 4 description: Código nome: type: string maxLength: 100 description: Nome fantasia: type: string maxLength: 10 description: Nome fantasia filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Lista de Filiais recDocumento: description: Entidade do Registro de Aquisição do Serviço type: object required: – codigoFilial – numeroDocumentoEmpresa – codigoParticipante – motivoNaoPreenchimentoNIF – codigoBacen – operacoes – tipoDocumento properties: codigoFilial: type: object allOf: – #/definitions/recFilialEmpresa description: Identificação da Filial numeroDocumentoEmpresa: type: string maxLength: 100 description: Identificador unívoco do Documento codigoParticipante: type: string description: Identificação do participante 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 codigoBacen: type: integer format: int64 description: Código da moeda da transação comercial operacoes: type: array items: type: object allOf: – #/definitions/recOperacao minimum: 1 description: Operações do Documento tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo Documento recOperacao: description: Operações para Faturamento/Pagamentos type: object required: – numeroOperacaoEmpresa – codigoNBS – paisSIS – modoPrestacao – dataInicio – dataConclusao – valor – titulo properties: numeroOperacaoEmpresa: type: string maxLength: 10 description: Identificador unívoco da operação dentro do Documento codigoNBS: type: string description: NBS paisSIS: type: integer format: int64 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 titulo: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Registro do título recTitulo: description: Itens que compõem o Titulo type: object required: – numeroTitulo – dataTitulo – valorItens – valorItensExt properties: numeroTitulo: type: string maxLength: 60 description: Identificação do Titulo 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 notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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