erp_fin

ig5_contasreceber

61 views 22/10/2018 07/11/2018 integrador 0

2.0info: 0.1.1 ig5_contasreceber description: Serviço destinado a integração do contas a receber G7 X G5 x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: ig5_contasreceber 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ig5_contasreceber/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_contasreceber/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 /ig5_contasreceber/actions/alterarTituloReceber: post: description: Alterar o título a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tituloReceber properties: tituloReceber: type: object allOf: – #/definitions/recTituloReceber description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ig5_contasreceber/actions/baixarTituloReceber: post: description: Efetuar baixa de um título a receber (recebimento, abatimento, cancelamento). Caso não seja informado a transação de baixa, será realizado por padrão uma baixa por recebimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – filial – tipoTituloId – numeroTitulo – clienteId – dataBaixa – valorBaixa – valorLiquido properties: empresaId: type: integer format: int64 description: filial: type: integer format: int64 description: tipoTituloId: type: string description: numeroTitulo: type: string description: clienteId: type: integer format: int64 description: dataBaixa: type: string format: date description: transacaoBaixa: type: string description: transacaoTesouraria: type: string description: contaInterna: type: string description: valorBaixa: type: string description: valorDesconto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: observacoes: type: array items: type: object allOf: – #/definitions/recObservacaoTitulo description: responses: 200: description: Ok schema: type: object required: – recChaveBaixaTituloReceber properties: recChaveBaixaTituloReceber: type: object allOf: – #/definitions/recChaveBaixaTituloReceber description: default: description: Error response schema: #/definitions/genericError /ig5_contasreceber/actions/estornarBaixaTituloReceber: post: description: Cancela uma baixa de um título a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recChaveBaixaTituloReceber properties: recChaveBaixaTituloReceber: type: object allOf: – #/definitions/recChaveBaixaTituloReceber description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError definitions: 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 recChaveBaixaTituloReceber: description: type: object required: – empresaId – filial – tipoTituloId – numeroTitulo – clienteId – sequenciaMovimento properties: empresaId: type: integer format: int64 description: Empresa do título a receber filial: type: integer format: int64 description: Filial do título a receber tipoTituloId: type: string description: Estrutura do tipo de título do título a receber numeroTitulo: type: string description: Número do título a receber clienteId: type: integer format: int64 description: Cliente do título sequenciaMovimento: type: integer format: int64 description: Sequência de baixa do título a receber recObservacaoTitulo: description: type: object required: – observacao properties: observacao: type: string description: Observação do título usuarioGeracao: type: string description: Usuário de cadastro do tipo de título dataGeracao: type: string format: date-time description: Data de cadastro do tipo de título recTituloReceber: description: Define o registro com os dados do título à receber type: object required: – tituloReceberId – empresaId – filial – tipoTituloId – numeroTitulo – clienteId – dataEntrada – transacaoEntrada – dataEmissao – valorOriginal – vencimentoOriginal – vencimentoProrrogado – provavelPagamento – situacao – portador – carteira – codigoBarras properties: tituloReceberId: type: integer format: int64 description: Identificação do título a receber empresaId: type: integer format: int64 description: Empresa do título a receber filial: type: integer format: int64 description: Filial do título a receber tipoTituloId: type: string description: Estrutura do tipo de título do título a receber numeroTitulo: type: string description: Número do título a receber clienteId: type: integer format: int64 description: Código do cliente dataEntrada: type: string format: date description: Data de entrada do título a receber transacaoEntrada: type: string description: Transação de entrada do título a receber dataEmissao: type: string format: date description: Data de emissão do título a receber valorOriginal: type: string description: Valor original do título a receber vencimentoOriginal: type: string format: date description: Vencimento original do título a receber vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a receber provavelPagamento: type: string format: date description: Provavel pagamento do título a receber situacao: type: string description: Indicativo da situação do título a receber outrosNegociados: type: string description: Valor de outros acréscimos do título a receber outrosDescontos: type: string description: Valor de outros descontos do título a receber observacoes: type: array items: type: object allOf: – #/definitions/recObservacaoTitulo description: Observações do título jurosDia: type: string description: Valor de juros por dia portador: type: string description: Portador do título a receber carteira: type: string description: Carteira do título a receber dataDesconto: type: string format: date description: Data limite de desconto tipoDesconto: type: string description: Tipo de desconto a ser concedido valorDesconto: type: string description: Valor do desconto a ser concedido percentualDesconto: type: number format: double description: Percentual de desconto a ser concedido percentualMulta: type: number format: double description: Percentual de multa moeda: type: string description: Moeda do título a receber codigoBarras: type: string description: Código de barras 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