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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /basic_records/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/publishEvent: post: description: Dispara um evento do basic records tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – event – content properties: event: type: string allOf: – #/definitions/enumEventsBasicRecords description: Evento a ser disparado content: type: string description: Conteúdo serializado desse evento responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: Referente ao status do envio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/uploadFile: post: description: Faz o upload de um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: id: type: array items: type: integer format: int64 description: IDs dos arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/events/activityBranchesCreated: post: description: Evento de ramo de atividade criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: type: object allOf: – #/definitions/activityBranchesRecord description: Ramo de atividade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/companyGroupsCreated: post: description: Evento de grupo de empresa criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: type: object allOf: – #/definitions/companyGroupsRecord description: Grupo de empresa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/priceTableCreated: post: description: Evento de tabela de preço criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/carrierCreated: post: description: Evento de transportadora criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – carrier properties: carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTermsCreated: post: description: Evento de prazo de pagamento criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: type: object allOf: – #/definitions/paymentTermsRecord description: Prazo de pagamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/opportunityTypeCreated: post: description: Evento de tipo de oportunidade criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo de oportunidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTypeCreated: post: description: Evento de tipo de pagamento criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: type: object allOf: – #/definitions/paymentTypeRecord description: Tipo de pagament responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/depositCreated: post: description: Evento de depósito criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – deposit properties: deposit: type: object allOf: – #/definitions/depositRecord description: Depósito responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/productCreated: post: description: Evento de produto criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – product properties: product: type: object allOf: – #/definitions/productRecord description: Produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/serviceCreated: post: description: Evento de serviço criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – service properties: service: type: object allOf: – #/definitions/serviceRecord description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/activityBranchesUpdated: post: description: Evento de ramo de atividade atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: type: object allOf: – #/definitions/activityBranchesRecord description: Ramo de atividade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/companyGroupsUpdated: post: description: Evento de grupo de empresa atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: type: object allOf: – #/definitions/companyGroupsRecord description: Grupo de empresa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/priceTableUpdated: post: description: Evento de tabela de preço atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/carrierUpdated: post: description: Evento de transportadora atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – carrier properties: carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTermsUpdated: post: description: Evento de prazo de pagamento atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: type: object allOf: – #/definitions/paymentTermsRecord description: Prazo de pagamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/opportunityTypeUpdated: post: description: Evento de tipo de oportunidade atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo de oportunidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTypeUpdated: post: description: Evento de tipo de pagamento atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: type: object allOf: – #/definitions/paymentTypeRecord description: Tipo de pagament responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/depositUpdated: post: description: Evento de depósito atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – deposit properties: deposit: type: object allOf: – #/definitions/depositRecord description: Depósito responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/productUpdated: post: description: Evento de produto atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – product properties: product: type: object allOf: – #/definitions/productRecord description: Produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/serviceUpdated: post: description: Evento de serviço atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – service properties: service: type: object allOf: – #/definitions/serviceRecord description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/apis/activityBranches: post: description: Entidade fachada Ramo de atividade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/activityBranchesFacade responses: 200: description: Ok schema: #/definitions/activityBranchesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Ramo de atividade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/activityBranchesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/activityBranches/{id}: get: description: Entidade fachada Ramo de atividade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/activityBranchesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Ramo de atividade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/activityBranchesFacade responses: 200: description: Ok schema: #/definitions/activityBranchesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Ramo de atividade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companyGroups: post: description: Entidade fachada Grupo de empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companyGroupsFacade responses: 200: description: Ok schema: #/definitions/companyGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Grupo de empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companyGroups/{id}: get: description: Entidade fachada Grupo de empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Grupo de empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyGroupsFacade responses: 200: description: Ok schema: #/definitions/companyGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Grupo de empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/priceTable: post: description: Entidade fachada Tabela de preço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/priceTableFacade responses: 200: description: Ok schema: #/definitions/priceTableFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tabela de preço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/priceTableFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/priceTable/{id}: get: description: Entidade fachada Tabela de preço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/priceTableFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tabela de preço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/priceTableFacade responses: 200: description: Ok schema: #/definitions/priceTableFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tabela de preço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/actionType: post: description: Entidade fachada Tipo de Ação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/actionTypeFacade responses: 200: description: Ok schema: #/definitions/actionTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de Ação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/actionTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/actionType/{id}: get: description: Entidade fachada Tipo de Ação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/actionTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de Ação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/actionTypeFacade responses: 200: description: Ok schema: #/definitions/actionTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de Ação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/carrier: post: description: Entidade fachada Transportadora tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/carrierFacade responses: 200: description: Ok schema: #/definitions/carrierFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Transportadora tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/carrierFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/carrier/{id}: get: description: Entidade fachada Transportadora tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/carrierFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Transportadora tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/carrierFacade responses: 200: description: Ok schema: #/definitions/carrierFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Transportadora tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/paymentTerms: post: description: Entidade fachada Prazo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/paymentTermsFacade responses: 200: description: Ok schema: #/definitions/paymentTermsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Prazo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/paymentTermsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/paymentTerms/{id}: get: description: Entidade fachada Prazo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTermsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Prazo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/paymentTermsFacade responses: 200: description: Ok schema: #/definitions/paymentTermsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Prazo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityType: post: description: Entidade fachada Tipo de oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/opportunityTypeFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/opportunityTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityType/{id}: get: description: Entidade fachada Tipo de oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityTypeFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/paymentType: post: description: Entidade fachada Tipo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/paymentTypeFacade responses: 200: description: Ok schema: #/definitions/paymentTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/paymentTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/paymentType/{id}: get: description: Entidade fachada Tipo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/paymentTypeFacade responses: 200: description: Ok schema: #/definitions/paymentTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de pagamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/deposit: post: description: Entidade fachada Depósito tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/depositFacade responses: 200: description: Ok schema: #/definitions/depositFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Depósito tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/depositFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/deposit/{id}: get: description: Entidade fachada Depósito tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/depositFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Depósito tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/depositFacade responses: 200: description: Ok schema: #/definitions/depositFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Depósito tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/product: post: description: Entidade fachada Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productFacade responses: 200: description: Ok schema: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/product/{id}: get: description: Entidade fachada Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productFacade responses: 200: description: Ok schema: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/service: post: description: Entidade fachada Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/serviceFacade responses: 200: description: Ok schema: #/definitions/serviceFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/serviceFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/service/{id}: get: description: Entidade fachada Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/serviceFacade responses: 200: description: Ok schema: #/definitions/serviceFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountType: post: description: Entidade fachada Tipo da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountTypeFacade responses: 200: description: Ok schema: #/definitions/accountTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountType/{id}: get: description: Entidade fachada Tipo da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountTypeFacade responses: 200: description: Ok schema: #/definitions/accountTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/cities: post: description: Entidade fachada Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/citiesFacade responses: 200: description: Ok schema: #/definitions/citiesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/citiesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/cities/{id}: get: description: Entidade fachada Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/citiesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/citiesFacade responses: 200: description: Ok schema: #/definitions/citiesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/states: post: description: Entidade fachada Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/statesFacade responses: 200: description: Ok schema: #/definitions/statesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/statesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/states/{id}: get: description: Entidade fachada Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/statesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/statesFacade responses: 200: description: Ok schema: #/definitions/statesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/countries: post: description: Entidade fachada País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/countriesFacade responses: 200: description: Ok schema: #/definitions/countriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/countriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/countries/{id}: get: description: Entidade fachada País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/countriesFacade responses: 200: description: Ok schema: #/definitions/countriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountOrigins: post: description: Entidade fachada Origem da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountOriginsFacade responses: 200: description: Ok schema: #/definitions/accountOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Origem da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountOrigins/{id}: get: description: Entidade fachada Origem da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Origem da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountOriginsFacade responses: 200: description: Ok schema: #/definitions/accountOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Origem da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountStatus: post: description: Entidade fachada Status da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountStatusFacade responses: 200: description: Ok schema: #/definitions/accountStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Status da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/accountStatus/{id}: get: description: Entidade fachada Status da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Status da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountStatusFacade responses: 200: description: Ok schema: #/definitions/accountStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Status da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/addressTypes: post: description: Entidade fachada Tipo do Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/addressTypesFacade responses: 200: description: Ok schema: #/definitions/addressTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo do Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/addressTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/addressTypes/{id}: get: description: Entidade fachada Tipo do Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/addressTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo do Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/addressTypesFacade responses: 200: description: Ok schema: #/definitions/addressTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo do Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/appointmentCategories: post: description: Entidade fachada Categorias de Compromissos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/appointmentCategoriesFacade responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Categorias de Compromissos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/appointmentCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/appointmentCategories/{id}: get: description: Entidade fachada Categorias de Compromissos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Categorias de Compromissos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/appointmentCategoriesFacade responses: 200: description: Ok schema: #/definitions/appointmentCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Categorias de Compromissos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/businessTypes: post: description: Entidade fachada Modalidade de Negócio tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/businessTypesFacade responses: 200: description: Ok schema: #/definitions/businessTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Modalidade de Negócio tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/businessTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/businessTypes/{id}: get: description: Entidade fachada Modalidade de Negócio tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/businessTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Modalidade de Negócio tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/businessTypesFacade responses: 200: description: Ok schema: #/definitions/businessTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Modalidade de Negócio tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companySize: post: description: Entidade fachada Porte da Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companySizeFacade responses: 200: description: Ok schema: #/definitions/companySizeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Porte da Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companySizeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companySize/{id}: get: description: Entidade fachada Porte da Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companySizeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Porte da Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companySizeFacade responses: 200: description: Ok schema: #/definitions/companySizeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Porte da Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/inactivationReason: post: description: Entidade fachada Motivo de Inativação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/inactivationReasonFacade responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Motivo de Inativação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/inactivationReasonFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/inactivationReason/{id}: get: description: Entidade fachada Motivo de Inativação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Motivo de Inativação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/inactivationReasonFacade responses: 200: description: Ok schema: #/definitions/inactivationReasonFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Motivo de Inativação tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/eventTypes: post: description: Entidade fachada Tipos de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/eventTypesFacade responses: 200: description: Ok schema: #/definitions/eventTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipos de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/eventTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/eventTypes/{id}: get: description: Entidade fachada Tipos de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipos de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/eventTypesFacade responses: 200: description: Ok schema: #/definitions/eventTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipos de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/eventsStatus: post: description: Entidade fachada Status de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/eventsStatusFacade responses: 200: description: Ok schema: #/definitions/eventsStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Status de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/eventsStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/eventsStatus/{id}: get: description: Entidade fachada Status de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventsStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Status de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/eventsStatusFacade responses: 200: description: Ok schema: #/definitions/eventsStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Status de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/interestAreas: post: description: Entidade fachada Áreas de Interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/interestAreasFacade responses: 200: description: Ok schema: #/definitions/interestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Áreas de Interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/interestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/interestAreas/{id}: get: description: Entidade fachada Áreas de Interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/interestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Áreas de Interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/interestAreasFacade responses: 200: description: Ok schema: #/definitions/interestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Áreas de Interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/locations: post: description: Entidade fachada Localizações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/locationsFacade responses: 200: description: Ok schema: #/definitions/locationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Localizações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/locationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/locations/{id}: get: description: Entidade fachada Localizações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/locationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Localizações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/locationsFacade responses: 200: description: Ok schema: #/definitions/locationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Localizações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/lossReasons: post: description: Entidade fachada Motivo da Perda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/lossReasonsFacade responses: 200: description: Ok schema: #/definitions/lossReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Motivo da Perda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/lossReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/lossReasons/{id}: get: description: Entidade fachada Motivo da Perda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lossReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Motivo da Perda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/lossReasonsFacade responses: 200: description: Ok schema: #/definitions/lossReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Motivo da Perda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityOrigins: post: description: Entidade fachada Origem de Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/opportunityOriginsFacade responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Origem de Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/opportunityOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityOrigins/{id}: get: description: Entidade fachada Origem de Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Origem de Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityOriginsFacade responses: 200: description: Ok schema: #/definitions/opportunityOriginsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Origem de Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/followType: post: description: Entidade fachada referente aos tipos de Follow-Ups tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/followTypeFacade responses: 200: description: Ok schema: #/definitions/followTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente aos tipos de Follow-Ups tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/followTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/followType/{id}: get: description: Entidade fachada referente aos tipos de Follow-Ups tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/followTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente aos tipos de Follow-Ups tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/followTypeFacade responses: 200: description: Ok schema: #/definitions/followTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente aos tipos de Follow-Ups tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/productCategories: post: description: Entidade fachada Categoria de Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productCategoriesFacade responses: 200: description: Ok schema: #/definitions/productCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Categoria de Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/productCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/productCategories/{id}: get: description: Entidade fachada Categoria de Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Categoria de Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productCategoriesFacade responses: 200: description: Ok schema: #/definitions/productCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Categoria de Produto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/ratings: post: description: Entidade fachada Avaliações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/ratingsFacade responses: 200: description: Ok schema: #/definitions/ratingsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Avaliações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ratingsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/ratings/{id}: get: description: Entidade fachada Avaliações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ratingsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Avaliações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/ratingsFacade responses: 200: description: Ok schema: #/definitions/ratingsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Avaliações tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/regions: post: description: Entidade fachada Regiões tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/regionsFacade responses: 200: description: Ok schema: #/definitions/regionsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Regiões tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/regionsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/regions/{id}: get: description: Entidade fachada Regiões tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/regionsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Regiões tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/regionsFacade responses: 200: description: Ok schema: #/definitions/regionsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Regiões tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/salesReasons: post: description: Entidade fachada Motivo de Fechamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/salesReasonsFacade responses: 200: description: Ok schema: #/definitions/salesReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Motivo de Fechamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/salesReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/salesReasons/{id}: get: description: Entidade fachada Motivo de Fechamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salesReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Motivo de Fechamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/salesReasonsFacade responses: 200: description: Ok schema: #/definitions/salesReasonsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Motivo de Fechamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/relationshipTypes: post: description: Entidade fachada Tipo de Relacionamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/relationshipTypesFacade responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de Relacionamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/relationshipTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/relationshipTypes/{id}: get: description: Entidade fachada Tipo de Relacionamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de Relacionamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/relationshipTypesFacade responses: 200: description: Ok schema: #/definitions/relationshipTypesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de Relacionamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/serviceCategories: post: description: Entidade fachada Categoria de Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/serviceCategoriesFacade responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Categoria de Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/serviceCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/serviceCategories/{id}: get: description: Entidade fachada Categoria de Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Categoria de Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/serviceCategoriesFacade responses: 200: description: Ok schema: #/definitions/serviceCategoriesFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Categoria de Serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/measurementUnit: post: description: Entidade fachada Unidade de Medida tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/measurementUnitFacade responses: 200: description: Ok schema: #/definitions/measurementUnitFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Unidade de Medida tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/measurementUnitFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/measurementUnit/{id}: get: description: Entidade fachada Unidade de Medida tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/measurementUnitFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Unidade de Medida tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/measurementUnitFacade responses: 200: description: Ok schema: #/definitions/measurementUnitFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Unidade de Medida tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/userGroups: post: description: Entidade fachada Grupo de Usuários tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/userGroupsFacade responses: 200: description: Ok schema: #/definitions/userGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Grupo de Usuários tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/userGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/userGroups/{id}: get: description: Entidade fachada Grupo de Usuários tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Grupo de Usuários tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/userGroupsFacade responses: 200: description: Ok schema: #/definitions/userGroupsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Grupo de Usuários tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/user: post: description: Entidade fachado Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/userFacade responses: 200: description: Ok schema: #/definitions/userFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachado Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/userFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/user/{id}: get: description: Entidade fachado Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/userFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachado Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/userFacade responses: 200: description: Ok schema: #/definitions/userFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachado Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companyBranch: post: description: Entidade fachada Empresa filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companyBranchFacade responses: 200: description: Ok schema: #/definitions/companyBranchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Empresa filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyBranchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/companyBranch/{id}: get: description: Entidade fachada Empresa filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyBranchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Empresa filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyBranchFacade responses: 200: description: Ok schema: #/definitions/companyBranchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Empresa filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/company: post: description: Entidade fachada Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/company/{id}: get: description: Entidade fachada Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/branch: post: description: Entidade fachada Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/branchFacade responses: 200: description: Ok schema: #/definitions/branchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/branchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/branch/{id}: get: description: Entidade fachada Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/branchFacade responses: 200: description: Ok schema: #/definitions/branchFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/function: post: description: Entidade fachada Função tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/functionFacade responses: 200: description: Ok schema: #/definitions/functionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Função tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/functionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/function/{id}: get: description: Entidade fachada Função tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/functionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Função tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/functionFacade responses: 200: description: Ok schema: #/definitions/functionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Função tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/department: post: description: Entidade fachada Departamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Departamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/departmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/department/{id}: get: description: Entidade fachada Departamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/departmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Departamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Departamento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/contactOrigin: post: description: Entidade fachada Origem do Contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/contactOriginFacade responses: 200: description: Ok schema: #/definitions/contactOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Origem do Contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contactOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/contactOrigin/{id}: get: description: Entidade fachada Origem do Contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contactOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Origem do Contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/contactOriginFacade responses: 200: description: Ok schema: #/definitions/contactOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Origem do Contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceType: post: description: Entidade fachada Tipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/occurrenceTypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/occurrenceTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceType/{id}: get: description: Entidade fachada Tipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceTypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceSubtype: post: description: Entidade fachada Subtipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/occurrenceSubtypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Subtipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/occurrenceSubtypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceSubtype/{id}: get: description: Entidade fachada Subtipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Subtipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceSubtypeFacade responses: 200: description: Ok schema: #/definitions/occurrenceSubtypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Subtipo de Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/personType: post: description: Entidade fachada Tipo de Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/personTypeFacade responses: 200: description: Ok schema: #/definitions/personTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Tipo de Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/personTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/personType/{id}: get: description: Entidade fachada Tipo de Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Tipo de Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/personTypeFacade responses: 200: description: Ok schema: #/definitions/personTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Tipo de Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceStatus: post: description: Entidade fachada Status da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/occurrenceStatusFacade responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Status da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/occurrenceStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceStatus/{id}: get: description: Entidade fachada Status da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Status da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceStatusFacade responses: 200: description: Ok schema: #/definitions/occurrenceStatusFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Status da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceOrigin: post: description: Entidade fachada Origem da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/occurrenceOriginFacade responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Origem da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/occurrenceOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/occurrenceOrigin/{id}: get: description: Entidade fachada Origem da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Origem da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/occurrenceOriginFacade responses: 200: description: Ok schema: #/definitions/occurrenceOriginFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Origem da Ocorrência tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/regionCity: post: description: Entidade fachada Microrregião Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/regionCityFacade responses: 200: description: Ok schema: #/definitions/regionCityFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Microrregião Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/regionCityFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/regionCity/{id}: get: description: Entidade fachada Microrregião Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/regionCityFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Microrregião Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/regionCityFacade responses: 200: description: Ok schema: #/definitions/regionCityFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Microrregião Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityTypeProduct: post: description: Entidade fachada Produto Tipo Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/opportunityTypeProductFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada Produto Tipo Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/opportunityTypeProductFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/opportunityTypeProduct/{id}: get: description: Entidade fachada Produto Tipo Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada Produto Tipo Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/opportunityTypeProductFacade responses: 200: description: Ok schema: #/definitions/opportunityTypeProductFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada Produto Tipo Oportunidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/characteristics: post: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/characteristicsFacade responses: 200: description: Ok schema: #/definitions/characteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/characteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/characteristics/{id}: get: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/characteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/characteristicsFacade responses: 200: description: Ok schema: #/definitions/characteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/characteristicsHierarchy: post: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/characteristicsHierarchyFacade responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/characteristicsHierarchyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/apis/characteristicsHierarchy/{id}: get: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/characteristicsHierarchyFacade responses: 200: description: Ok schema: #/definitions/characteristicsHierarchyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthCheckStatusEnum: description: Up or down type: string enum: – UP – DOWN enumEventsBasicRecords: description: Nome de todos os eventos do basic records type: string enum: – ACTIVITY_BRANCHES_CREATED – ACTIVITY_BRANCHES_UPDATED – COMPANY_GROUPS_CREATED – COMPANY_GROUPS_UPDATED – PRICE_TABLE_CREATED – PRICE_TABLE_UPDATED – CARRIER_CREATED – CARRIER_UPDATED – PAYMENT_TERMS_CREATED – PAYMENT_TERMS_UPDATED – OPPORTUNITY_TYPE_CREATED – OPPORTUNITY_TYPE_UPDATED – PAYMENT_TYPE_CREATED – PAYMENT_TYPE_UPDATED – DEPOSIT_CREATED – DEPOSIT_UPDATED – PRODUCT_CREATED – PRODUCT_UPDATED – SERVICE_CREATED – SERVICE_UPDATED endpointsEnum: description: Nome de todos os endpoints type: string enum: – MEASUREMENT_UNIT – USER_GROUPS – USER_GROUP_LINKS – PRODUCT – SERVICE – OPPORTUNITY_TYPE – PAYMENT_TERMS – PAYMENT_TYPE – PRICE_TABLE – CARRIER – COUNTRIES – COMPANY_BRANCH – COMPANY – FILIAL – CITIES userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN companyBranchRecord: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Objeto da Empresa branch: type: object allOf: – #/definitions/branchRecord description: Objeto da filial da Empresa companyRecord: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 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 branchRecord: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 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 format: int64 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 productCategoryRecord: description: Categorias do produto type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa unitMeasurementRecord: description: Unidade de medida type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome acronym: type: string description: Sigla active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados serviceCategoryRecord: description: Categoria de serviço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa activityBranchesRecord: description: Ramo de atividade type: object properties: id: type: integer format: int64 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 default: true customFields: type: string format: byte description: Campos customizados companyGroupsRecord: description: Grupo de empresas type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/companyRecord description: Empresa active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados priceTableRecord: description: Tabela de preço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da tabela de preços companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados carrierRecord: description: Transportadora type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da transportadora companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se a transportadora está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados paymentTermsRecord: description: Prazo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do prazo de pagamento company: type: object allOf: – #/definitions/companyRecord description: Empresa active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados opportunityTypeRecord: description: Tipo de oportunidade type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de oportunidade companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema default: true note: type: string description: Observação customFields: type: string format: byte description: Campos customizados paymentTypeRecord: description: Tipo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de pagamento companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados depositRecord: description: Depósito type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do depósito companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o depósito está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados productRecord: description: Produto type: object properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Empresa 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: type: object allOf: – #/definitions/productCategoryRecord description: Categoria do produto unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do produto maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 defaultQuantity: type: number format: double description: Quantidade padrão do produto no pedido maximum: 99999999999999.999999 correctionFactor: type: number format: double description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão maximum: 999.99 saleType: type: boolean description: Informativo do tipo de venda padrão para o produto default: false ipi: type: number format: double description: Porcentagem de IPI, somente descritivo maximum: 99999999.99 icms: type: number format: double description: Porcentagem de ICMS, somente descritivo maximum: 99999999.99 weight: type: number format: double description: Peso unitário do produto maximum: 999999999999.99999 note: type: string description: Obervações do tipo de oportunidade customFields: type: string format: byte description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma ncm: type: string description: NCM serviceRecord: description: Serviço type: object required: – serviceCategory properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Empresa partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do serviço serviceCategory: type: object allOf: – #/definitions/serviceCategoryRecord description: Categoria do serviço unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida active: type: boolean description: Indicador se o serviço está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do serviço maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 note: type: string description: Obervações do tipo de oportunidade customFields: type: string format: byte description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma stateRecord: description: Estado type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo default: true country: type: object allOf: – #/definitions/countryRecord description: País customFields: type: string format: byte description: Campos customizados idErp: type: string description: Id no sistema terceiro countryRecord: description: País type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados code: type: integer format: int64 description: Código idErp: type: string description: Id no sistema terceiro addressRecord: description: Endereço type: object properties: id: type: integer format: int64 description: Identificador active: type: boolean description: Ativo default: true 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 format: double description: Latitude maximum: 9999999999.999999 longitude: type: number format: double description: Longitude maximum: 9999999999.999999 customFields: type: string format: byte description: Campos customizados type: type: object allOf: – #/definitions/addressTypeRecord description: Tipo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial city: type: object allOf: – #/definitions/cityRecord description: Cidade zipCode: type: string description: Código postal exterior addressTypeRecord: description: Record referente ao tipo do endereço type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial cityRecord: description: Record referente a cidade type: object properties: id: type: integer format: int64 description: Identificador idIbge: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo default: true dddCode: type: string description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População estimada consumptionPotencial: type: number format: double description: Potêncial de consumo maximum: 9999999999999.999 pib: type: number format: double description: PIB maximum: 9999999999999.999 customFields: type: string format: byte description: Campos customizados state: type: object allOf: – #/definitions/stateRecord description: Estado country: type: object allOf: – #/definitions/countryRecord description: País idErp: type: string description: Id no sistema terceiro groupRecord: description: Grupo type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa idErp: type: string description: ID no sistema terceiro userRecord: description: Usuário type: object properties: id: type: integer format: int64 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 format: int64 description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade default: false receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência default: false photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string format: date-time description: Aniversário active: type: boolean description: Ativo default: false visibleCombo: type: boolean description: Se o combo é visível default: false language: type: integer format: int64 description: Idioma legacyId: type: integer format: int64 description: ID no legado department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função subordinateOf: type: object allOf: – #/definitions/userRecord description: Superior userCompanyBranches: type: array items: type: object allOf: – #/definitions/userCompanyBranchRecord description: Empresa/filiais do usuário ids: type: array items: type: object allOf: – #/definitions/idRecord description: IDs groups: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Grupos departmentRecord: description: Departamento type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: boolean description: Ativo default: true usesOccurrence: type: boolean description: Usa ocorrência default: false customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial functionRecord: description: Função type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados idErp: type: string description: Id no sistema terceiro company: type: object allOf: – #/definitions/companyRecord description: Empresa userCompanyBranchRecord: description: Empresa/filiais do usuário type: object properties: id: type: integer format: int64 description: ID standardCompanyBranch: type: boolean description: Empresa filial padrão user: type: object allOf: – #/definitions/userRecord description: Usuário companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial idRecord: description: IDs type: object properties: id: type: integer format: int64 description: ID code: type: string description: Código description: type: string description: Descrição userGroupRecord: description: Grupo type: object properties: id: type: integer format: int64 description: ID notifiesOccurrence: type: integer format: int64 description: Notifica ocorrência user: type: object allOf: – #/definitions/userRecord description: Usuário group: type: object allOf: – #/definitions/groupRecord description: Grupo occurrenceTypeRecord: description: Tipo de ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA customFields: type: string format: byte description: Campos customizados regionRecord: description: Microrregião type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial crmFile: description: Arquivo type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial uploadType: type: integer format: int64 description: Tipo de upload fileName: type: string description: Nome do arquivo folder: type: string description: Pasta destination: type: string description: Destino size: type: number format: double description: Tamanho fieldName: type: string description: Nome do campo hash: type: string description: Hash characteristicsRecord: description: Objeto referente a Caracteristica type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status activityBranchesFacade: description: Entidade fachada Ramo de atividade type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa companyGroupsFacade: description: Entidade fachada Grupo de empresa type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa priceTableFacade: description: Entidade fachada Tabela de preço type: object properties: id: type: integer format: int64 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 default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial actionTypeFacade: description: Entidade fachada Tipo de Ação type: object properties: id: type: integer format: int64 description: ID no CRM companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Se o registro está ativo default: true 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 format: byte description: Campos customizados carrierFacade: description: Entidade fachada Transportadora type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial paymentTermsFacade: description: Entidade fachada Prazo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true generateInstallments: type: boolean description: Gerar parcela quantityInstallments: type: integer format: int64 description: Quantidade parcelas accrualInstallments: type: string description: Acréscimo Parcelas maximum: 99999999999999.99 rounding: type: integer format: int64 description: Arredondamento customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa opportunityTypeFacade: description: Entidade fachada Tipo de oportunidade type: object properties: id: type: integer format: int64 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 default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial paymentTypeFacade: description: Entidade fachada Tipo de pagamento type: object properties: id: type: integer format: int64 description: ID do CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome addedValue: type: number format: double description: Valor do acréscimo maximum: 99999999999999.99 active: type: boolean description: Se está ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial depositFacade: description: Entidade fachada Depósito type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial productFacade: description: Entidade fachada Produto type: object properties: id: type: integer format: int64 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. default: true salePrice: type: string description: Valor de venda maximum: 999999999999999.999999 maximumDiscount: type: string description: Desconto percentual unitário máximo maximum: 99999.99 defaultQuantity: type: string description: Quantidade padrão do produto no pedido maximum: 99999999999999.999999 correctionFactor: type: string description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão maximum: 999.99 saleType: type: boolean description: É do tipo venda default: false ipi: type: string description: Porcentagem de IPI maximum: 99999999.99 icms: type: string description: Porcentagem de ICMS maximum: 99999999.99 weight: type: string description: Peso unitário maximum: 999999999999.99999 coinId: type: integer format: int64 description: Moeda Id rate: type: string description: Taxa maximum: 99999999999999.999999 note: type: string description: Obervações origin: type: string description: Origem customFields: type: string format: byte description: Campos customizados unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida productCategory: type: object allOf: – #/definitions/productCategoryRecord description: Categoria company: type: object allOf: – #/definitions/companyRecord description: Empresa photo: type: object allOf: – #/definitions/crmFile description: Foto file: type: object allOf: – #/definitions/crmFile description: Arquivo serviceFacade: description: Entidade fachada Serviço type: object properties: id: type: integer format: int64 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 default: true salePrice: type: number format: double description: Valor de venda maximum: 999999999999999.999999 note: type: string description: Obervação maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 customFields: type: string format: byte description: Campos customizados serviceCategory: type: object allOf: – #/definitions/serviceCategoryRecord description: Categoria unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida company: type: object allOf: – #/definitions/companyRecord description: Empresa accountTypeFacade: description: Entidade fachada Tipo da conta type: object properties: id: type: integer format: int64 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 format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa citiesFacade: description: Entidade fachada Cidade type: object properties: id: type: integer format: int64 description: Identificador ibgeCode: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo default: true dddCode: type: string description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População estimada consumptionPotencial: type: number format: double description: Potêncial de consumo maximum: 9999999999999.999 pib: type: number format: double description: PIB maximum: 9999999999999.999 customFields: type: string format: byte description: Campos customizados state: type: object allOf: – #/definitions/stateRecord description: Estado country: type: object allOf: – #/definitions/countryRecord description: País idErp: type: string description: Id no sistema terceiro statesFacade: description: Entidade fachada Estado type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo default: true country: type: object allOf: – #/definitions/countryRecord description: País customFields: type: string format: byte description: Campos customizados idErp: type: string description: Id no sistema terceiro countriesFacade: description: Entidade fachada País type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados code: type: integer format: int64 description: Código idErp: type: string description: Id no sistema terceiro accountOriginsFacade: description: Entidade fachada Origem da Conta type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Name active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa accountStatusFacade: description: Entidade fachada Status da Conta type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados icon: type: string description: Ícone idErp: type: string description: Id no sistema terceiro addressTypesFacade: description: Entidade fachada Tipo do Endereço type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial appointmentCategoriesFacade: description: Entidade fachada Categorias de Compromissos type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados businessTypesFacade: description: Entidade fachada Modalidade de Negócio type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial companySizeFacade: description: Entidade fachada Porte da Empresa type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados inactivationReasonFacade: description: Entidade fachada Motivo de Inativação type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial eventTypesFacade: description: Entidade fachada Tipos de Evento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial eventsStatusFacade: description: Entidade fachada Status de Evento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true icon: type: string description: Ícone customFields: type: string format: byte description: Campos customizados interestAreasFacade: description: Entidade fachada Áreas de Interesse type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa locationsFacade: description: Entidade fachada Localizações type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados address: type: object allOf: – #/definitions/addressRecord description: Endereço lossReasonsFacade: description: Entidade fachada Motivo da Perda type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial opportunityOriginsFacade: description: Entidade fachada Origem de Oportunidade type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial followTypeFacade: description: Entidade fachada referente aos tipos de Follow-Ups type: object properties: id: type: integer format: int64 description: Id de identificação no CRM name: type: string description: Nome slaHours: type: integer format: int64 description: Tempo em horas de SLA para finalização do Follow-Up active: type: boolean description: Ativo default: true module: type: integer format: int64 description: Módulo onde será exibido essa opção de follow. 1 – Oportunidade | 2 – Ocorrência | 3 – Contrato\n| 4 – Tarefa | 5 – Compromisso | 6 – Evento customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial productCategoriesFacade: description: Entidade fachada Categoria de Produto type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa ratingsFacade: description: Entidade fachada Avaliações type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados regionsFacade: description: Entidade fachada Regiões type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial salesReasonsFacade: description: Entidade fachada Motivo de Fechamento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial relationshipTypesFacade: description: Entidade fachada Tipo de Relacionamento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados serviceCategoriesFacade: description: Entidade fachada Categoria de Serviço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa measurementUnitFacade: description: Entidade fachada Unidade de Medida type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados userGroupsFacade: description: Entidade fachada Grupo de Usuários type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa idErp: type: string description: ID no sistema terceiro userFacade: description: Entidade fachado Usuário type: object properties: id: type: integer format: int64 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 format: int64 description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade default: false receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência default: false photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string format: date-time description: Aniversário active: type: boolean description: Ativo default: false visibleCombo: type: boolean description: Se o combo é visível default: false language: type: integer format: int64 description: Idioma legacyId: type: integer format: int64 description: ID no legado department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função subordinateOf: type: object allOf: – #/definitions/userRecord description: Subordinado De userCompanyBranches: type: array items: type: object allOf: – #/definitions/userCompanyBranchRecord description: Empresa filial ids: type: array items: type: object allOf: – #/definitions/idRecord description: IDs groups: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Grupos companyBranchFacade: description: Entidade fachada Empresa filial type: object properties: id: type: integer format: int64 description: ID no CRM company: type: object allOf: – #/definitions/companyRecord description: Empresa branch: type: object allOf: – #/definitions/branchRecord description: Filial companyFacade: description: Entidade fachada Empresa type: object properties: id: type: integer format: int64 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: type: object allOf: – #/definitions/cityRecord description: Cidade nit: type: string description: NIT branchFacade: description: Entidade fachada Filial type: object properties: id: type: integer format: int64 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 format: int64 description: Matriz duplicateInformation: type: integer format: int64 description: Duplicar Informações duplicateAffiliateCompanyInformation: type: integer format: int64 description: Duplicar Informações Empresa Filial duplicateCompanyInformation: type: integer format: int64 description: Duplicar Informações Empresa city: type: object allOf: – #/definitions/cityRecord description: Cidade nit: type: string description: NIT functionFacade: description: Entidade fachada Função type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados idErp: type: string description: ID no sistema terceiro company: type: object allOf: – #/definitions/companyRecord description: Empresa departmentFacade: description: Entidade fachada Departamento type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true useOccurrence: type: boolean description: Se o departamento é usado na ocorrência default: false customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial contactOriginFacade: description: Entidade fachada Origem do Contato type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa occurrenceTypeFacade: description: Entidade fachada Tipo de Ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA customFields: type: string format: byte description: Campos customizados occurrenceSubtypeFacade: description: Entidade fachada Subtipo de Ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA occurrenceType: type: object allOf: – #/definitions/occurrenceTypeRecord description: Tipo de ocorrência customFields: type: string format: byte description: Campos customizados personTypeFacade: description: Entidade fachada Tipo de Pessoa type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome icon: type: string description: Ìcone active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados occurrenceStatusFacade: description: Entidade fachada Status da Ocorrência type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial displayOrder: type: integer format: int64 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 format: byte description: Campos customizados occurrenceOriginFacade: description: Entidade fachada Origem da Ocorrência type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados regionCityFacade: description: Entidade fachada Microrregião Cidade type: object properties: id: type: integer format: int64 description: ID city: type: object allOf: – #/definitions/cityRecord description: Cidade microRegion: type: object allOf: – #/definitions/regionRecord description: Microrregião opportunityTypeProductFacade: description: Entidade fachada Produto Tipo Oportunidade type: object properties: id: type: integer format: int64 description: ID product: type: object allOf: – #/definitions/productRecord description: Produto opportunityType: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo de Oportunidade characteristicsFacade: description: type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa characteristicsHierarchyFacade: description: type: object properties: id: type: integer format: int64 description: ID no CRM characteristicDependent: type: object allOf: – #/definitions/characteristicsRecord description: Caracteristica Filha characteristicRoot: type: object allOf: – #/definitions/characteristicsRecord description: Caracteristica Pai 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