crm

2.0info: 1.0.0 Oportunidade description: Serviço responsável pelo oportunidades do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: opportunity contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/opportunitysecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listItemsByProposal: post: description: Lista os items da proposta informada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – proposal properties: proposal: #/definitions/filterQueryRecord responses: 200: description: Ok schema: type: object required: – products – services properties: products: #/definitions/recordFullOpportunityProduct services: #/definitions/recordFullOpportunityService default: description: Error response schema: #/definitions/genericError /opportunityCreated: post: description: Evento de oportunidade criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityUpdated: post: description: Evento de oportunidade atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityProposalCreated: post: description: Evento de proposta criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityProposal responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityProposalUpdated: post: description: Evento de proposta atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityProposal responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityProductCreated: post: description: Evento de produto criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityProduct responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityProductUpdated: post: description: Evento de produto atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityProduct responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityServiceCreated: post: description: Evento de serviço criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityService responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityServiceUpdated: post: description: Evento de serviço atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullOpportunityService responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunityParameters: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityParameters responses: 200: description: The created resource schema: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityParameters responses: 200: description: The created resource schema: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError /entities/opportunityParameters/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityParameters responses: 200: description: Ok schema: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityParameters responses: 200: description: Ok schema: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityParameters default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunityParameters/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunityParameters responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/opportunityProduct: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: The created resource schema: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: The created resource schema: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError /entities/opportunityProduct/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: Ok schema: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: Ok schema: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProduct default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunityProduct/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunityProduct responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/opportunity: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: The created resource schema: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: The created resource schema: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError /entities/opportunity/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: Ok schema: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: Ok schema: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunity default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunity/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunity responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/opportunityProposal: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: The created resource schema: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: The created resource schema: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError /entities/opportunityProposal/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: Ok schema: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: Ok schema: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProposal default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunityProposal/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunityProposal responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/opportunityService: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: The created resource schema: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: The created resource schema: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError /entities/opportunityService/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: Ok schema: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: Ok schema: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityService default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/opportunityService/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunityService responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: comparatorEnum: type: string enum: – EQ – NEQ – IN – NOT_IN – LIKE – NOT_LIKE – LT – LTE – GT – GTE filterQueryRecord: type: object required: – comparator – value properties: comparator: #/definitions/comparatorEnum value: type: string description: Valor recordFullOpportunity: type: object required: – companyBranch – account – contact – type – subtype – businessType – date – hour – origin – responsible – negotiationStage – lossReason – salesReasons – operatorRegistration properties: id: type: integer description: Código de identificação no CRM companyBranch: #/definitions/recCompanyBranch account: #/definitions/recAccount contact: #/definitions/recContact opportunityName: type: string description: Nome da oportunidade type: #/definitions/recOpportunityType subtype: #/definitions/recOpportunitySubtype businessType: #/definitions/recBusinessType date: type: string description: Data da criação da abertura da oportunidade format: date hour: type: string description: Hora da criação da abertura da oportunidade origin: #/definitions/recOpportunityOrigin responsible: #/definitions/recordUser negotiationStage: #/definitions/recNegotiationStage lossReason: #/definitions/recLossReason salesReasons: #/definitions/recSalesReasons operatorRegistration: #/definitions/recordUser operatorChange: #/definitions/recordUser probability: type: integer description: Probabilidade de fechamento da oportunidade proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro expectedClosingDate: type: string description: Data da previsão de fechamento da oportunidade format: date effectiveClosingDate: type: string description: Data efetiva do fechamento da oportunidade format: date expectedDeliveryDate: type: string description: Data prevista para a entrega dos produtos format: date expectedValue: type: number description: Valor previsto da oportunidade format: double effectiveClosingValue: type: number description: Valor fechado da oportunidade format: double expectedQuantity: type: number description: Quantidade prevista para a oportunidade format: double achievedQuantity: type: number description: Quantidade realizada para a oportunidade format: double history: type: string description: Histórico de negociação da oportunidade description: type: string description: Descrição da oportunidade notifyEmail: type: boolean description: Se notifica por email a criação da oportunidade e demais interações customFields: type: string description: Campos customizados recCompanyBranch: type: object required: – company – branch properties: id: type: integer description: Código de identificação no CRM company: #/definitions/recordCompany branch: #/definitions/recordBranch recordCompany: type: object properties: id: type: integer description: id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia recordBranch: type: object properties: id: type: integer description: id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia recAccount: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da conta cnpj: type: string description: CNPJ da Conta cpf: type: string description: CPF da Conta rg: type: string description: RG da Conta recContact: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome email: type: string description: Email active: type: boolean description: Ativo recOpportunityType: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome do tipo de oportunidade note: type: string description: Observação active: type: boolean description: Indicativo se o registro está ativo recOpportunitySubtype: type: object properties: id: type: integer description: Código de identificação no CRM recBusinessType: type: object properties: id: type: integer description: Código de identificação no CRM name: type: string description: Nome active: type: boolean description: Ativo recOpportunityOrigin: type: object properties: id: type: integer description: Código de identificação no CRM name: type: string description: Nome da origem de oportunidade active: type: boolean description: Indicativo se o registro está ativo recordUser: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome email: type: string description: Email recNegotiationStage: type: object properties: stage: type: integer description: Estágio name: type: string description: Nome do estágio percentage: type: integer description: Percentual do estágio recLossReason: type: object properties: id: type: integer description: Código de identificação no CRM name: type: string description: Nome active: type: boolean description: Ativo recSalesReasons: type: object properties: id: type: integer description: Código de identificação no CRM name: type: string description: Nome active: type: boolean description: Ativo recordFullOpportunityProposal: type: object required: – opportunity – date – hour – template – languageLayout – issuer – paymentTerm properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity date: type: string description: Data da criação da abertura da proposta format: date hour: type: string description: Hora da criação da abertura da proposta proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro revisionNumber: type: integer description: Número de revisão da proposta shortName: type: string description: Nome resumido da proposta template: #/definitions/recTemplate languageLayout: type: integer description: Idioma do layout de proposta issuer: #/definitions/recordUser proposalStatus: type: integer description: Status da proposta paymentTerm: #/definitions/recPaymentTerm ipi: type: string description: Valor ou porcentagem de IPI da proposta icms: type: string description: Valor ou porcentagem de ICMS da proposta pis: type: string description: Valor ou porcentagem de PIS da proposta cofins: type: string description: Valor ou porcentagem de COFINS da proposta suframa: type: string description: Valor ou porcentagem de SUFRAMA da proposta freeZone: type: string description: Valor ou porcentagem de ZONA FRANCA da proposta carrier: #/definitions/recCarrier carrierDispatch: #/definitions/recCarrierDispatch shippingType: type: integer description: Tipo de frete otherShippingType: type: string description: Descritivo do outro tipo de frete shippingValue: type: number description: Valor do frete format: double warranty: type: string description: Garantia oferecida na prospota validity: type: string description: Validade da proposta deadlineShipping: type: string description: Prazo de entrega dos produtos/serviços groupProductCategory: type: boolean description: Informativo para agrupar os produtos/serviços por categoria sendProposalCopy: type: boolean description: Informativo para enviar uma cópia por email ao responsável da oportunidade showValues: type: boolean description: Informativo se os valores dos produtos e serviços serão exibidos na proposta impressa note: type: string description: Observações da proposta customFields: type: string description: Campos customizados recOpportunity: type: object properties: id: type: integer description: Código de identificação no CRM proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro name: type: string description: Nome recTemplate: type: object properties: id: type: integer description: Código de identificação no CRM recPaymentTerm: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo recCarrier: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo recCarrierDispatch: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo recordFullOpportunityProduct: type: object required: – opportunity – proposal – product – quantity properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity proposal: #/definitions/recProposal sequenceErp: type: integer description: Sequencial do produto no pedido product: #/definitions/recProduct quantity: type: number description: Quantidade do produto na proposta format: double deposit: #/definitions/recDeposit priceTable: #/definitions/recPriceTable saleType: type: integer description: Tipo de venda saleValue: type: number description: Valor da venda do produto na proposta format: double applyCorrectionFactor: type: boolean description: Informativo se deve aplicar o valor de correção no valor do produto discountValue: type: number description: Valor de desconto do produto format: double discountPercentage: type: number description: Percentual de desconto do produto format: double showValues: type: boolean description: Informativo de exibe o valor do produto na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do produto na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do produto na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados recProposal: type: object properties: id: type: integer description: Código de identificação no CRM proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro name: type: string description: Nome recProduct: type: object properties: id: type: integer description: Código de identificação no CRM productCode: type: string description: Código de identificação no sistema terceiro productDerivationCode: type: string description: Código de identificação da derivação no sistema terceiro name: type: string description: Nome nameDerivation: type: string description: Nome derivado active: type: boolean description: Ativo recDeposit: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo recPriceTable: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo recordFullOpportunityService: type: object required: – operatorRegistration properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity proposal: #/definitions/recProposal sequenceErp: type: integer description: Sequencial do produto no pedido service: #/definitions/recService quantity: type: number description: Quantidade do produto na proposta format: double priceTable: #/definitions/recPriceTable operatorRegistration: #/definitions/recordUser operatorChange: #/definitions/recordUser saleValue: type: number description: Valor da venda do produto na proposta format: double discountValue: type: number description: Valor de desconto do serviço format: double showValues: type: boolean description: Informativo de exibe o valor do serviço na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do serviço na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do serviço na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados recService: type: object required: – name properties: id: type: integer description: Código de identificação no CRM serviceCode: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo opportunity: type: object required: – companyBranch – account – contact – type – subtype – businessType – date – hour – origin – responsible – negotiationStage – lossReason – salesReasons – operatorRegistration properties: id: type: integer description: Código de identificação no CRM companyBranch: #/definitions/recCompanyBranch account: #/definitions/recAccount contact: #/definitions/recContact opportunityName: type: string description: Nome da oportunidade type: #/definitions/recOpportunityType subtype: #/definitions/recOpportunitySubtype businessType: #/definitions/recBusinessType date: type: string description: Data da criação da abertura da oportunidade format: date hour: type: string description: Hora da criação da abertura da oportunidade origin: #/definitions/recOpportunityOrigin responsible: #/definitions/recordUser negotiationStage: #/definitions/recNegotiationStage lossReason: #/definitions/recLossReason salesReasons: #/definitions/recSalesReasons operatorRegistration: #/definitions/recordUser operatorChange: #/definitions/recordUser probability: type: integer description: Probabilidade de fechamento da oportunidade proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro expectedClosingDate: type: string description: Data da previsão de fechamento da oportunidade format: date effectiveClosingDate: type: string description: Data efetiva do fechamento da oportunidade format: date expectedDeliveryDate: type: string description: Data prevista para a entrega dos produtos format: date expectedValue: type: number description: Valor previsto da oportunidade format: double effectiveClosingValue: type: number description: Valor fechado da oportunidade format: double expectedQuantity: type: number description: Quantidade prevista para a oportunidade format: double achievedQuantity: type: number description: Quantidade realizada para a oportunidade format: double history: type: string description: Histórico de negociação da oportunidade description: type: string description: Descrição da oportunidade notifyEmail: type: boolean description: Se notifica por email a criação da oportunidade e demais interações customFields: type: string description: Campos customizados opportunityProposal: type: object required: – opportunity – date – hour – template – languageLayout – issuer – paymentTerm properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity date: type: string description: Data da criação da abertura da proposta format: date hour: type: string description: Hora da criação da abertura da proposta proposalNumber: type: string description: Número da proposta no CRM orderNumber: type: string description: Número do pedido no sistema terceiro revisionNumber: type: integer description: Número de revisão da proposta shortName: type: string description: Nome resumido da proposta template: #/definitions/recTemplate languageLayout: type: integer description: Idioma do layout de proposta issuer: #/definitions/recordUser proposalStatus: type: integer description: Status da proposta paymentTerm: #/definitions/recPaymentTerm ipi: type: string description: Valor ou porcentagem de IPI da proposta icms: type: string description: Valor ou porcentagem de ICMS da proposta pis: type: string description: Valor ou porcentagem de PIS da proposta cofins: type: string description: Valor ou porcentagem de COFINS da proposta suframa: type: string description: Valor ou porcentagem de SUFRAMA da proposta freeZone: type: string description: Valor ou porcentagem de ZONA FRANCA da proposta carrier: #/definitions/recCarrier carrierDispatch: #/definitions/recCarrierDispatch shippingType: type: integer description: Tipo de frete otherShippingType: type: string description: Descritivo do outro tipo de frete shippingValue: type: number description: Valor do frete format: double warranty: type: string description: Garantia oferecida na prospota validity: type: string description: Validade da proposta deadlineShipping: type: string description: Prazo de entrega dos produtos/serviços groupProductCategory: type: boolean description: Informativo para agrupar os produtos/serviços por categoria sendProposalCopy: type: boolean description: Informativo para enviar uma cópia por email ao responsável da oportunidade showValues: type: boolean description: Informativo se os valores dos produtos e serviços serão exibidos na proposta impressa note: type: string description: Observações da proposta costCenter: type: string description: Centro de custo classificationOne: type: string description: Classificação 1 classificationTwo: type: string description: Classificação 2 classificationThree: type: string description: Classificação 3 customFields: type: string description: Campos customizados opportunityProduct: type: object required: – opportunity – proposal – product – quantity properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity proposal: #/definitions/recProposal sequenceErp: type: integer description: Sequencial do produto no pedido product: #/definitions/recProduct quantity: type: number description: Quantidade do produto na proposta format: double deposit: #/definitions/recDeposit priceTable: #/definitions/recPriceTable saleType: type: integer description: Tipo de venda saleValue: type: number description: Valor da venda do produto na proposta format: double applyCorrectionFactor: type: boolean description: Informativo se deve aplicar o valor de correção no valor do produto discountValue: type: number description: Valor de desconto do produto format: double discountPercentage: type: number description: Percentual de desconto do produto format: double showValues: type: boolean description: Informativo de exibe o valor do produto na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do produto na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do produto na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados opportunityService: type: object required: – operatorRegistration properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recOpportunity proposal: #/definitions/recProposal sequenceErp: type: integer description: Sequencial do produto no pedido service: #/definitions/recService quantity: type: number description: Quantidade do produto na proposta format: double priceTable: #/definitions/recPriceTable operatorRegistration: #/definitions/recordUser operatorChange: #/definitions/recordUser saleValue: type: number description: Valor da venda do produto na proposta format: double discountValue: type: number description: Valor de desconto do serviço format: double showValues: type: boolean description: Informativo de exibe o valor do serviço na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do serviço na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do serviço na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados opportunityParameters: type: object required: – companyBranch – stageOne – stageTwo – stageThree – stageFour – stageFive – stageSix properties: id: type: integer description: Id de identifiação companyBranch: #/definitions/recCompanyBranch stageOne: #/definitions/recNegotiationStage stageTwo: #/definitions/recNegotiationStage stageThree: #/definitions/recNegotiationStage stageFour: #/definitions/recNegotiationStage stageFive: #/definitions/recNegotiationStage stageSix: #/definitions/recNegotiationStage 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