crm

2.0info: 3.1.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_recordssecurityDefinitions: 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: /uploadFile: post: description: Faz o upload de um arquivo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: id: type: integer description: IDs dos arquivos default: description: Error response schema: #/definitions/genericError /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/activityBranchesRecord 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/companyGroupsRecord 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/priceTableRecord 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/carrierRecord 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/paymentTermsRecord 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/opportunityTypeRecord 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/paymentTypeRecord 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/depositRecord 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/productRecord 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/serviceRecord 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/activityBranchesRecord 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/companyGroupsRecord 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/priceTableRecord 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/carrierRecord 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/paymentTermsRecord 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/opportunityTypeRecord 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/paymentTypeRecord 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/depositRecord 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/productRecord 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/serviceRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/occurrenceSubtype: post: description: The create request primitive for the occurrenceSubtype facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/occurrenceSubtypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the occurrenceSubtype facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/occurrenceSubtypeFacade default: description: Error response schema: #/definitions/genericError /apis/occurrenceSubtype/{id}: put: description: The update request primitive for the occurrenceSubtype facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceSubtypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the occurrenceSubtype facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the occurrenceSubtype facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/occurrenceOrigin: post: description: The create request primitive for the occurrenceOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/occurrenceOriginFacade responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the occurrenceOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/occurrenceOriginFacade default: description: Error response schema: #/definitions/genericError /apis/occurrenceOrigin/{id}: put: description: The update request primitive for the occurrenceOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceOriginFacade responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the occurrenceOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the occurrenceOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/accountType: post: description: The create request primitive for the accountType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/accountTypeFacade responses: 200: description: Ok schema: #/definitions/accountTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the accountType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/accountTypeFacade default: description: Error response schema: #/definitions/genericError /apis/accountType/{id}: put: description: The update request primitive for the accountType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountTypeFacade responses: 200: description: Ok schema: #/definitions/accountTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the accountType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the accountType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/regions: post: description: The create request primitive for the regions facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/regionsFacade responses: 200: description: Ok schema: #/definitions/regionsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the regions facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/regionsFacade default: description: Error response schema: #/definitions/genericError /apis/regions/{id}: put: description: The update request primitive for the regions facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/regionsFacade responses: 200: description: Ok schema: #/definitions/regionsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the regions facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/regionsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the regions facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/cities: post: description: The create request primitive for the cities facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/citiesFacade responses: 200: description: Ok schema: #/definitions/citiesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the cities facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/citiesFacade default: description: Error response schema: #/definitions/genericError /apis/cities/{id}: put: description: The update request primitive for the cities facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/citiesFacade responses: 200: description: Ok schema: #/definitions/citiesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the cities facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/citiesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the cities facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/ratings: post: description: The create request primitive for the ratings facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/ratingsFacade responses: 200: description: Ok schema: #/definitions/ratingsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the ratings facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/ratingsFacade default: description: Error response schema: #/definitions/genericError /apis/ratings/{id}: put: description: The update request primitive for the ratings facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/ratingsFacade responses: 200: description: Ok schema: #/definitions/ratingsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the ratings facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ratingsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the ratings facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/branch: post: description: The create request primitive for the branch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/branchFacade responses: 200: description: Ok schema: #/definitions/branchFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the branch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/branchFacade default: description: Error response schema: #/definitions/genericError /apis/branch/{id}: put: description: The update request primitive for the branch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/branchFacade responses: 200: description: Ok schema: #/definitions/branchFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the branch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the branch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/companyBranch: post: description: The create request primitive for the companyBranch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companyBranchFacade responses: 200: description: Ok schema: #/definitions/companyBranchFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the companyBranch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companyBranchFacade default: description: Error response schema: #/definitions/genericError /apis/companyBranch/{id}: put: description: The update request primitive for the companyBranch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyBranchFacade responses: 200: description: Ok schema: #/definitions/companyBranchFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the companyBranch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyBranchFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the companyBranch facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/occurrenceType: post: description: The create request primitive for the occurrenceType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/occurrenceTypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the occurrenceType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/occurrenceTypeFacade default: description: Error response schema: #/definitions/genericError /apis/occurrenceType/{id}: put: description: The update request primitive for the occurrenceType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceTypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the occurrenceType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the occurrenceType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/product: post: description: The create request primitive for the product facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/productFacade responses: 200: description: Ok schema: #/definitions/productFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the product facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/productFacade default: description: Error response schema: #/definitions/genericError /apis/product/{id}: put: description: The update request primitive for the product facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productFacade responses: 200: description: Ok schema: #/definitions/productFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the product facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the product facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/user: post: description: The create request primitive for the user facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/userFacade responses: 200: description: Ok schema: #/definitions/userFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the user facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/userFacade default: description: Error response schema: #/definitions/genericError /apis/user/{id}: put: description: The update request primitive for the user facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/userFacade responses: 200: description: Ok schema: #/definitions/userFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the user facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the user facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/companyGroups: post: description: The create request primitive for the companyGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companyGroupsFacade responses: 200: description: Ok schema: #/definitions/companyGroupsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the companyGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companyGroupsFacade default: description: Error response schema: #/definitions/genericError /apis/companyGroups/{id}: put: description: The update request primitive for the companyGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyGroupsFacade responses: 200: description: Ok schema: #/definitions/companyGroupsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the companyGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyGroupsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the companyGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/inactivationReason: post: description: The create request primitive for the inactivationReason facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/inactivationReasonFacade responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the inactivationReason facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/inactivationReasonFacade default: description: Error response schema: #/definitions/genericError /apis/inactivationReason/{id}: put: description: The update request primitive for the inactivationReason facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/inactivationReasonFacade responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the inactivationReason facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the inactivationReason facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityTypeProduct: post: description: The create request primitive for the opportunityTypeProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityTypeProductFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityTypeProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityTypeProductFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityTypeProduct/{id}: put: description: The update request primitive for the opportunityTypeProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityTypeProductFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityTypeProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityTypeProduct facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/measurementUnit: post: description: The create request primitive for the measurementUnit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/measurementUnitFacade responses: 200: description: Ok schema: #/definitions/measurementUnitFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the measurementUnit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/measurementUnitFacade default: description: Error response schema: #/definitions/genericError /apis/measurementUnit/{id}: put: description: The update request primitive for the measurementUnit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/measurementUnitFacade responses: 200: description: Ok schema: #/definitions/measurementUnitFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the measurementUnit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/measurementUnitFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the measurementUnit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/productCategories: post: description: The create request primitive for the productCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/productCategoriesFacade responses: 200: description: Ok schema: #/definitions/productCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the productCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/productCategoriesFacade default: description: Error response schema: #/definitions/genericError /apis/productCategories/{id}: put: description: The update request primitive for the productCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productCategoriesFacade responses: 200: description: Ok schema: #/definitions/productCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the productCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productCategoriesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the productCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/actionType: post: description: The create request primitive for the actionType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/actionTypeFacade responses: 200: description: Ok schema: #/definitions/actionTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the actionType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/actionTypeFacade default: description: Error response schema: #/definitions/genericError /apis/actionType/{id}: put: description: The update request primitive for the actionType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/actionTypeFacade responses: 200: description: Ok schema: #/definitions/actionTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the actionType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/actionTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the actionType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/activityBranches: post: description: The create request primitive for the activityBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/activityBranchesFacade responses: 200: description: Ok schema: #/definitions/activityBranchesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the activityBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/activityBranchesFacade default: description: Error response schema: #/definitions/genericError /apis/activityBranches/{id}: put: description: The update request primitive for the activityBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/activityBranchesFacade responses: 200: description: Ok schema: #/definitions/activityBranchesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the activityBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/activityBranchesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the activityBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/addressTypes: post: description: The create request primitive for the addressTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/addressTypesFacade responses: 200: description: Ok schema: #/definitions/addressTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the addressTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/addressTypesFacade default: description: Error response schema: #/definitions/genericError /apis/addressTypes/{id}: put: description: The update request primitive for the addressTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/addressTypesFacade responses: 200: description: Ok schema: #/definitions/addressTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the addressTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/addressTypesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the addressTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/interestAreas: post: description: The create request primitive for the interestAreas facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/interestAreasFacade responses: 200: description: Ok schema: #/definitions/interestAreasFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the interestAreas facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/interestAreasFacade default: description: Error response schema: #/definitions/genericError /apis/interestAreas/{id}: put: description: The update request primitive for the interestAreas facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/interestAreasFacade responses: 200: description: Ok schema: #/definitions/interestAreasFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the interestAreas facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/interestAreasFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the interestAreas facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/eventTypes: post: description: The create request primitive for the eventTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/eventTypesFacade responses: 200: description: Ok schema: #/definitions/eventTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the eventTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/eventTypesFacade default: description: Error response schema: #/definitions/genericError /apis/eventTypes/{id}: put: description: The update request primitive for the eventTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/eventTypesFacade responses: 200: description: Ok schema: #/definitions/eventTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the eventTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventTypesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the eventTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/locations: post: description: The create request primitive for the locations facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/locationsFacade responses: 200: description: Ok schema: #/definitions/locationsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the locations facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/locationsFacade default: description: Error response schema: #/definitions/genericError /apis/locations/{id}: put: description: The update request primitive for the locations facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/locationsFacade responses: 200: description: Ok schema: #/definitions/locationsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the locations facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/locationsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the locations facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/accountStatus: post: description: The create request primitive for the accountStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/accountStatusFacade responses: 200: description: Ok schema: #/definitions/accountStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the accountStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/accountStatusFacade default: description: Error response schema: #/definitions/genericError /apis/accountStatus/{id}: put: description: The update request primitive for the accountStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountStatusFacade responses: 200: description: Ok schema: #/definitions/accountStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the accountStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountStatusFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the accountStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/serviceCategories: post: description: The create request primitive for the serviceCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/serviceCategoriesFacade responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the serviceCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/serviceCategoriesFacade default: description: Error response schema: #/definitions/genericError /apis/serviceCategories/{id}: put: description: The update request primitive for the serviceCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/serviceCategoriesFacade responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the serviceCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the serviceCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/eventsStatus: post: description: The create request primitive for the eventsStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/eventsStatusFacade responses: 200: description: Ok schema: #/definitions/eventsStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the eventsStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/eventsStatusFacade default: description: Error response schema: #/definitions/genericError /apis/eventsStatus/{id}: put: description: The update request primitive for the eventsStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/eventsStatusFacade responses: 200: description: Ok schema: #/definitions/eventsStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the eventsStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventsStatusFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the eventsStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityType: post: description: The create request primitive for the opportunityType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityTypeFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityTypeFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityType/{id}: put: description: The update request primitive for the opportunityType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityTypeFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/company: post: description: The create request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError /apis/company/{id}: put: description: The update request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/characteristics: post: description: The create request primitive for the characteristics facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/characteristicsFacade responses: 200: description: Ok schema: #/definitions/characteristicsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the characteristics facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/characteristicsFacade default: description: Error response schema: #/definitions/genericError /apis/characteristics/{id}: put: description: The update request primitive for the characteristics facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/characteristicsFacade responses: 200: description: Ok schema: #/definitions/characteristicsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the characteristics facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/characteristicsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the characteristics facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/paymentType: post: description: The create request primitive for the paymentType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/paymentTypeFacade responses: 200: description: Ok schema: #/definitions/paymentTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the paymentType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/paymentTypeFacade default: description: Error response schema: #/definitions/genericError /apis/paymentType/{id}: put: description: The update request primitive for the paymentType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/paymentTypeFacade responses: 200: description: Ok schema: #/definitions/paymentTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the paymentType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the paymentType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/department: post: description: The create request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError /apis/department/{id}: put: description: The update request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/opportunityOrigins: post: description: The create request primitive for the opportunityOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/opportunityOriginsFacade responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the opportunityOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/opportunityOriginsFacade default: description: Error response schema: #/definitions/genericError /apis/opportunityOrigins/{id}: put: description: The update request primitive for the opportunityOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityOriginsFacade responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the opportunityOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the opportunityOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/function: post: description: The create request primitive for the function facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/functionFacade responses: 200: description: Ok schema: #/definitions/functionFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the function facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/functionFacade default: description: Error response schema: #/definitions/genericError /apis/function/{id}: put: description: The update request primitive for the function facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/functionFacade responses: 200: description: Ok schema: #/definitions/functionFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the function facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/functionFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the function facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/appointmentCategories: post: description: The create request primitive for the appointmentCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/appointmentCategoriesFacade responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the appointmentCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/appointmentCategoriesFacade default: description: Error response schema: #/definitions/genericError /apis/appointmentCategories/{id}: put: description: The update request primitive for the appointmentCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/appointmentCategoriesFacade responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the appointmentCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the appointmentCategories facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/contactOrigin: post: description: The create request primitive for the contactOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/contactOriginFacade responses: 200: description: Ok schema: #/definitions/contactOriginFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the contactOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/contactOriginFacade default: description: Error response schema: #/definitions/genericError /apis/contactOrigin/{id}: put: description: The update request primitive for the contactOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/contactOriginFacade responses: 200: description: Ok schema: #/definitions/contactOriginFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the contactOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contactOriginFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the contactOrigin facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/states: post: description: The create request primitive for the states facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/statesFacade responses: 200: description: Ok schema: #/definitions/statesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the states facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/statesFacade default: description: Error response schema: #/definitions/genericError /apis/states/{id}: put: description: The update request primitive for the states facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/statesFacade responses: 200: description: Ok schema: #/definitions/statesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the states facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/statesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the states facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/lossReasons: post: description: The create request primitive for the lossReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/lossReasonsFacade responses: 200: description: Ok schema: #/definitions/lossReasonsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the lossReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/lossReasonsFacade default: description: Error response schema: #/definitions/genericError /apis/lossReasons/{id}: put: description: The update request primitive for the lossReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/lossReasonsFacade responses: 200: description: Ok schema: #/definitions/lossReasonsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the lossReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lossReasonsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the lossReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/paymentTerms: post: description: The create request primitive for the paymentTerms facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/paymentTermsFacade responses: 200: description: Ok schema: #/definitions/paymentTermsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the paymentTerms facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/paymentTermsFacade default: description: Error response schema: #/definitions/genericError /apis/paymentTerms/{id}: put: description: The update request primitive for the paymentTerms facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/paymentTermsFacade responses: 200: description: Ok schema: #/definitions/paymentTermsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the paymentTerms facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTermsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the paymentTerms facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/priceTable: post: description: The create request primitive for the priceTable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/priceTableFacade responses: 200: description: Ok schema: #/definitions/priceTableFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the priceTable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/priceTableFacade default: description: Error response schema: #/definitions/genericError /apis/priceTable/{id}: put: description: The update request primitive for the priceTable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/priceTableFacade responses: 200: description: Ok schema: #/definitions/priceTableFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the priceTable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/priceTableFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the priceTable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/characteristicsHierarchy: post: description: The create request primitive for the characteristicsHierarchy facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/characteristicsHierarchyFacade responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the characteristicsHierarchy facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/characteristicsHierarchyFacade default: description: Error response schema: #/definitions/genericError /apis/characteristicsHierarchy/{id}: put: description: The update request primitive for the characteristicsHierarchy facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/characteristicsHierarchyFacade responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the characteristicsHierarchy facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the characteristicsHierarchy facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/personType: post: description: The create request primitive for the personType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/personTypeFacade responses: 200: description: Ok schema: #/definitions/personTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the personType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/personTypeFacade default: description: Error response schema: #/definitions/genericError /apis/personType/{id}: put: description: The update request primitive for the personType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/personTypeFacade responses: 200: description: Ok schema: #/definitions/personTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the personType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the personType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/occurrenceStatus: post: description: The create request primitive for the occurrenceStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/occurrenceStatusFacade responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the occurrenceStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/occurrenceStatusFacade default: description: Error response schema: #/definitions/genericError /apis/occurrenceStatus/{id}: put: description: The update request primitive for the occurrenceStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceStatusFacade responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the occurrenceStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the occurrenceStatus facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/deposit: post: description: The create request primitive for the deposit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/depositFacade responses: 200: description: Ok schema: #/definitions/depositFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the deposit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/depositFacade default: description: Error response schema: #/definitions/genericError /apis/deposit/{id}: put: description: The update request primitive for the deposit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/depositFacade responses: 200: description: Ok schema: #/definitions/depositFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the deposit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/depositFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the deposit facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/businessTypes: post: description: The create request primitive for the businessTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/businessTypesFacade responses: 200: description: Ok schema: #/definitions/businessTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the businessTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/businessTypesFacade default: description: Error response schema: #/definitions/genericError /apis/businessTypes/{id}: put: description: The update request primitive for the businessTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/businessTypesFacade responses: 200: description: Ok schema: #/definitions/businessTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the businessTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/businessTypesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the businessTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/carrier: post: description: The create request primitive for the carrier facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/carrierFacade responses: 200: description: Ok schema: #/definitions/carrierFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the carrier facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/carrierFacade default: description: Error response schema: #/definitions/genericError /apis/carrier/{id}: put: description: The update request primitive for the carrier facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/carrierFacade responses: 200: description: Ok schema: #/definitions/carrierFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the carrier facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/carrierFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the carrier facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/followType: post: description: The create request primitive for the followType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/followTypeFacade responses: 200: description: Ok schema: #/definitions/followTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the followType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/followTypeFacade default: description: Error response schema: #/definitions/genericError /apis/followType/{id}: put: description: The update request primitive for the followType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/followTypeFacade responses: 200: description: Ok schema: #/definitions/followTypeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the followType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/followTypeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the followType facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/service: post: description: The create request primitive for the service facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/serviceFacade responses: 200: description: Ok schema: #/definitions/serviceFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the service facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/serviceFacade default: description: Error response schema: #/definitions/genericError /apis/service/{id}: put: description: The update request primitive for the service facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/serviceFacade responses: 200: description: Ok schema: #/definitions/serviceFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the service facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the service facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/regionCity: post: description: The create request primitive for the regionCity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/regionCityFacade responses: 200: description: Ok schema: #/definitions/regionCityFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the regionCity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/regionCityFacade default: description: Error response schema: #/definitions/genericError /apis/regionCity/{id}: put: description: The update request primitive for the regionCity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/regionCityFacade responses: 200: description: Ok schema: #/definitions/regionCityFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the regionCity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/regionCityFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the regionCity facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/accountOrigins: post: description: The create request primitive for the accountOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/accountOriginsFacade responses: 200: description: Ok schema: #/definitions/accountOriginsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the accountOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/accountOriginsFacade default: description: Error response schema: #/definitions/genericError /apis/accountOrigins/{id}: put: description: The update request primitive for the accountOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountOriginsFacade responses: 200: description: Ok schema: #/definitions/accountOriginsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the accountOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountOriginsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the accountOrigins facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/salesReasons: post: description: The create request primitive for the salesReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/salesReasonsFacade responses: 200: description: Ok schema: #/definitions/salesReasonsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the salesReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/salesReasonsFacade default: description: Error response schema: #/definitions/genericError /apis/salesReasons/{id}: put: description: The update request primitive for the salesReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/salesReasonsFacade responses: 200: description: Ok schema: #/definitions/salesReasonsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the salesReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salesReasonsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the salesReasons facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/relationshipTypes: post: description: The create request primitive for the relationshipTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/relationshipTypesFacade responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the relationshipTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/relationshipTypesFacade default: description: Error response schema: #/definitions/genericError /apis/relationshipTypes/{id}: put: description: The update request primitive for the relationshipTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/relationshipTypesFacade responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the relationshipTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the relationshipTypes facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/userGroups: post: description: The create request primitive for the userGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/userGroupsFacade responses: 200: description: Ok schema: #/definitions/userGroupsFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the userGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/userGroupsFacade default: description: Error response schema: #/definitions/genericError /apis/userGroups/{id}: put: description: The update request primitive for the userGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/userGroupsFacade responses: 200: description: Ok schema: #/definitions/userGroupsFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the userGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userGroupsFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the userGroups facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/countries: post: description: The create request primitive for the countries facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/countriesFacade responses: 200: description: Ok schema: #/definitions/countriesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the countries facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/countriesFacade default: description: Error response schema: #/definitions/genericError /apis/countries/{id}: put: description: The update request primitive for the countries facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/countriesFacade responses: 200: description: Ok schema: #/definitions/countriesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the countries facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countriesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the countries facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/companySize: post: description: The create request primitive for the companySize facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companySizeFacade responses: 200: description: Ok schema: #/definitions/companySizeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the companySize facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companySizeFacade default: description: Error response schema: #/definitions/genericError /apis/companySize/{id}: put: description: The update request primitive for the companySize facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companySizeFacade responses: 200: description: Ok schema: #/definitions/companySizeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the companySize facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companySizeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the companySize facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: activityBranchesRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador 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 format: byte companyGroupsRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do grupo de empresa company: #/definitions/companyRecord active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema customFields: type: string description: Campos customizados format: byte companyRecord: type: object properties: id: type: integer description: Id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ nit: type: string description: NIT priceTableRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da tabela de preços companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Indicador se a tabela de preço está ativa no sistema customFields: type: string description: Campos customizados format: byte companyBranchRecord: type: object properties: id: type: integer description: Identificador company: #/definitions/companyRecord branch: #/definitions/branchRecord branchRecord: type: object properties: id: type: integer description: Id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ headquarters: type: integer description: Matriz stateRegistration: type: string description: Inscrição Estadual municipalRegistration: type: string description: Inscrição Municipal email: type: string description: Email telephone: type: string description: Telefone nit: type: string description: NIT carrierRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da transportadora companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Indicador se a transportadora está ativa no sistema customFields: type: string description: Campos customizados format: byte paymentTermsRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do prazo de pagamento company: #/definitions/companyRecord active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema customFields: type: string description: Campos customizados format: byte opportunityTypeRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de oportunidade companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema note: type: string description: Observação customFields: type: string description: Campos customizados format: byte paymentTypeRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de pagamento companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema customFields: type: string description: Campos customizados format: byte depositRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do depósito companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Indicador se o depósito está ativa no sistema customFields: type: string description: Campos customizados format: byte productRecord: type: object properties: id: type: integer description: Identificador company: #/definitions/companyRecord name: type: string description: Descritivo do produto 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/productCategoryRecord unitMeasurement: #/definitions/unitMeasurementRecord 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: boolean 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 format: byte ncm: type: string description: NCM productCategoryRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord unitMeasurementRecord: type: object properties: id: type: integer description: Identificador name: type: string description: Nome acronym: type: string description: Sigla active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte serviceRecord: type: object required: – serviceCategory properties: id: type: integer description: Identificador company: #/definitions/companyRecord partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do serviço serviceCategory: #/definitions/serviceCategoryRecord unitMeasurement: #/definitions/unitMeasurementRecord active: type: boolean description: Indicador se o serviço está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo salePrice: type: number description: Valor de venda do serviço 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 format: byte serviceCategoryRecord: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord activityBranchesFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord companyGroupsFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord priceTableFacade: type: object properties: id: type: integer description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se o registro está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord actionTypeFacade: type: object properties: id: type: integer description: ID no CRM companyBranch: #/definitions/companyBranchRecord name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Se o registro está ativo strategicAction: type: boolean description: Campo Ação Estratégica usesOpportunity: type: boolean description: Campo Usa Oportunidade usesOccurency: type: boolean description: Campo Usa Ocorrência usesContract: type: boolean description: Campo Usa Contract usesEvent: type: boolean description: Campo Usa Evento customFields: type: string description: Campos customizados format: byte carrierFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord paymentTermsFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo generateInstallments: type: boolean description: Gerar parcela quantityInstallments: type: integer description: Quantidade parcelas accrualInstallments: type: string description: Acréscimo Parcelas rounding: type: integer description: Arredondamento customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord opportunityTypeFacade: type: object properties: id: type: integer description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Se o registro está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord paymentTypeFacade: type: object properties: id: type: integer description: ID do CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome addedValue: type: number description: Valor do acréscimo format: double active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord depositFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord productFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome derivationName: type: string description: Nome derivado partNumber: type: string description: Identificador no sistema terceiro ncm: type: string description: NCM derivationPartNumber: type: string description: Identificador da derivação do produto no sistema terceiro active: type: boolean description: Indicador se ativo no sistema. salePrice: type: string description: Valor de venda maximumDiscount: type: string description: Desconto percentual unitário máximo defaultQuantity: type: string description: Quantidade padrão do produto no pedido correctionFactor: type: string description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão saleType: type: boolean description: É do tipo venda ipi: type: string description: Porcentagem de IPI icms: type: string description: Porcentagem de ICMS weight: type: string description: Peso unitário coinId: type: integer description: Moeda Id rate: type: string description: Taxa note: type: string description: Obervações origin: type: string description: Origem customFields: type: string description: Campos customizados format: byte unitMeasurement: #/definitions/unitMeasurementRecord productCategory: #/definitions/productCategoryRecord company: #/definitions/companyRecord photo: #/definitions/crmFile file: #/definitions/crmFile crmFile: type: object properties: id: type: integer description: ID companyBranch: #/definitions/companyBranchRecord uploadType: type: integer description: Tipo de upload fileName: type: string description: Nome do arquivo folder: type: string description: Pasta destination: type: string description: Destino size: type: number description: Tamanho format: double fieldName: type: string description: Nome do campo hash: type: string description: Hash serviceFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome partNumber: type: string description: Identificador no sistema terceiro ncm: type: string description: NCM active: type: boolean description: Ativo salePrice: type: number description: Valor de venda format: double note: type: string description: Obervação maximumDiscount: type: number description: Desconto percentual unitário máximo format: double customFields: type: string description: Campos customizados format: byte serviceCategory: #/definitions/serviceCategoryRecord unitMeasurement: #/definitions/unitMeasurementRecord company: #/definitions/companyRecord accountTypeFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo icon: type: string description: Ícone color: type: string description: Cor do ícone requiredFields: type: string description: Campos obrigatórios customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord citiesFacade: type: object properties: id: type: integer description: Identificador ibgeCode: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo dddCode: type: string description: Código DDD population: type: integer description: População estimatedPopulation: type: integer description: População estimada consumptionPotencial: type: number description: Potêncial de consumo format: double pib: type: number description: PIB format: double customFields: type: string description: Campos customizados format: byte state: #/definitions/stateRecord country: #/definitions/countryRecord idErp: type: string description: Id no sistema terceiro stateRecord: type: object properties: id: type: integer description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo country: #/definitions/countryRecord customFields: type: string description: Campos customizados format: byte idErp: type: string description: Id no sistema terceiro countryRecord: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte code: type: integer description: Código idErp: type: string description: Id no sistema terceiro statesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo country: #/definitions/countryRecord customFields: type: string description: Campos customizados format: byte idErp: type: string description: Id no sistema terceiro countriesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte code: type: integer description: Código idErp: type: string description: Id no sistema terceiro accountOriginsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Name active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord accountStatusFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: integer description: Ativo customFields: type: string description: Campos customizados format: byte icon: type: string description: Ícone idErp: type: string description: Id no sistema terceiro addressTypesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord appointmentCategoriesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte businessTypesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord companySizeFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte inactivationReasonFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord eventTypesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord eventsStatusFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo icon: type: string description: Ícone customFields: type: string description: Campos customizados format: byte interestAreasFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord locationsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: integer description: Ativo customFields: type: string description: Campos customizados format: byte address: #/definitions/addressRecord addressRecord: type: object properties: id: type: integer description: Identificador active: type: boolean description: Ativo name: type: string description: Nome address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cep: type: string description: Código postal Brasil latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double customFields: type: string description: Campos customizados format: byte type: #/definitions/addressTypeRecord companyBranch: #/definitions/companyBranchRecord city: #/definitions/cityRecord zipCode: type: string description: Código postal exterior addressTypeRecord: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord cityRecord: type: object properties: id: type: integer description: Identificador idIbge: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo dddCode: type: string description: Código DDD population: type: integer description: População estimatedPopulation: type: integer description: População estimada consumptionPotencial: type: number description: Potêncial de consumo format: double pib: type: number description: PIB format: double customFields: type: string description: Campos customizados format: byte state: #/definitions/stateRecord country: #/definitions/countryRecord idErp: type: string description: Id no sistema terceiro lossReasonsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord opportunityOriginsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord followTypeFacade: type: object properties: id: type: integer description: Id de identificação no CRM name: type: string description: Nome slaHours: type: integer description: Tempo em horas de SLA para finalização do Follow-Up active: type: boolean description: Ativo module: type: integer description: Módulo onde será exibido essa opção de follow. 1 – Oportunidade | 2 – Ocorrência | 3 – Contrato | 4 – Tarefa | 5 – Compromisso | 6 – Evento customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord productCategoriesFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord ratingsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte regionsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: integer description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord salesReasonsFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord relationshipTypesFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte serviceCategoriesFacade: type: object properties: id: type: integer description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord measurementUnitFacade: type: object properties: id: type: integer description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte userGroupsFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord idErp: type: string description: ID no sistema terceiro userFacade: type: object properties: id: type: integer description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função type: type: integer description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string description: Aniversário format: date-time active: type: boolean description: Ativo visibleCombo: type: boolean description: Se o combo é visível language: type: integer description: Idioma legacyId: type: integer description: ID no legado department: #/definitions/departmentRecord function: #/definitions/functionRecord subordinateOf: #/definitions/userRecord userCompanyBranches: type: array items: #/definitions/userCompanyBranchRecord description: Empresa filial ids: type: array items: #/definitions/idRecord description: IDs groups: type: array items: #/definitions/userGroupRecord description: Grupos departmentRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa ocorrência customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord functionRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte idErp: type: string description: Id no sistema terceiro company: #/definitions/companyRecord userRecord: type: object properties: id: type: integer description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função type: type: integer description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string description: Aniversário format: date-time active: type: boolean description: Ativo visibleCombo: type: boolean description: Se o combo é visível language: type: integer description: Idioma legacyId: type: integer description: ID no legado department: #/definitions/departmentRecord function: #/definitions/functionRecord subordinateOf: #/definitions/userRecord userCompanyBranches: type: array items: #/definitions/userCompanyBranchRecord description: Empresa/filiais do usuário ids: type: array items: #/definitions/idRecord description: IDs groups: type: array items: #/definitions/userGroupRecord description: Grupos userCompanyBranchRecord: type: object properties: id: type: integer description: ID standardCompanyBranch: type: boolean description: Empresa filial padrão user: #/definitions/userRecord companyBranch: #/definitions/companyBranchRecord idRecord: type: object properties: id: type: integer description: ID code: type: string description: Código description: type: string description: Descrição userGroupRecord: type: object properties: id: type: integer description: ID notifiesOccurrence: type: integer description: Notifica ocorrência user: #/definitions/userRecord group: #/definitions/groupRecord groupRecord: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord idErp: type: string description: ID no sistema terceiro companyBranchFacade: type: object properties: id: type: integer description: ID no CRM company: #/definitions/companyRecord branch: #/definitions/branchRecord companyFacade: type: object properties: id: type: integer description: Id de identificação no CRM companyErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ address: type: string description: Endereço district: type: string description: Bairro cep: type: string description: Código postal Brasileiro stateRegistration: type: string description: Inscrição Estadual telephone: type: string description: Telefone municipalRegistration: type: string description: Inscrição Municipal url: type: string description: URL email: type: string description: Email responsible: type: string description: Responsável databaseName: type: string description: Nome da base de dados accessUrl: type: string description: URL de acesso city: #/definitions/cityRecord nit: type: string description: NIT branchFacade: type: object properties: id: type: integer description: Id de identificação no CRM branchErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ address: type: string description: Endereço district: type: string description: Bairro cep: type: string description: Código postal Brasileiro stateRegistration: type: string description: Inscrição Estadual telephone: type: string description: Telefone municipalRegistration: type: string description: Inscrição Municipal url: type: string description: URL email: type: string description: Email responsible: type: string description: Responsável headquarters: type: integer description: Matriz duplicateInformation: type: integer description: Duplicar Informações duplicateAffiliateCompanyInformation: type: integer description: Duplicar Informações Empresa Filial duplicateCompanyInformation: type: integer description: Duplicar Informações Empresa city: #/definitions/cityRecord nit: type: string description: NIT functionFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte idErp: type: string description: ID no sistema terceiro company: #/definitions/companyRecord departmentFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo useOccurrence: type: boolean description: Se o departamento é usado na ocorrência customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord contactOriginFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord occurrenceTypeFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord sla: type: integer description: SLA customFields: type: string description: Campos customizados format: byte occurrenceSubtypeFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord sla: type: integer description: SLA occurrenceType: #/definitions/occurrenceTypeRecord customFields: type: string description: Campos customizados format: byte occurrenceTypeRecord: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: #/definitions/companyBranchRecord sla: type: integer description: SLA customFields: type: string description: Campos customizados format: byte personTypeFacade: type: object properties: id: type: integer description: ID name: type: string description: Nome icon: type: string description: Ìcone active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte occurrenceStatusFacade: type: object properties: id: type: integer description: ID name: type: string description: Nome companyBranch: #/definitions/companyBranchRecord displayOrder: type: integer description: Ordem de exibição defaultColor: type: string description: Cor padrão occurrenceStarts: type: boolean description: Se inicia a ocorrência occurrenceEnds: type: boolean description: Se encerra a ocorrência active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte occurrenceOriginFacade: type: object properties: id: type: integer description: ID name: type: string description: Nome companyBranch: #/definitions/companyBranchRecord active: type: boolean description: Se está ativo customFields: type: string description: Campos customizados format: byte regionCityFacade: type: object properties: id: type: integer description: ID city: #/definitions/cityRecord microRegion: #/definitions/regionRecord regionRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome active: type: integer description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord opportunityTypeProductFacade: type: object properties: id: type: integer description: ID product: #/definitions/productRecord opportunityType: #/definitions/opportunityTypeRecord characteristicsFacade: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord characteristicsHierarchyFacade: type: object properties: id: type: integer description: ID no CRM characteristicDependent: #/definitions/characteristicsRecord characteristicRoot: #/definitions/characteristicsRecord characteristicsRecord: type: object properties: id: type: integer description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord 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