crm

2.0info: 1.4.0 Cadastros básicos description: Serviço responsável pelos cadastros básicos do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: basic_records contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/basic_records/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: /activityBranchesCreated: post: description: Evento de ramo de atividade criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: #/definitions/recordActivityBranches responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyGroupsCreated: post: description: Evento de grupo de empresa criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: #/definitions/recordCompanyGroups responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /priceTableCreated: post: description: Evento de tabela de preço criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: #/definitions/recordPriceTable responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /carrierCreated: post: description: Evento de transportadora criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – carrier properties: carrier: #/definitions/recordCarrier responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentTermsCreated: post: description: Evento de prazo de pagamento criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: #/definitions/recordPaymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityTypeCreated: post: description: Evento de tipo de oportunidade criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: #/definitions/recordOpportunityType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentTypeCreated: post: description: Evento de tipo de pagamento criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: #/definitions/recordPaymentType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /depositCreated: post: description: Evento de depósito criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – deposit properties: deposit: #/definitions/recordDeposit responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productCreated: post: description: Evento de produto criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – product properties: product: #/definitions/recordProduct responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceCreated: post: description: Evento de serviço criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – service properties: service: #/definitions/recordService responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /activityBranchesUpdated: post: description: Evento de ramo de atividade atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: #/definitions/recordActivityBranches responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyGroupsUpdated: post: description: Evento de grupo de empresa atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: #/definitions/recordCompanyGroups responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /priceTableUpdated: post: description: Evento de tabela de preço atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: #/definitions/recordPriceTable responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /carrierUpdated: post: description: Evento de transportadora atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – carrier properties: carrier: #/definitions/recordCarrier responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentTermsUpdated: post: description: Evento de prazo de pagamento atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: #/definitions/recordPaymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /opportunityTypeUpdated: post: description: Evento de tipo de oportunidade atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: #/definitions/recordOpportunityType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentTypeUpdated: post: description: Evento de tipo de pagamento atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: #/definitions/recordPaymentType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /depositUpdated: post: description: Evento de depósito atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – deposit properties: deposit: #/definitions/recordDeposit responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productUpdated: post: description: Evento de produto atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – product properties: product: #/definitions/recordProduct responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceUpdated: post: description: Evento de serviço atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – service properties: service: #/definitions/recordService responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/deposit: post: description: This entity is customizable. tags: – Entities parameters: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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/countries: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: The created resource schema: #/definitions/countries default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: The created resource schema: #/definitions/countries default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/countries default: description: Error response schema: #/definitions/genericError /entities/countries/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: Ok schema: #/definitions/countries default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: Ok schema: #/definitions/countries default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countries default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/countries/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/countries 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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/accountType: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: The created resource schema: #/definitions/accountType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: The created resource schema: #/definitions/accountType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountType default: description: Error response schema: #/definitions/genericError /entities/accountType/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: Ok schema: #/definitions/accountType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: Ok schema: #/definitions/accountType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountType default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountType/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/states: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/states responses: 200: description: The created resource schema: #/definitions/states default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/states responses: 200: description: The created resource schema: #/definitions/states default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/states default: description: Error response schema: #/definitions/genericError /entities/states/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/states responses: 200: description: Ok schema: #/definitions/states default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/states responses: 200: description: Ok schema: #/definitions/states default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/states default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/states/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/states 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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/activityBranches: post: description: This entity is customizable. tags: – Entities parameters: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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/paymentType: post: description: This entity is customizable. tags: – Entities parameters: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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/cities: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: The created resource schema: #/definitions/cities default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: The created resource schema: #/definitions/cities default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/cities default: description: Error response schema: #/definitions/genericError /entities/cities/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: Ok schema: #/definitions/cities default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: Ok schema: #/definitions/cities default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cities default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cities/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cities 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: – 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: recordActivityBranches: 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: 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 recordCompanyGroups: 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: Descritivo do grupo de empresa company: #/definitions/recCompany active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema customFields: type: string description: Campos customizados recCompany: 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 recordPriceTable: 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: Descritivo do grupo de empresa companyBranch: #/definitions/recCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados recCompanyBranch: type: object properties: id: type: integer description: Código de identificação no CRM companyErp: type: string description: Código de identificação da empresa no sistema terceiro branchErp: type: string description: Código de identificação da filial no sistema terceiro recordCarrier: 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: Descritivo do grupo de empresa companyBranch: #/definitions/recCompanyBranch active: type: boolean description: Indicador se a transportadora está ativa no sistema customFields: type: string description: Campos customizados recordPaymentTerms: 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: Descritivo do grupo de empresa company: #/definitions/recCompany active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema customFields: type: string description: Campos customizados recordOpportunityType: type: object 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/recCompanyBranch 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 recordPaymentType: type: object 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/recCompanyBranch active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema customFields: type: string description: Campos customizados recordDeposit: type: object 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/recCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados recordProduct: type: object properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recCompany 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/recProductCategory unitMeasurement: #/definitions/recUnitMeasurement 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 recProductCategory: 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 recUnitMeasurement: 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 recordService: type: object required: – serviceCategory properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recCompany partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do grupo de empresa serviceCategory: #/definitions/recServiceCategory unitMeasurement: #/definitions/recUnitMeasurement 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 recServiceCategory: 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 activityBranches: 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: 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 companyGroups: 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: Descritivo do grupo de empresa company: #/definitions/recCompany active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema customFields: type: string description: Campos customizados priceTable: 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: Descritivo do grupo de empresa companyBranch: #/definitions/recCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados carrier: 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: Descritivo do grupo de empresa companyBranch: #/definitions/recCompanyBranch active: type: boolean description: Indicador se a transportadora está ativa no sistema customFields: type: string description: Campos customizados paymentTerms: 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: Descritivo do grupo de empresa company: #/definitions/recCompany active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema customFields: type: string description: Campos customizados opportunityType: type: object 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/recCompanyBranch 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 paymentType: type: object 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/recCompanyBranch active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema customFields: type: string description: Campos customizados deposit: type: object 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/recCompanyBranch active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados product: type: object properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recCompany 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/recProductCategory unitMeasurement: #/definitions/recUnitMeasurement 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 service: type: object required: – serviceCategory properties: id: type: integer description: Código de identificação do CRM company: #/definitions/recCompany partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do grupo de empresa serviceCategory: #/definitions/recServiceCategory unitMeasurement: #/definitions/recUnitMeasurement 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 accountType: type: object required: – name – active – icon – color properties: id: type: integer description: Código de identificação do CRM name: type: string description: Nome active: type: boolean description: Indicador se o registro está ativo icon: type: string description: Ícone que será exibido color: type: string description: Cor do ícone que será exibido customFields: type: string description: Campos customizados cities: type: object required: – name – active – state – country properties: id: type: integer description: Código de identificação ibgeCode: type: integer description: Código IBGE name: type: string description: Nome active: type: boolean description: Indicador se o registro está ativo dddCode: type: integer description: Código DDD population: type: integer description: População estimatedPopulation: type: integer description: População estimada consumptionPotencial: type: number description: Potêncial de consumo format: double pib: type: number description: PIB format: double customFields: type: string description: Campos customizados state: #/definitions/recordState country: #/definitions/recordCountry recordState: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome initials: type: string description: Iniciais recordCountry: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome states: type: object required: – country – name – active – initials properties: id: type: integer description: Código de identificação country: #/definitions/recordCountry name: type: string description: Nome active: type: boolean description: Indicador se o registro está ativo initials: type: string description: Iniciais customFields: type: string description: Campos customizados countries: type: object required: – name – active properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Indicador se o registro está ativo customFields: type: string description: Campos customizados 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