crm

2.0info: 2.4.2 Core description: Serviço responsável pela criação de recursos e disparo de eventos na platform. x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: core contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/core/securityDefinitions: 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: /entities/deposit: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 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/deposit responses: 200: description: The created resource schema: #/definitions/deposit 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/deposit default: description: Error response schema: #/definitions/genericError /entities/deposit/{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/deposit responses: 200: description: Ok schema: #/definitions/deposit 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/deposit responses: 200: description: Ok schema: #/definitions/deposit 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/deposit 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/deposit/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/deposit responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountDefinition: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 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/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 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/accountDefinition default: description: Error response schema: #/definitions/genericError /entities/accountDefinition/{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/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 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/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 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/accountDefinition 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/accountDefinition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountPhone: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 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/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 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/accountPhone default: description: Error response schema: #/definitions/genericError /entities/accountPhone/{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/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 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/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 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/accountPhone 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/accountPhone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountPhone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/account: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/account responses: 200: description: The created resource schema: #/definitions/account 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/account responses: 200: description: The created resource schema: #/definitions/account 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/account default: description: Error response schema: #/definitions/genericError /entities/account/{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/account responses: 200: description: Ok schema: #/definitions/account 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/account responses: 200: description: Ok schema: #/definitions/account 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/account 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/account/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/account 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/companyGroups: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 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/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 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/companyGroups default: description: Error response schema: #/definitions/genericError /entities/companyGroups/{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/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 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/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 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/companyGroups 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/companyGroups/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/companyGroups responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/service: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 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/service responses: 200: description: The created resource schema: #/definitions/service 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/service default: description: Error response schema: #/definitions/genericError /entities/service/{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/service responses: 200: description: Ok schema: #/definitions/service 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/service responses: 200: description: Ok schema: #/definitions/service 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/service 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/service/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/service responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/product: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 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/product responses: 200: description: The created resource schema: #/definitions/product 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/product default: description: Error response schema: #/definitions/genericError /entities/product/{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/product responses: 200: description: Ok schema: #/definitions/product 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/product responses: 200: description: Ok schema: #/definitions/product 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/product 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/product/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/paymentTerms: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 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/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 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/paymentTerms default: description: Error response schema: #/definitions/genericError /entities/paymentTerms/{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/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 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/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 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/paymentTerms 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/paymentTerms/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/paymentTerms 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/genericError /entities/accountAddress: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 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/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 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/accountAddress default: description: Error response schema: #/definitions/genericError /entities/accountAddress/{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/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 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/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 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/accountAddress 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/accountAddress/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountAddress responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/priceTable: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 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/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 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/priceTable default: description: Error response schema: #/definitions/genericError /entities/priceTable/{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/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 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/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 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/priceTable 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/priceTable/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/priceTable 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/activityBranches: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 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/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 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/activityBranches default: description: Error response schema: #/definitions/genericError /entities/activityBranches/{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/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 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/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 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/activityBranches 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/activityBranches/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/activityBranches 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/paymentType: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 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/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 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/paymentType default: description: Error response schema: #/definitions/genericError /entities/paymentType/{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/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 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/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 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/paymentType 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/paymentType/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/paymentType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/carrier: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 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/carrier responses: 200: description: The created resource schema: #/definitions/carrier 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/carrier default: description: Error response schema: #/definitions/genericError /entities/carrier/{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/carrier responses: 200: description: Ok schema: #/definitions/carrier 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/carrier responses: 200: description: Ok schema: #/definitions/carrier 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/carrier 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/carrier/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/carrier responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/opportunityType: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 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/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 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/opportunityType default: description: Error response schema: #/definitions/genericError /entities/opportunityType/{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/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 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/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 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/opportunityType 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/opportunityType/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/opportunityType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: account: type: object required: – id – name – registerDate – active – origin – token properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários einNumber: type: string description: EIN ssnNumber: type: string description: SSN birthDate: type: string description: Data de nascimento/abertura format: date active: type: boolean description: Status de atividade customFields: type: string description: Campos customizados activityBranch: #/definitions/recordActivityBranch companySize: #/definitions/recordCompanySize personType: #/definitions/recordPersonType companyGroup: #/definitions/recordCompanyGroup origin: #/definitions/recordOrigin accountDefinition: #/definitions/recordFullAccountDefinition accountResponsible: #/definitions/recordAccountResponsible token: type: string description: Token identificação do CRM recordActivityBranch: type: object required: – id 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 Empresa/Filial recordCompanySize: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do porte da empresa recordPersonType: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do tipo de Pessoa recordCompanyGroup: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome grupo da empresa recordOrigin: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome da origem recordFullAccountDefinition: type: object required: – accountType – rating – status properties: id: type: integer description: Código de identificação salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados companyBranch: #/definitions/recordCompanyBranch accountType: #/definitions/recordAccountType rating: #/definitions/recordRating status: #/definitions/recordStatus inactivationReason: #/definitions/recordInactivationReason priceTable: #/definitions/recordPriceTable carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch representative: #/definitions/recordRepresentative seller: #/definitions/recordSeller paymentTerm: #/definitions/recordPaymentTerm recordCompanyBranch: type: object required: – id – 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 da Empresa fantasyName: type: string description: Nome fantasia da Empresa 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 da Empresa fantasyName: type: string description: Nome fantasia da Empresa recordAccountType: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do tipo da Conta recordRating: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome da Avaliação recordStatus: type: object required: – id – name properties: id: type: integer description: Código de identificação name: type: string description: Nome do status recordInactivationReason: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Motivo da inativação recordPriceTable: type: object required: – id 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 tabela de preços recordCarrier: type: object required: – id 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 operadora recordCarrierDispatch: type: object required: – id 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 operadora de dispacho recordRepresentative: type: object required: – id 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 representante recordSeller: type: object required: – id 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 vendedor recordPaymentTerm: type: object required: – id 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 termo de pagamento recordAccountResponsible: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro accountDefinition: type: object required: – account – accountType – rating – status – token properties: id: type: integer description: Código de identificação salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados account: #/definitions/recordBasicAccount companyBranch: #/definitions/recordCompanyBranch accountType: #/definitions/recordAccountType rating: #/definitions/recordRating status: #/definitions/recordStatus inactivationReason: #/definitions/recordInactivationReason priceTable: #/definitions/recordPriceTable carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch representative: #/definitions/recordRepresentative seller: #/definitions/recordSeller paymentTerm: #/definitions/recordPaymentTerm token: type: string description: Token de identificação do CRM recordBasicAccount: 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 accountPhone: type: object required: – id – account – number – type – main – token properties: id: type: integer description: Código de dentificação account: #/definitions/recordBasicAccount number: type: string description: Número de telefone type: type: integer description: Tipo de telefone operator: type: integer description: Operadora da conta main: type: boolean description: Telefone principal token: type: string description: Token de identificação do CRM accountAddress: type: object required: – id – account – type – main – address – active – city – token properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount type: #/definitions/recordAddressType main: type: boolean description: Endereço principal address: type: string description: Endereço active: type: boolean description: Status de atividade number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cepCode: type: string description: CEP latitude: type: string description: Latitude longitude: type: string description: Longitude city: #/definitions/recordCity zipCode: type: string description: ZIP code customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM recordAddressType: type: object required: – id – name properties: id: type: integer description: Código de identificação name: type: string description: Nome recordCity: type: object required: – name properties: id: type: integer description: Código de identificação ibgeCode: type: string description: Código da cidade no IBGE name: type: string description: Nome da cidade state: #/definitions/recordState recordState: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome initials: type: string description: Inicial country: #/definitions/recordCountry recordCountry: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome activityBranches: type: object required: – token 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: Descritivo do ramo de atividade active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM companyGroups: type: object required: – token 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: Descritivo do grupo de empresa company: #/definitions/recordCompany active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM priceTable: type: object required: – token 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: Descritivo do grupo de empresa companyBranch: #/definitions/recordCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM carrier: type: object required: – token 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: Descritivo do grupo de empresa companyBranch: #/definitions/recordCompanyBranch active: type: boolean description: Indicador se a transportadora está ativa no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM paymentTerms: type: object required: – token 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: Descritivo do grupo de empresa company: #/definitions/recordCompany active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM opportunityType: type: object required: – token properties: id: type: integer description: Código de identificação do CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Descritivo do grupo de empresa companyBranch: #/definitions/recordCompanyBranch active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema note: type: string description: Observações customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM paymentType: type: object required: – token properties: id: type: integer description: Código de identificação do CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Descritivo do grupo de empresa companyBranch: #/definitions/recordCompanyBranch active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM deposit: type: object required: – token properties: id: type: integer description: Código de identificação do CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Descritivo do grupo de empresa companyBranch: #/definitions/recordCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM product: type: object required: – token properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recordCompany name: type: string description: Descritivo do grupo de empresa partNumber: type: string description: Identificador do produto no sistema terceiro derivationPartNumber: type: string description: Identificador da derivação do produto no sistema terceiro derivationName: type: string description: Descritivo da derivação do produto productCategory: #/definitions/recordProductCategory unitMeasurement: #/definitions/recordUnitMeasurement active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo salePrice: type: number description: Valor de venda do produto format: double maximumDiscount: type: number description: Desconto percentual unitário máximo format: double defaultQuantity: type: number description: Quantidade padrão do produto no pedido format: double correctionFactor: type: number description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão format: double saleType: type: integer description: Informativo do tipo de venda padrão para o produto ipi: type: number description: Porcentagem de IPI, somente descritivo format: double icms: type: number description: Porcentagem de ICMS, somente descritivo format: double weight: type: number description: Peso unitário do produto format: double note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma token: type: string description: Token de identificação do CRM recordProductCategory: type: object properties: id: type: integer description: Código de identificação da categoria de produto no CRM idErp: type: string description: Código de identificação da categoria de produto no sistema terceiro recordUnitMeasurement: type: object properties: id: type: integer description: Código de identificação da unidade de medida no CRM acronym: type: string description: Sigla que identifica a unidade de medida service: type: object required: – serviceCategory – token properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recordCompany partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do grupo de empresa serviceCategory: #/definitions/recordServiceCategory unitMeasurement: #/definitions/recordUnitMeasurement active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo salePrice: type: number description: Valor de venda do produto format: double maximumDiscount: type: number description: Desconto percentual unitário máximo format: double note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma token: type: string description: Token de identificação do CRM recordServiceCategory: type: object properties: id: type: integer description: Código de identificação da categoria de produto no CRM idErp: type: string description: Código de identificação da categoria de produto no sistema terceiro opportunity: type: object required: – token properties: id: type: integer description: Código de identificação no CRM companyBranch: #/definitions/recordCompanyBranch account: #/definitions/recordBasicAccount contact: #/definitions/recordContact opportunityName: type: string description: Nome da oportunidade opportunityType: #/definitions/recordOpportunityType opportunitySubtype: #/definitions/recordOpportunitySubtype businessType: #/definitions/recordBusinessType dateTime: type: string description: Data e hora da criação da abertura da oportunidade format: date-time opportunityOrigin: #/definitions/recordOpportunityOrigin responsible: #/definitions/recordResponsible negotiationStage: #/definitions/recordNegotiationStage lossReason: #/definitions/recordLossReason salesReasons: #/definitions/recordSalesReasons 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 effectiveDeliveryDate: type: string description: Data efetiva 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 token: type: string description: Token de identificação do CRM recordContact: 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 recordOpportunityType: 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 recordOpportunitySubtype: type: object properties: id: type: integer description: Código de identificação no CRM recordBusinessType: type: object properties: id: type: integer description: Código de identificação no CRM recordOpportunityOrigin: type: object properties: id: type: integer description: Código de identificação no CRM recordResponsible: 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 recordNegotiationStage: type: object properties: stage: type: integer description: Estágio recordLossReason: type: object properties: id: type: integer description: Código de identificação no CRM recordSalesReasons: type: object properties: id: type: integer description: Código de identificação no CRM opportunityProposal: type: object required: – token properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recordOpportunity dateTime: type: string description: Data e hora da criação da abertura da oportunidade format: date-time 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/recordTemplate languageLayout: type: integer description: Idioma do layout de proposta issuer: #/definitions/recordIssuer proposalStatus: type: integer description: Status da proposta paymentTerm: #/definitions/recordPaymentTerm 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 zonaFranca: type: string description: Valor ou porcentagem de ZONA FRANCA da proposta carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch 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 token: type: string description: Token de identificação do CRM recordOpportunity: 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 recordTemplate: type: object properties: id: type: integer description: Código de identificação no CRM recordIssuer: 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 opportunityProduct: type: object required: – token properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recordOpportunity proposal: #/definitions/recordProposal sequenceErp: type: integer description: Sequencial do produto no pedido product: #/definitions/recordProduct quantity: type: number description: Quantidade do produto na proposta format: double deposit: #/definitions/recordDeposit priceTable: #/definitions/recordPriceTable saleType: type: integer description: Tipo de venda saleValue: type: number description: Valor da vensa 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: Percential 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 token: type: string description: Token de identificação do CRM recordProposal: 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 recordProduct: type: object required: – productDerivationCode 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 recordDeposit: 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 opportunityService: type: object required: – token properties: id: type: integer description: Código de identificação no CRM opportunity: #/definitions/recordOpportunity proposal: #/definitions/recordProposal sequenceErp: type: integer description: Sequencial do produto no pedido service: #/definitions/recordService quantity: type: number description: Quantidade do produto na proposta format: double priceTable: #/definitions/recordPriceTable saleValue: type: number description: Valor da vensa do produto na proposta format: double discountValue: type: number description: Valor de desconto do produto format: double discountPercentage: type: number description: Percential 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 token: type: string description: Token de identificação do CRM recordService: type: object properties: id: type: integer description: Código de identificação no CRM serviceCode: type: string description: Código de identificação no sistema terceiro 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