erp_scv

com_comum

15 views 04/08/2020 18/03/2021 integrador 0

2.0info: 3.4.2 com_comum description: \n Siscoserv – Comum\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: com_comum 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: /com_comum/queries/pesquisarParticipante: post: description: \n Pesquisar participante (Fornecedor/Cliente).\n Retorna todos os participantes de forma paginada.\n \n ### Resources:\n – res://senior.com.br/erp_scv/com_comum/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: codigo: type: string maxLength: 10 description: Código nome: type: string maxLength: 150 description: Nome numeroIdentificacaoFiscal: type: string maxLength: 40 description: Número de identificação fiscal bloqueado: type: boolean description: Bloqueado pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação responses: 200: description: Ok schema: type: object required: – participantes – totalRegistros properties: participantes: type: array items: type: object allOf: – #/definitions/entParticipante minimum: 1 description: Retorna lista de participantes totalRegistros: type: integer format: int64 description: Total de registros para paginação default: description: Error response schema: #/definitions/genericError /com_comum/queries/obterFiliais: post: description: \n Retorna a listagem de filiais cadastradas.\n Retorna todas as filiais de forma paginada.\n \n ### Resources:\n – res://senior.com.br/erp_scv/com_comum/siscoserv\n – Action: Visualizar\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: idEmpresas: type: array items: type: integer format: int64 description: Filtrar filiais por empresas pagina: type: object allOf: – #/definitions/recPagina description: Número da paginação responses: 200: description: Ok schema: type: object required: – listaFiliais – totalRegistros properties: listaFiliais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Estrutura das empresas encontradas totalRegistros: type: integer format: int64 description: Total de filiais encontradas default: description: Error response schema: #/definitions/genericError /com_comum/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 /com_comum/queries/listarNBS: post: description: Query para listar NBS conforme a data da operação – Padrão versão 2.0 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dataInicio: type: string format: date description: Filtrar filiais por empresas responses: 200: description: Ok schema: type: object required: – listaNBS properties: listaNBS: type: array items: type: object allOf: – #/definitions/entNBS minimum: 1 description: Lista de NBS default: description: Error response schema: #/definitions/genericError get: description: Query para listar NBS conforme a data da operação – Padrão versão 2.0 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicio description: Filtrar filiais por empresas in: query type: string format: date responses: 200: description: Ok schema: type: object required: – listaNBS properties: listaNBS: type: array items: type: object allOf: – #/definitions/entNBS minimum: 1 description: Lista de NBS default: description: Error response schema: #/definitions/genericError /com_comum/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 /com_comum/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 /com_comum/entities/entEmpresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEmpresa responses: 200: description: The created resource schema: #/definitions/entEmpresa 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/entEmpresa responses: 200: description: The created resource schema: #/definitions/entEmpresa 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/entEmpresa default: description: Error response schema: #/definitions/genericError /com_comum/entities/entEmpresa/{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/entEmpresa responses: 200: description: Ok schema: #/definitions/entEmpresa 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/entEmpresa responses: 200: description: Ok schema: #/definitions/entEmpresa 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/entEmpresa 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 /com_comum/entities/entEmpresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entEmpresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entFilial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entFilial responses: 200: description: The created resource schema: #/definitions/entFilial 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/entFilial responses: 200: description: The created resource schema: #/definitions/entFilial 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/entFilial default: description: Error response schema: #/definitions/genericError /com_comum/entities/entFilial/{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/entFilial responses: 200: description: Ok schema: #/definitions/entFilial 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/entFilial responses: 200: description: Ok schema: #/definitions/entFilial 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/entFilial 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 /com_comum/entities/entFilial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entFilial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entParticipante: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParticipante responses: 200: description: The created resource schema: #/definitions/entParticipante 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/entParticipante responses: 200: description: The created resource schema: #/definitions/entParticipante 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/entParticipante default: description: Error response schema: #/definitions/genericError /com_comum/entities/entParticipante/{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/entParticipante responses: 200: description: Ok schema: #/definitions/entParticipante 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/entParticipante responses: 200: description: Ok schema: #/definitions/entParticipante 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/entParticipante 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 /com_comum/entities/entParticipante/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entParticipante responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entNBS: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entNBS responses: 200: description: The created resource schema: #/definitions/entNBS 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/entNBS responses: 200: description: The created resource schema: #/definitions/entNBS 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/entNBS default: description: Error response schema: #/definitions/genericError /com_comum/entities/entNBS/{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/entNBS responses: 200: description: Ok schema: #/definitions/entNBS 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/entNBS responses: 200: description: Ok schema: #/definitions/entNBS 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/entNBS 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 /com_comum/entities/entNBS/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entNBS responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entPais: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entPais responses: 200: description: The created resource schema: #/definitions/entPais 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/entPais responses: 200: description: The created resource schema: #/definitions/entPais 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/entPais default: description: Error response schema: #/definitions/genericError /com_comum/entities/entPais/{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/entPais responses: 200: description: Ok schema: #/definitions/entPais 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/entPais responses: 200: description: Ok schema: #/definitions/entPais 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/entPais 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 /com_comum/entities/entPais/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entPais responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entMoeda: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entMoeda responses: 200: description: The created resource schema: #/definitions/entMoeda 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/entMoeda responses: 200: description: The created resource schema: #/definitions/entMoeda 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/entMoeda default: description: Error response schema: #/definitions/genericError /com_comum/entities/entMoeda/{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/entMoeda responses: 200: description: Ok schema: #/definitions/entMoeda 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/entMoeda responses: 200: description: Ok schema: #/definitions/entMoeda 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/entMoeda 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 /com_comum/entities/entMoeda/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entMoeda responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /com_comum/entities/entEnquadramentoServico: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEnquadramentoServico responses: 200: description: The created resource schema: #/definitions/entEnquadramentoServico 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/entEnquadramentoServico responses: 200: description: The created resource schema: #/definitions/entEnquadramentoServico 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/entEnquadramentoServico default: description: Error response schema: #/definitions/genericError /com_comum/entities/entEnquadramentoServico/{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/entEnquadramentoServico responses: 200: description: Ok schema: #/definitions/entEnquadramentoServico 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/entEnquadramentoServico responses: 200: description: Ok schema: #/definitions/entEnquadramentoServico 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/entEnquadramentoServico 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 /com_comum/entities/entEnquadramentoServico/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entEnquadramentoServico responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumIdentificadorFiscal: description: Motivo de não preenchimento do Número de Identificação Fiscal (NIF) type: string enum: – Dispensado – PaisNaoExige – ComNIF – NaoDefinido 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 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 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 recEmpresa: description: Empresa type: object required: – codigo – nome 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 recFilial: description: Filial type: object required: – empresa – codigo – nome 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 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 entEmpresa: description: Entidade empresa type: object required: – codigo – nome 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 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 entFilial: description: Entidade filial type: object required: – idEmpresa – codigo – nome properties: id: type: integer format: int64 description: Identificação da filial idEmpresa: type: integer format: int64 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 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 entParticipante: description: Entidade participante type: object required: – codigo – nome – endereco – idPais – identificadorFiscal – tipoVinculoEmpresa properties: id: type: integer format: int64 description: Identificação do participante codigo: type: string maxLength: 15 description: Código nome: type: string maxLength: 150 description: Nome endereco: type: string maxLength: 150 description: Endereço idPais: type: integer format: int64 description: Código do país de residência ou domicílio do participante identificadorFiscal: type: string allOf: – #/definitions/enumIdentificadorFiscal description: Motivo de não preenchimento do NIF numeroIdentificacaoFiscal: type: string maxLength: 40 description: Número de identificação fiscal tipoVinculoEmpresa: type: string allOf: – #/definitions/enumTipoVinculoEmpresa description: Vinculação do participante residente ou domiciliado no Brasil ao vendedor/tomador do serviço residente ou domiciliado no exterior ativo: type: boolean description: Participante ativo default: true bloqueado: type: boolean description: Participante bloqueado default: false 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 entNBS: description: Entidade Nomenclatura Brasileira de Serviços (NBS) type: object required: – codigo – descricao 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 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 entPais: description: Entidade país type: object required: – codigo – nome 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 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 entMoeda: description: Entidade moeda type: object required: – codigo – nome – simbolo – idPais 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 idPais: type: integer format: int64 description: País de origem 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 entEnquadramentoServico: description: Entidade mecanismo de fomento/apoio utilizado pela operação type: object required: – codigo – descricao – indicadorRC – moduloVenda – moduloAquisicao – moduloRPC 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 indicadorRC: type: boolean description: Indicativo de Registro de Crédito (RC) moduloVenda: type: boolean description: Módulo venda moduloAquisicao: type: boolean description: Módulo aquisição moduloRPC: type: boolean description: Módulo Registro de Presença Comercial (RPC) 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