ERP senior X Finanças (erpx_fin)

contas_pagar_integration

14 views 27/02/2020 17/03/2021 integrador 0

2.0info: 1.4.0 contas_pagar_integration description: Serviço para integração com o contas a pagar x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: contas_pagar_integration 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/erpx_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /contas_pagar_integration/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 /contas_pagar_integration/queries/obterTituloPagar: post: description: Retorna a posição atual do título a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do título responses: 200: description: Ok schema: type: object required: – tituloPagar properties: tituloPagar: type: object allOf: – #/definitions/recTituloPagar description: Estrutura do título a pagar default: description: Error response schema: #/definitions/genericError get: description: Retorna a posição atual do título a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do título in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tituloPagar properties: tituloPagar: type: object allOf: – #/definitions/recTituloPagar description: Estrutura do título a pagar default: description: Error response schema: #/definitions/genericError /contas_pagar_integration/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 /contas_pagar_integration/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: 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 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 recTituloPagar: description: Informações do título a pagar type: object required: – id – empresa – filial – pessoa – numeroTitulo – tipoTitulo – transacao – dataEmissao – dataEntrada – vencimentoOriginal – provavelPagamento – situacaoTitulo – valorOriginal – moeda – cotacaoEmissao – portador – carteira properties: id: type: string description: Identificador do título loteFinanceiro: type: string description: Identificador do lote financeiro processoOrigem: type: string description: Processo origem empresa: type: string description: Identificador da empresa filial: type: string description: Identificador da filial pessoa: type: string description: Identificador do fornecedor/cliente numeroTitulo: type: string maxLength: 15 description: Nº Título tipoTitulo: type: string description: Identificador do tipo de título transacao: type: string description: Identificador da transação de entrada do título dataEmissao: type: string format: date description: Data Emissão dataEntrada: type: string format: date description: Data Entrada vencimentoOriginal: type: string format: date description: Vencimento Original vencimentoProrrogado: type: string format: date description: Vencimento Prorrogado/Juros provavelPagamento: type: string format: date description: Data Provável Pagamento situacaoTitulo: type: string description: Situação do título valorOriginal: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 valorAberto: type: string description: Valor aberto minimum: 0.00 maximum: 9999999999999.99 moeda: type: string description: Identificador da moeda cotacaoEmissao: type: string description: Cotação de emissão de um título projeto: type: string description: Identificador do projeto faseProjeto: type: string description: Identificador da fase do projeto contaContabil: type: string description: Identificador da conta contábil contaFinanceira: type: string description: Identificador da conta financeira centroCustos: type: string description: Identificador do centro de custos valorJurosDia: type: string description: Valor Juros Dia minimum: 0.00 maximum: 9999999.99 percentualJuros: type: number format: double description: Percentual/Tipo Juros minimum: 0.00 maximum: 999.99 tipoJuros: type: string description: Tipo de Juros toleranciaJuros: type: integer format: int64 description: Dias Tolerância Juros minimum: 0 maximum: 9999 prorrogaJuros: type: boolean description: Prorrogação c/ Juros percentualMulta: type: number format: double description: Percentual/Tolerância Multa minimum: 0.00 maximum: 999.99 toleranciaMulta: type: integer format: int64 description: Dias Tolerância Multa minimum: 0 maximum: 9999 antecipacaoDesconto: type: boolean description: Calcula Desc. Antecipação dataLimiteDesconto: type: string format: date description: Data/Tolerância Desconto toleranciaDesconto: type: integer format: int64 description: Tolerância Desconto minimum: -9999 maximum: 9999 percentualDesconto: type: number format: double description: Percentual/Valor Desconto minimum: 0.00 maximum: 999.99 valorDesconto: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 dataLimiteNegociacao: type: string format: date description: Data Valores Negociados juroNegociado: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 multaNegociada: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 descontoNegociado: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 outrosValoresNegociados: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 cotacaoNegociada: type: string description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 bancoId: type: string description: Banco/Agência/Nº Conta Fornecedor agencia: type: string description: Agência Fornecedor contaCorrente: type: string maxLength: 14 description: Nº CC no Banco digitoVerificador: type: string maxLength: 2 description: Dígito da Conta Corrente tipoConta: type: string description: Tipo de Conta favorecido: type: string description: Favorecido do título observacao: type: string maxLength: 250 description: Observação naturezaGasto: type: string description: Natureza Gasto grupoContas: type: string description: Grupo Contas formaPagamento: type: string description: Forma Pagamento portador: type: string description: Portador carteira: type: string description: Carteira codigoBarras: type: string maxLength: 50 description: Código Barra ultimoPagamento: type: string format: date description: Data do último pagamento ultimoCalculoJuros: type: string format: date description: Data do último cálculo de juros usuarioGerador: type: string description: Usuário que realizou a geração do título tipoEfetivacao: type: string description: Indicativo da previsão transacaoPrevista: type: string description: Transação prevista anterior dataPrevista: type: string format: date description: Data da previsão anterior valorPrevisaoAnterior: type: string description: Valor original do título antes da efetivação credito: type: boolean description: Indicativo se o título é de adiantamento/crédito dataGeracao: type: string format: date-time description: Data da geração do título usuarioAlteracao: type: string description: Usuário que realizou a alteração do título dataAlteracao: type: string format: date-time description: Data da alteração do título movimentoTitulo: type: object allOf: – #/definitions/recMovimentoTituloPagar description: Movimento do título recMovimentoTituloPagar: description: Movimento de entrada do título type: object required: – id – transacaoMovimento – dataMovimento – dataPagamento – moeda – cotacaoMovimento – valorMovimento – valorLiquido – portador – carteira – usuarioGerador – dataGeracao properties: id: type: string description: Identificador do movimento transacaoMovimento: type: string description: Transação do movimento dataMovimento: type: string format: date description: Data do movimento dataPagamento: type: string format: date description: Data de pagamento do movimento moeda: type: string description: Moeda cotacaoMovimento: type: string description: Cotação valorMovimento: type: string description: Valor Movimento valorJuros: type: string description: Valor Juros valorMulta: type: string description: Valor Multa valorDesconto: type: string description: Valor Desconto valorCorrecao: type: string description: Valor Correção Monetária valorEncargos: type: string description: Valor Encargos/Correção valorOutrosAcrescimos: type: string description: Valor Outros Acréscimos valorOutrosDescontos: type: string description: Valor Outros Descontos valorLiquido: type: string description: Valor Líquido diasAtraso: type: integer format: int64 description: Quantidade de dias de atraso diasJuros: type: integer format: int64 description: Quantidade de dias de juros observacao: type: string description: Observação do movimento toleranciaDesconto: type: integer format: int64 description: Quantidade de tolerancia de descontos toleranciaJuros: type: integer format: int64 description: Quantidade de tolerancia de juros toleranciaMulta: type: integer format: int64 description: Quantidade de tolerancia de multa numeroDocumento: type: string description: Número de documento formaPagamento: type: string description: Forma Pagamento portador: type: string description: Portador carteira: type: string description: Carteira loteContabil: type: integer format: int64 description: Número do lote contábil projeto: type: string description: Identificador do projeto faseProjeto: type: string description: Identificador da fase do projeto contaContabil: type: string description: Identificador da conta contábil contaFinanceira: type: string description: Identificador da conta financeira centroCustos: type: string description: Identificador do centro de custos usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data da geração do movimento 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