crm

2.0info: 2.15.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: /apis/opportunityHistoryIntegration: post: description: The create request primitive for the opportunityHistoryIntegration facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityHistoryIntegrationFacade responses: 200: description: Ok schema: #/definitions/opportunityHistoryIntegrationFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityHistoryIntegration facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityHistoryIntegrationFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityHistoryIntegration/{id}: put: description: The update request primitive for the opportunityHistoryIntegration facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityHistoryIntegrationFacade responses: 200: description: Ok schema: #/definitions/opportunityHistoryIntegrationFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityHistoryIntegration facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityHistoryIntegrationFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityHistoryIntegration facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityProposalProduct: post: description: The create request primitive for the opportunityProposalProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityProposalProductFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalProductFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityProposalProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityProposalProductFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityProposalProduct/{id}: put: description: The update request primitive for the opportunityProposalProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityProposalProductFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalProductFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityProposalProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProposalProductFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityProposalProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityProposal: post: description: The create request primitive for the opportunityProposal facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityProposalFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityProposal facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityProposalFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityProposal/{id}: put: description: The update request primitive for the opportunityProposal facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityProposalFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityProposal facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProposalFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityProposal facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityProposalService: post: description: The create request primitive for the opportunityProposalService facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityProposalServiceFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalServiceFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityProposalService facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityProposalServiceFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityProposalService/{id}: put: description: The update request primitive for the opportunityProposalService facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityProposalServiceFacade responses: 200: description: Ok schema: #/definitions/opportunityProposalServiceFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityProposalService facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProposalServiceFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityProposalService facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityParameters: post: description: The create request primitive for the opportunityParameters facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityParametersFacade responses: 200: description: Ok schema: #/definitions/opportunityParametersFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityParameters facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityParametersFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityParameters/{id}: put: description: The update request primitive for the opportunityParameters facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityParametersFacade responses: 200: description: Ok schema: #/definitions/opportunityParametersFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityParameters facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityParametersFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityParameters facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityAction: post: description: The create request primitive for the opportunityAction facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityActionFacade responses: 200: description: Ok schema: #/definitions/opportunityActionFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityAction facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityActionFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityAction/{id}: put: description: The update request primitive for the opportunityAction facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityActionFacade responses: 200: description: Ok schema: #/definitions/opportunityActionFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityAction facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityActionFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityAction facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunity: post: description: The create request primitive for the opportunity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityFacade responses: 200: description: Ok schema: #/definitions/opportunityFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityFacade default: description: Error response schema: #/definitions/genericError /apis/opportunity/{id}: put: description: The update request primitive for the opportunity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityFacade responses: 200: description: Ok schema: #/definitions/opportunityFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: opportunityHistoryIntegrationFacade: type: object properties: id: type: integer description: Id de identificação dateTime: type: string description: Data e hora format: date-time status: type: integer description: Status onde 0: Não Integrado 1: Integrado: 2: Falha ao integrar content: type: string description: Conteúdo opportunity: #/definitions/opportunityInput opportunityFacade: type: object properties: id: type: integer description: ID account: #/definitions/accountRecord companyBranch: #/definitions/companyBranchRecord date: type: string description: Data format: date-time hour: type: string description: Hora format: date-time contact: #/definitions/contactRecord companyId: type: integer description: ID da empresa name: type: string description: Nome da oportunidade subType: type: integer description: Subtipo da oportunidade origin: #/definitions/opportunityOriginRecord script: #/definitions/scriptRecord user: #/definitions/userRecord phase: type: integer description: Estágio standByPhase: type: integer description: Estágio standby lossReason: #/definitions/lossReasonRecord saleReason: #/definitions/saleReasonRecord probability: type: integer description: Probabilidade standByProbability: type: integer description: Probabilidade standby proposalNumber: type: string description: Número da proposta orderNumber: type: string description: Número do pedido autoNumbered: type: boolean description: Se é autonumerada predictedInitialClosingDate: type: string description: Data prevista de fechamento inicial format: date-time predictedClosingDate: type: string description: Data prevista de fechamento format: date-time effectiveDateClosing: type: string description: Data efetiva de fechamento format: date-time predictedDeliveryDate: type: string description: Data prevista de entrega format: date-time effectiveDelivertDate: type: string description: Data efetiva de entreda format: date-time initialPredictedValue: type: number description: Valor previsto inicial format: double predictedValue: type: number description: Valor previsto format: double closedValue: type: number description: Valor fechado format: double predictedValueCurrency: type: number description: Moeda do valor previsto format: double closedValueCurrency: type: number description: Moeda do valor esperado format: double predictedQuantitative: type: number description: Quantidade prevista format: double quantitativeAccomplished: type: number description: Quantidade realizada format: double history: type: string description: Histórico description: type: string description: Descrição timestampRegistration: type: string description: Cadastro timestamp format: date-time operatorRegistration: #/definitions/operatorRecord timestampChange: type: string description: Alteração do timestamp format: date-time operatorChange: #/definitions/operatorRecord businessType: #/definitions/businessTypeRecord customFields: type: string description: Campos customizados format: byte type: #/definitions/opportunityTypeRecord notifyEmail: type: boolean description: Se notifica por e-mail infoErp: type: string description: Informações do ERP format: byte proposals: type: array items: #/definitions/opportunityProposalInput description: Propostas actions: type: array items: #/definitions/opportunityActionInput description: Ações accountRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Razão social fantasyName: type: string description: Nome fantasia economicGroup: type: string description: Grupo econômico stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal cnpj: type: string description: CNPJ rg: type: string description: RG cpf: type: string description: CPF einNumber: type: string description: EIN ssnNumber: type: string description: SSN url: type: string description: URL generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro employees: type: integer description: Número de funcionários annualIncome: type: number description: Receita anual format: double registrationDate: type: string description: Data de cadastro format: date-time customerSince: type: string description: Cliente deste format: date-time birthDate: type: string description: Data de nascimento format: date-time receiveEmail: type: boolean description: Se recebe e-mail receiveSurvey: type: boolean description: Se recebe pesquisa receiveTrackEmail: type: boolean description: Se recebe monitoramento do e-mail active: type: boolean description: Se está ativo personType: #/definitions/personTypeRecord companySize: #/definitions/companySizeRecord activityBranch: #/definitions/activityBranchRecord companyGroup: #/definitions/companyGroupRecord origin: #/definitions/originRecord nit: type: string description: NIT cedulaCiudadania: type: string description: Cédula de ciudadanía passport: type: string description: Passaporte personTypeRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome icon: type: string description: ícone active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companySizeRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: string description: Se está ativo company: #/definitions/companyRecord companyRecord: type: object properties: id: type: integer description: ID companyErp: type: string description: ID no sistema terceiro name: type: string description: Razão social fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ nit: type: string description: NIT activityBranchRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo company: #/definitions/companyRecord companyGroupRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord originRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord companyBranchRecord: type: object properties: id: type: integer description: ID company: #/definitions/companyRecord branch: #/definitions/branchRecord branchRecord: type: object properties: id: type: integer description: ID branchErp: type: string description: ID no sistema terceiro name: type: string description: Razão social fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ parent: type: integer description: Empresa matriz nit: type: string description: NIT contactRecord: type: object properties: id: type: integer description: ID search: type: integer description: Pesquisa privateUser: type: integer description: Usuário privado sequentialErp: type: string description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer description: Visibilidade name: type: string description: Nome treatment: type: string description: Tratamento functionDescription: type: string description: Descrição da função gender: type: integer description: Gênero sexual cep: type: string description: CEP zipCode: type: string description: ZIP Code address: type: string description: Endereço number: type: string description: Numero complement: type: string description: Complemento district: type: string description: Bairro cpf: type: string description: CPF rg: type: string description: RG citizenshipCard: type: string description: Cédula cidadania telephone: type: string description: Telefone corporatePhone: type: boolean description: Telefone corporativo phoneBranch: type: string description: Ramal fax: type: string description: FAX cell: type: string description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer description: Operadora email: type: string description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveSearch: type: boolean description: Recebe pesquisa skype: type: string description: Skype twitter: type: string description: Twitter facebook: type: string description: Facebook birthday: type: string description: Aniversário birthDate: type: string description: Data de nascimento format: date-time decisionLevel: type: integer description: Nível de decisão opinionCompany: type: integer description: Parecer empresa reasonOpinionCompany: type: string description: Motivo parecer empresa notes: type: string description: Observações customFields: type: string description: Campos customizados format: byte city: #/definitions/cityRecord department: #/definitions/departmentRecord function: #/definitions/functionRecord origin: #/definitions/originRecord account: #/definitions/accountRecord superiorContact: #/definitions/contactRecord companyBranch: #/definitions/companyBranchRecord cityRecord: type: object properties: id: type: integer description: ID idErp: type: string description: Id no sistema terceiro idIbge: type: string description: Código da cidade no IBGE name: type: string description: Nome active: type: boolean description: Ativo dddCode: type: string description: Código DDD population: type: integer description: População estimatedPopulation: type: integer description: População estimada consumptionPotential: type: number description: Potencial de consumo format: double pib: type: number description: PIB format: double customFields: type: string description: Campos customizados format: byte state: #/definitions/stateRecord stateRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo country: #/definitions/countryRecord customFields: type: string description: Campos customizados format: byte countryRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte countryCode: type: integer description: Código do país departmentRecord: type: object properties: id: type: integer description: ID companyBranch: #/definitions/companyBranchRecord name: type: string description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa ocorrência customFields: type: string description: Campos customizados format: byte functionRecord: type: object properties: id: type: integer description: ID idErp: type: string description: Id no sistema terceiro company: #/definitions/companyRecord name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte opportunityOriginRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord scriptRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome description: type: string description: Descrição userRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função photo: type: string description: Foto email: type: string description: E-mail active: type: boolean description: Se está ativo lossReasonRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord saleReasonRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord operatorRecord: type: object properties: id: type: integer description: ID idErp: type: string description: Id no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função email: type: string description: E-mail active: type: boolean description: Se está ativo businessTypeRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome notes: type: string description: Observações active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord opportunityTypeRecord: type: object properties: id: type: integer description: Id idErp: type: string description: Id no sistema terceiro name: type: string description: Nome note: type: string description: Observações active: type: boolean description: Ativo companyBranch: #/definitions/companyBranchRecord opportunityProposalFacade: type: object properties: id: type: integer description: ID opportunity: #/definitions/opportunityInput date: type: string description: Data format: date-time hour: type: string description: Hora format: date-time proposalNumber: type: string description: Número da proposta orderNumber: type: string description: Número do pedido proposalReview: type: integer description: Revisão da proposta shortName: type: string description: Nome resumido template: type: integer description: Template user: #/definitions/userRecord recipientType: type: integer description: Tipo de destinatário contactId: type: integer description: ID do contato recipientName: type: string description: Nome do destinatário recipientDepartment: type: string description: Departamento do destinatário recipientPhone: type: string description: Telefone do destinatário recipientEmail: type: string description: E-mail do destinatário recipientEmailCc: type: string description: Cc do e-mail do destinatário recipientEmailBcc: type: string description: Cco do e-mail do destinatário shippingStatus: type: boolean description: Se foi enviado proposalStatus: type: integer description: Status da proposta shippingDate: type: string description: Data de envio format: date-time shippingTime: type: string description: Hora de envio format: date-time paymentTerm: #/definitions/paymentTermRecord paymentMethod: type: integer description: Forma de pagamento paymentType: type: integer description: Tipo de pagamento ipi: type: string description: IPI icms: type: string description: ICMS pis: type: string description: PIS cofins: type: string description: COFINS suframa: type: string description: SUFRAMA freeZone: type: string description: Zona franca carrier: #/definitions/carrierRecord redispatch: #/definitions/redispatchRecord shippingType: type: integer description: Tipo de frete shippingTypeOther: type: string description: Tipo de frete outro valueShipping: type: number description: Valor do frete format: double warrantly: type: string description: Garantia validity: type: string description: Validade delivery: type: string description: Entrega groupCategory: type: boolean description: Se agrupa categoria sendCopy: type: boolean description: Se envia cópia showValues: type: boolean description: Se mostra os valores notes: type: string description: Observações inputValue: type: number description: Valor de entrada format: double languageLayout: type: integer description: Idioma layout cpUser1Column: type: string description: Cp User1 coluna installments: type: integer description: Número de parcelas tax: type: number description: Taxa format: double exchangeRate: type: number description: Taxa de câmbio format: double exchangeRateConvert: type: integer description: Converter taxa de câmbio installmentValue: type: number description: Valor da parcela format: double documents: type: string description: Documentos emailText: type: string description: Texto do e-mail sellerUser: #/definitions/userRecord representativeUser: #/definitions/userRecord timestampRegistration: type: string description: Cadastro timestamp format: date-time operatorRegistration: #/definitions/operatorRecord timestampChange: type: string description: Alteração do timestamp format: date-time operatorChange: #/definitions/operatorRecord validProposal: type: integer description: Valida proposta groupProductService: type: boolean description: Se agrupa produto e serviço proposalDiscountValue: type: number description: Valor do desconto da proposta format: double costCenter: type: string description: Centro de custo customFields: type: string description: Campos customizados format: byte appId: type: string description: App ID classification1: type: string description: Classificação 1 classification2: type: string description: Classificação 2 classification3: type: string description: Classificação 3 products: type: array items: #/definitions/opportunityProposalProductInput description: Produtos services: type: array items: #/definitions/opportunityProposalServiceInput description: Serviços paymentTermRecord: type: object properties: id: type: integer description: Id do prazo de pagamento idErp: type: string description: Id do ERP name: type: string description: Nome do tipo do pagamento active: type: boolean description: Informa se o tipo do pagamento está ativo generatesInstallments: type: boolean description: Informa se é para gerar parcelas amountInstallments: type: integer description: Informa a quantidade de parcelas additionInstallments: type: number description: Informa o acréscimo das parcelas / juros format: double rounding: type: integer description: Informa o arredondamento, se for igual a 1 não deixa o valor quebrado customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord carrierRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord redispatchRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord opportunityProposalProductFacade: type: object properties: id: type: integer description: ID proposal: #/definitions/opportunityProposalInput purposeId: type: integer description: ID da finalidade companyId: type: integer description: Empresa sequentialErp: type: string description: Sequencial no ERP proposalReview: type: integer description: Revisão da proposta product: #/definitions/productRecord quantity: type: number description: Quantidade format: double deposit: #/definitions/depositRecord priceTable: #/definitions/priceTableRecord saleType: type: integer description: Tipo de venda saleValue: type: number description: Valor de venda format: double applyFactor: type: boolean description: Se aplica fator discountValue: type: number description: Valor do desconto format: double discountPercentage: type: number description: Porcentagem de desconto format: double taxValue: type: number description: Valor da taxa format: double showValue: type: boolean description: Mostrar valor showPhoto: type: boolean description: Mostrar foto showAttachment: type: boolean description: Mostrar anexo notes: type: string description: Observações timestampRegistration: type: string description: Cadastro timestamp format: date-time operatorRegistration: #/definitions/operatorRecord timestampChange: type: string description: Alteração do timestamp format: date-time operatorChange: #/definitions/operatorRecord integratedItem: type: integer description: Item integrado invoicedQuantity: type: number description: Quantidade faturada format: double canceledQuantity: type: number description: Quantidade cancelada format: double ipi: type: number description: IPI format: double ipiValue: type: string description: Valor IPI icms: type: number description: ICMS format: double icmsSt: type: number description: ICMS-ST format: double pis: type: number description: PIS format: double cofins: type: number description: COFINS format: double iss: type: number description: ISS format: double inss: type: number description: INSS format: double irrf: type: number description: IRRF format: double freeZone: type: number description: Zona franca format: double suframa: type: number description: SUFRAMA format: double freightApportionment: type: number description: Rateio do frete format: double customFields: type: string description: Campos customizados format: byte productRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome derivationName: type: string description: Nome da derivação partNumber: type: string description: Part number ncm: type: string description: NCM derivationPartNumber: type: string description: Part number da derivação active: type: boolean description: Se está ativo saleValue: type: string description: Valor de venda maxDescount: type: number description: Desconto máximo format: double standardQuantity: type: string description: Quantidade padrão correctionFactor: type: string description: Fator de correção saleType: type: boolean description: Tipo de venda ipi: type: string description: IPI icms: type: string description: ICMS weight: type: string description: Peso currencyId: type: integer description: Id da moeda tax: type: string description: Taxa notes: type: string description: Observações origin: type: string description: Origem customFields: type: string description: Campos customizados format: byte measurementUnit: #/definitions/measurementUnitRecord company: #/definitions/companyRecord measurementUnitRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte depositRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord priceTableRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos Customizados format: byte companyBranch: #/definitions/companyBranchRecord opportunityProposalServiceFacade: type: object properties: id: type: integer description: ID opportunity: #/definitions/opportunityInput proposal: #/definitions/opportunityProposalInput companyId: type: integer description: ID da empresa sequentialErp: type: string description: Sequencial no ERP proposalReview: type: integer description: Revisão da proposta service: #/definitions/serviceRecord quantity: type: number description: Quantidade format: double priceTable: #/definitions/priceTableRecord saleValue: type: number description: Valor de venda format: double discountValue: type: number description: Valor do desconto format: double showValue: type: boolean description: Mostrar valor showPhoto: type: boolean description: Mostrar foto showAttachment: type: boolean description: Mostrar anexo notes: type: string description: Observações timestampRegistration: type: string description: Cadastro timestamp format: date-time operatorRegistration: #/definitions/operatorRecord timestampChange: type: string description: Alteração do timestamp format: date-time operatorChange: #/definitions/operatorRecord integratedItem: type: boolean description: Se o item é integrado sequentialDependence: type: integer description: Dependência sequencial customFields: type: string description: Campos customizados format: byte serviceRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome partNumber: type: string description: Part number ncm: type: string description: NCM active: type: boolean description: Se está ativo saleValue: type: string description: Valor de venda notes: type: string description: Observações maxDiscount: type: string description: Desconto máximo customFields: type: string description: Campos customizados format: byte serviceCategory: #/definitions/serviceCategoryRecord measurementUnit: #/definitions/measurementUnitRecord company: #/definitions/companyRecord serviceCategoryRecord: type: object properties: id: type: integer description: ID idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord opportunityActionFacade: type: object properties: id: type: integer description: Id opportunity: #/definitions/opportunityInput actionType: #/definitions/actionTypeRecord date: type: string description: Data format: date-time hour: type: string description: Hora format: date-time changeOpportunity: type: boolean description: Se muda a oportunidade phase: type: integer description: Estágio lossReason: #/definitions/lossReasonRecord saleReason: #/definitions/saleReasonRecord probability: type: integer description: Probabilidade proposalNumber: type: string description: Número da proposta orderNumber: type: string description: Número do pedido predictedClosingDate: type: string description: Data prevista de fechamento format: date-time effectiveDateClosing: type: string description: Data efetiva de fechamento format: date-time predictedDeliveryDate: type: string description: Data prevista de entrega format: date-time effectiveDeliveryDate: type: string description: Data efetiva de entrega format: date-time predictedValue: type: number description: Valor previsto format: double closedValue: type: number description: Valor fechado format: double predictedValueCurrency: type: number description: Moeda do valor previsto format: double closedValueCurrency: type: number description: Moeda do valor esperado format: double predictedQuantitative: type: number description: Quantidade prevista format: double quantitativeAccomplished: type: number description: Quantidade realizada format: double notes: type: string description: Observações timestampRegistration: type: string description: Cadastro timestamp format: date-time operatorRegistration: #/definitions/operatorRecord timestampChange: type: string description: Alteração do timestamp format: date-time operatorChange: #/definitions/operatorRecord actionTypeRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome notes: type: string description: Observações strategicAction: type: boolean description: Se é uma ação estratégica usesOpportunity: type: boolean description: Se usa oportunidade usesOccurrence: type: boolean description: Se usa ocorrência usesContract: type: boolean description: Se usa contrato usesEvent: type: boolean description: Se usa evento companyBranch: #/definitions/companyBranchRecord opportunityParametersFacade: type: object properties: id: type: integer description: ID companyBranch: #/definitions/companyBranchRecord funnelStage1: type: string description: Funil etapa 1 funnelStage2: type: string description: Funil etapa 2 funnelStage3: type: string description: Funil etapa 3 funnelStage4: type: string description: Funil etapa 4 closedStageFunnel: type: string description: Funil etapa fechada lostStageFunnel: type: string description: Funil etapa perdida changeAccountStep1: type: boolean description: Muda conta etapa 1 changeAccountStep2: type: boolean description: Muda conta etapa 2 changeAccountStep3: type: boolean description: Muda conta etapa 3 changeAccountStep4: type: boolean description: Muda conta etapa 4 changeAccountStageClosed: type: boolean description: Muda conta etapa fechada changeForecastStep1: type: boolean description: Muda forecast etapa 1 changeForecastStep2: type: boolean description: Muda forecast etapa 2 changeForecastStep3: type: boolean description: Muda forecast etapa 3 changeForecastStep4: type: boolean description: Muda forecast etapa 4 changeForecastLostStage: type: boolean description: Muda forecast etapa perdida changeForecastClosedStage: type: boolean description: Muda forecast etapa perdida stepPercentage1: type: integer description: Percentual etapa 1 stepPercentage2: type: integer description: Percentual etapa 2 stepPercentage3: type: integer description: Percentual etapa 3 stepPercentage4: type: integer description: Percentual etapa 4 pipelineStep1: type: boolean description: Pipeline etapa 1 pipelineStep2: type: boolean description: Pipeline etapa 2 pipelineStep3: type: boolean description: Pipeline etapa 3 pipelineStep4: type: boolean description: Pipeline etapa 4 lostStatePipeline: type: boolean description: Pipeline etapa perdida closedStagePipeline: type: boolean description: Pipeline etapa fechada proposalDefaultText: type: string description: Texto padrão proposta emailProposalDefaultText: type: string description: Texto padrão proposta e-mail proposalShowsChargeType: type: boolean description: Proposta mostra tipo cobrança proposalStandardValidity: type: string description: Proposta validade padrão proposalStandardGuarantee: type: string description: Proposta garantia padrão proposalStandardDelivery: type: string description: Proposta entrega padrão proposalStandardPis: type: string description: Proposta PIS padrão proposalStandardCofins: type: string description: Proposta cofins padrão proposalStandardCustomerShipping: type: string description: Proposta frete cliente padrão proposalStandardSupplierFreight: type: string description: Proposta frete fornecedor padrão proposalShippingOtherStandard: type: string description: Proposta frete outro padrão proposalUseProductBatch: type: boolean description: Proposta usa produto lote proposalConsistsProductTypeOpportunity: type: boolean description: Proposta consiste produto tipo oportunidade proposalConsistsDeadlineDelivery: type: boolean description: Proposta consiste prazo entrega proposalConsistsProductDeposit: type: boolean description: Proposta consiste depósito produto proposalConsistsUnitMeasureProduct: type: boolean description: Proposta consiste unidade medida produto proposalLogo: type: string description: Proposta logo proposalPosX: type: string description: Proposta posição X proposalPosY: type: string description: Proposta posição Y proposalWidth: type: string description: Proposta largura proposalHeight: type: string description: Proposta altura proposalCover: type: string description: Proposta capa proposalVerse: type: string description: Proposta verso proposalThirdFile: type: string description: Proposta arquivo terceiro proposalThirdFileSends: type: string description: Proposta arquivo terceiro envia proposalAppFile: type: string description: Proposta arquivo APP proposalCreateAction: type: boolean description: Proposta cria ação proposalTypeActionId: type: integer description: Proposta tipo ação ID proposalCreateFollowUp: type: boolean description: Proposta cria follow up proposalFollowUpDays: type: integer description: Proposta follow up dias proposalChangeFunnelStage: type: boolean description: Proposta muda etapa funil proposalStepFunnelId: type: integer description: Proposta etapa funil ID proposalFollowUpText: type: string description: Proposta follow up texto proposalDisplayRepresentative: type: boolean description: Proposta exibe representante proposalBackGroundR: type: string description: Fundo proposta R proposalBackGroundG: type: string description: Fundo proposta G proposalBackGroundB: type: string description: Fundo proposta B usesQuantitative: type: boolean description: Usa quantitativo quantitativeName: type: string description: Nome quantitativo quantitativeHouses: type: boolean description: Casas quantitativo useNumbering: type: boolean description: Usa numeração doubleNumbering: type: boolean description: Dupla numeração numberingValue: type: integer description: Valor numeração opportunityStandByUse: type: boolean description: Oportunidade stand by usa opportunityStandByDataProcess: type: string description: Oportunidade stand by data processa format: date-time opportunityStandByEnterDays: type: integer description: Oportunidade stand by entra dias opportunityStandByEnterActionUse: type: boolean description: Oportunidade stand by entra ação usa opportunityStandByEnterTypeActionId: type: integer description: Oportunidade stand by entra tipo ação ID opportunityStandByEnterTextAction: type: string description: Oportunidade stand by entra ação texto opportunityStandbyExitDays: type: integer description: Oportunidade stand by sai dias opportunityStandByExitActionUse: type: boolean description: Oportunidade stand by sai ação usar opportunityStandByExitTypeActionId: type: integer description: Oportunidade stand by sai tipo ação ID opportunityStandByExitActionText: type: string description: Oportunidade stand by sai ação texto opportunityStandByStep: type: boolean description: Oportunidade stand by etapa opportunityRequiresDescription: type: integer description: Oportunidade obriga descrição opportunityRequiresSubtype: type: integer description: Oportunidade obriga subtipo opportunityRequiresForecastClosing: type: integer description: Oportunidade obriga previsão fechamento opportunityRequiresForecastDelivery: type: integer description: Oportunidade obriga previsão entrega opportunityRequiresEffectiveDelivery: type: integer description: Oportunidade obriga efetiva entrega opportunityRequiresForecastValue: type: integer description: Oportunidade obriga previsão valor opportunityRequiresEffectiveValue: type: integer description: Oportunidade obriga efetivo valor opportunityRequiresForecastCurrency: type: integer description: Oportunidade obriga previsão moeda opportunityRequiresEffectiveCurrency: type: integer description: Oportunidade obriga efetiva moeda opportunityRequiresForecastQuantitative: type: integer description: Oportunidade obriga previsão quantitativo opportunityRequiresEffectiveQuantitative: type: integer description: Oportunidade obriga efetivo quantitativo opportunityFieldUser1: type: string description: Oportunidade campos usuário 1 opportunityFieldUser2: type: string description: Oportunidade campos usuário 2 opportunityFieldUser3: type: string description: Oportunidade campos usuário 3 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