2.0info: 3.69.0 integration_cpl_guias description: Serviço para integração de títulos (pagar/receber) com o serviço de guias de recolhimento x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: integration_cpl_guias contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integration_cpl_guias/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_cpl_guias/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: 401: description: Invalid Credentials 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_cpl_guias/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials 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: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_cpl_guias/actions/validarExclusaoTituloGuia: post: description: Validar exclusão de título via processo de guia tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – guiaId properties: guiaId: type: string description: Identificador da guia responses: 200: description: Ok schema: type: object required: – exclusaoPermitida properties: exclusaoPermitida: type: boolean description: Identificador de permissão de exclusão motivo: type: string description: Mensagem indicando o motivo da não permissão de exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_cpl_guias/signals/gerarTitulo: post: description: Gera título a partir de agrupamentos de guias de recolhimento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – guias properties: guias: type: array items: type: object allOf: – #/definitions/recInformacaoGuiaGerada minimum: 1 description: Informações das guias de recolhimento gerada loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro Reprocessamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration_cpl_guias/events/titulosGuiaRecolhimentoErro: post: description: Evento de exclusão de títulos via nota fiscal processado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documentoId – fatoContabilId – descricaoFatoContabil – controlProcess – documentoGerouParcelaFinanceira – erro properties: documentoId: type: string description: id documento fatoContabilId: type: string description: id fato contabil descricaoFatoContabil: type: string description: descrição do fato contábil controlProcess: type: string description: id do controle documentoGerouParcelaFinanceira: type: boolean description: documento gerou parcela financeira erro: type: string description: mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumOrigemGuia: description: type: string enum: – NF_SAIDA – NF_ENTRADA – FINANCEIRO_CP – MANUAL enumRegimeControleRetencao: description: type: string enum: – COMPETENCIA – CAIXA enumImpostosGuia: description: type: string enum: – CSRF – DIFAL – FCP – FCP_ST – ICMS_ST – INSS – IRRF – ISS – FUNRURAL_TOTAL 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 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 recInformacaoGuiaGerada: description: type: object required: – origem – documento – documentoDescricao – guias properties: origem: type: string allOf: – #/definitions/enumOrigemGuia description: Origem documento: type: string description: Id Documento documentoDescricao: type: string description: Descrição Documento informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionais description: Informações complementares a geração da origem para geração da guia guias: type: array items: type: object allOf: – #/definitions/recGuiaRecolhimentoGerada minimum: 1 description: Informações das guia geradas recInformacoesAdicionais: description: type: object required: – empresa properties: empresa: type: string description: Identificador empresa gerouParcelaFinanceira: type: boolean description: Quando o documento é origem NF_ENTRADA/SAÍDA, deve ser indicado se o documento gerou parcelas financeira para podermos incluirmos no mesmo lote financeiro fatoContabil: type: object allOf: – #/definitions/recFatoContabil description: Fato contábil controlProcess: type: string description: Identificador de controle de processo recGuiaRecolhimentoGerada: description: type: object required: – filial – dataEmissao – vencimento – orgaoRecolhimento – tipoTitulo – transacao – guia – documento – valor – multa – juros – imposto properties: filial: type: string description: Id da Filial dataEmissao: type: string format: date description: Data de emissão vencimento: type: string format: date description: Data de vencimento orgaoRecolhimento: type: string description: Id do Orgão de Recolhimento tipoTitulo: type: string description: Id do tipo de título transacao: type: string description: Id da transação guia: type: string description: Id da guia documento: type: string description: Id do documento valor: type: string description: Valor multa: type: string description: Multa da guia juros: type: string description: Juros da guia imposto: type: string allOf: – #/definitions/enumImpostosGuia description: Tipo de imposto regimeControleRetencao: type: string allOf: – #/definitions/enumRegimeControleRetencao description: Regime controle retencao codigoDeBarras: type: string description: Código de barras parametroGuiaId: type: string description: Identificador do parâmetro utilizado na geração da guia gerarGNRE: type: boolean description: Informativo de a guia deve gerar GNRE default: false codigoProdutoGNRE: type: integer format: int64 description: Código de produto GNRE guiaId: type: string description: Id da guia recFatoContabil: description: type: object properties: fatoContabilId: type: string description: Identificador descricaoFatoContabil: type: string description: Descriçã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