Fis

Fis Integracao

46 views 22/10/2018 07/11/2018 integrador 1

2.0info: 0.0.0 integracao /bridge/rest/fis – application/json – application/jsonpaths: /integracao/queries/getMetadata: post: description: This operation is public. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries 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: This operation is public. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries 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 /integracao/actions/transportadora: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – transportadoras properties: transportadoras: type: array items: type: object allOf: – #/definitions/dadosTransportadora minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/pedido: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – pedidos properties: pedidos: type: array items: type: object allOf: – #/definitions/dadosPedido minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/cancelamentoPedido: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – cancelamentoPedidos properties: cancelamentoPedidos: type: array items: type: object allOf: – #/definitions/dadosCancelamentoPedido minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/faturamentoNfe: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – faturamentosNfe properties: faturamentosNfe: type: array items: type: object allOf: – #/definitions/dadosFaturamentoNfe minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/confirmacaoPagamento: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – confirmacaoPagamentos properties: confirmacaoPagamentos: type: array items: type: object allOf: – #/definitions/dadosConfirmacaoPagamento minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/signals/enviaServicoPrazo: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted 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 dadosTransportadora: description: type: object required: – cnpj_empresa – cd_transportadora – ds_transportadora – nu_cgc – nu_ie – ds_endereco – numero – ds_bairro – ds_cidade – sg_uf properties: cnpj_empresa: type: string description: cd_transportadora: type: integer format: int64 description: ds_transportadora: type: string description: ds_nome_fantasia: type: string description: nu_cgc: type: string description: nu_ie: type: string description: ds_endereco: type: string description: numero: type: string description: complemento: type: string description: ds_bairro: type: string description: ds_cidade: type: string description: cd_municipio: type: string description: sg_uf: type: string description: nu_telefone_1: type: string description: nu_telefone_2: type: string description: nm_contato: type: string description: dadosPedido: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_vlr_nf – ped_ps_real – ped_tp_pedido – cli_nm_cliente – cli_nu_cgc – loc_cep – loc_endereco – loc_endereco_numero – loc_bairro – loc_cidade – loc_cidade_cod_ibge – loc_sg_uf – tp_frete – cli_id_contribuinte_icms – ped_cd_produto_categoria properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: integer format: int64 description: ped_nu_pedido_origem: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: ped_dt_emissao_nf: type: string description: ped_nf_chave_acesso: type: string description: ped_ds_natureza_mercadoria: type: string description: ped_ds_tipo_acondicionamento: type: string description: ped_vlr_nf: type: number format: double description: ped_nu_documento: type: string description: ped_ps_real: type: number format: double description: ped_ps_cubado: type: number format: double description: ped_qt_volume: type: integer format: int64 description: ped_vlr_frete_receber: type: number format: double description: ped_cd_transp_origem: type: integer format: int64 description: ped_tp_pedido: type: string description: fis_uid: type: integer format: int64 description: ped_dt_entrega: type: string description: cli_nm_cliente: type: string description: cli_nu_rg: type: string description: cli_nu_cgc: type: string description: cli_nu_inscricao: type: string description: cli_nu_tel_res: type: string description: cli_nu_tel_cel: type: string description: cli_ds_email: type: string description: loc_cep: type: string description: loc_endereco: type: string description: loc_endereco_numero: type: string description: loc_bairro: type: string description: loc_cidade: type: string description: loc_cidade_cod_ibge: type: string description: loc_sg_uf: type: string description: loc_ds_observacao: type: string description: qt_dias_entrega: type: integer format: int64 description: tp_frete: type: string description: cd_centro: type: integer format: int64 description: cd_custo: type: integer format: int64 description: ped_entrega_tracking_number: type: string description: cli_id_contribuinte_icms: type: string description: ped_cfop: type: string description: loc_complemento_endereco: type: string description: cli_nm_recebedor: type: string description: cli_nu_tel_recebedor: type: string description: ped_cd_tipo_entrega: type: integer format: int64 description: ped_id_periodo: type: string description: ped_diametro_volume: type: integer format: int64 description: ped_cd_produto_categoria: type: string description: ped_qt_km: type: number format: double description: dadosCancelamentoPedido: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: integer format: int64 description: ped_nu_pedido_origem: type: string description: ped_ds_motivo_cancelamento: type: string description: dadosFaturamentoNfe: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_nu_nf – ped_nu_serie_nf – ped_dt_emissao_nf – ped_chave_acesso – ped_qt_volume – ped_cfop properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: integer format: int64 description: ped_nu_pedido_origem: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: ped_dt_emissao_nf: type: string description: ped_chave_acesso: type: string description: ped_qt_volume: type: integer format: int64 description: ped_cfop: type: string description: dadosConfirmacaoPagamento: description: type: object required: – pag_cnpj_empresa – pag_cd_cnpj_transp – pag_nu_cte – pag_nu_cte_serie – pag_vlr_pago – pag_dt_pagamento properties: pag_cnpj_empresa: type: string description: pag_cd_cnpj_transp: type: string description: pag_nu_cte: type: integer format: int64 description: pag_nu_cte_serie: type: string description: pag_nu_titulo: type: string description: pag_vlr_pago: type: integer format: int64 description: pag_dt_pagamento: type: string description: dadosDetalhePagamentoFrete: description: type: object required: – cnpj_empresa – cd_cnpj_transp – nu_cte – nu_cte_serie – dt_emissao_cte – nu_nf – nu_serie_nf properties: cnpj_empresa: type: string description: cd_cnpj_transp: type: string description: nu_cte: type: integer format: int64 description: nu_cte_serie: type: string description: dt_emissao_cte: type: string description: nu_nf: type: integer format: int64 description: nu_serie_nf: type: string description: dadosCteFatura: description: type: object required: – cte_chave_acesso properties: cte_chave_acesso: type: string description: 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: object allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: object 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: object 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. 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