2.0info: 1.4.0 Cadastros básicos description: Serviço responsável pelos cadastros básicos do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: basic_records contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: 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/healthcheck: post: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkDataDTO minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkDataDTO minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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/exportActivityBranches: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportCompanyGroups: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportPriceTable: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportCarrier: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportPaymentTerms: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportOpportunityType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportPaymentType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportDeposit: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportProduct: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportService: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportAccountType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportCities: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportStates: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/queries/exportCountries: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: 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/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/importActivityBranches: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importCompanyGroups: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importPriceTable: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importCarrier: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importPaymentTerms: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importOpportunityType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importPaymentType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importDeposit: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importService: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importAccountType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importCities: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importStates: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importCountries: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 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/recordActivityBranches 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/recordCompanyGroups 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/recordPriceTable 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/recordCarrier 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/recordPaymentTerms 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/recordOpportunityType 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/recordPaymentType 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/recordDeposit 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/recordProduct 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/recordService 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/recordActivityBranches 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/recordCompanyGroups 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/recordPriceTable 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/recordCarrier 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/recordPaymentTerms 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/recordOpportunityType 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/recordPaymentType 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/recordDeposit 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/recordProduct 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/recordService description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importActivityBranchesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportActivityBranchesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importCompanyGroupsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportCompanyGroupsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importPriceTableEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportPriceTableEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importCarrierEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportCarrierEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importPaymentTermsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportPaymentTermsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importOpportunityTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportOpportunityTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importPaymentTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportPaymentTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importDepositEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportDepositEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importServiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportServiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importAccountTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportAccountTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importCitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportCitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importStatesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportStatesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importCountriesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/exportCountriesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/entities/activityBranches: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/activityBranches/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/activityBranches/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activityBranches responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyGroups: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyGroups/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/companyGroups/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyGroups responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/priceTable: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/priceTable/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/priceTable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/priceTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/carrier: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/carrier/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/carrier responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/carrier responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/carrier/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/carrier responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentTerms: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentTerms/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/paymentTerms/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentTerms responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityType/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/opportunityType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentType/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/paymentType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/deposit: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/deposit/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposit responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposit responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/deposit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deposit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/product: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/product/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/product/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/service: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/service/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/service responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/service responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/service/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/service responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountType responses: 200: description: The created resource schema: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountType responses: 200: description: The created resource schema: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountType/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: Ok schema: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountType responses: 200: description: Ok schema: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/accountType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/cities: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cities responses: 200: description: The created resource schema: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cities responses: 200: description: The created resource schema: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/cities/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: Ok schema: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cities responses: 200: description: Ok schema: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/cities/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cities responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/states: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/states responses: 200: description: The created resource schema: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/states responses: 200: description: The created resource schema: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/states/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/states responses: 200: description: Ok schema: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/states responses: 200: description: Ok schema: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/states/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/states responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/countries: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/countries responses: 200: description: The created resource schema: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/countries responses: 200: description: The created resource schema: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/countries/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: Ok schema: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countries responses: 200: description: Ok schema: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/countries/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/countries responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: 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 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recCompany: description: Record de empresa type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recCompanyBranch: description: Record de empresa/filial type: object properties: id: type: integer format: int64 description: Código de identificação no CRM companyErp: type: string maxLength: 50 description: Código de identificação da empresa no sistema terceiro branchErp: type: string maxLength: 50 description: Código de identificação da filial no sistema terceiro recProductCategory: description: Categorias do produto type: object properties: id: type: integer format: int64 description: Código de identificação da categoria de produto no CRM idErp: type: string maxLength: 50 description: Código de identificação da categoria de produto no sistema terceiro recUnitMeasurement: description: Unidade de medida type: object properties: id: type: integer format: int64 description: Código de identificação da unidade de medida no CRM acronym: type: string maxLength: 3 description: Sigla que identifica a unidade de medida recServiceCategory: description: Categoria de serviço type: object properties: id: type: integer format: int64 description: Código de identificação da categoria de produto no CRM idErp: type: string maxLength: 50 description: Código de identificação da categoria de produto no sistema terceiro checkDataDTO: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recordActivityBranches: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 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 description: Campos customizados recordCompanyGroups: description: Grupo de empresas type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recCompany description: Empresa active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string description: Campos customizados recordPriceTable: description: Tabela de preço type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados recordCarrier: description: Transportadora type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a transportadora está ativa no sistema default: true customFields: type: string description: Campos customizados recordPaymentTerms: description: Prazo de pagamento type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recCompany description: Empresa active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados recordOpportunityType: description: Tipo de oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema default: true note: type: string description: Observações customFields: type: string description: Campos customizados recordPaymentType: description: Tipo de pagamento type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados recordDeposit: description: Depósito type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados recordProduct: description: Produto type: object properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recCompany description: Empresa name: type: string maxLength: 50 description: Descritivo do grupo de empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro derivationPartNumber: type: string maxLength: 45 description: Identificador da derivação do produto no sistema terceiro derivationName: type: string maxLength: 100 description: Descritivo da derivação do produto productCategory: type: object allOf: – #/definitions/recProductCategory description: Categoria do produto unitMeasurement: type: object allOf: – #/definitions/recUnitMeasurement 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: integer format: int64 description: Informativo do tipo de venda padrão para o produto 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 description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma recordService: description: Serviço type: object required: – serviceCategory properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recCompany description: Empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro name: type: string maxLength: 255 description: Descritivo do grupo de empresa serviceCategory: type: object allOf: – #/definitions/recServiceCategory description: Categoria do serviço unitMeasurement: type: object allOf: – #/definitions/recUnitMeasurement 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 note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma recordState: description: Estado type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 50 description: Nome initials: type: string maxLength: 2 description: Iniciais recordCountry: description: País type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 50 description: Nome activityBranches: description: Entidade fachada Ramo de atividade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 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 description: Campos customizados companyGroups: description: Entidade fachada Grupo de empresa type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recCompany description: Empresa active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string description: Campos customizados priceTable: description: Entidade fachada Tabela de preço type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados carrier: description: Entidade fachada Transportadora type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a transportadora está ativa no sistema default: true customFields: type: string description: Campos customizados paymentTerms: description: Entidade fachada Prazo de pagamento type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recCompany description: Empresa active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados opportunityType: description: Entidade fachada Tipo de oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema default: true note: type: string description: Observações customFields: type: string description: Campos customizados paymentType: description: Entidade fachada Tipo de pagamento type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados deposit: description: Entidade fachada Depósito type: object properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados product: description: Entidade fachada Produto type: object properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recCompany description: Empresa name: type: string maxLength: 50 description: Descritivo do grupo de empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro derivationPartNumber: type: string maxLength: 45 description: Identificador da derivação do produto no sistema terceiro derivationName: type: string maxLength: 100 description: Descritivo da derivação do produto productCategory: type: object allOf: – #/definitions/recProductCategory description: Categoria do produto unitMeasurement: type: object allOf: – #/definitions/recUnitMeasurement 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: integer format: int64 description: Informativo do tipo de venda padrão para o produto 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 description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma service: description: Entidade fachada Serviço type: object required: – serviceCategory properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recCompany description: Empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro name: type: string maxLength: 255 description: Descritivo do grupo de empresa serviceCategory: type: object allOf: – #/definitions/recServiceCategory description: Categoria do serviço unitMeasurement: type: object allOf: – #/definitions/recUnitMeasurement 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 note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma accountType: description: Entidade fachada Tipo de conta type: object required: – name – active – icon – color properties: id: type: integer format: int64 description: Código de identificação do CRM name: type: string maxLength: 50 description: Nome active: type: boolean description: Indicador se o registro está ativo icon: type: string maxLength: 50 description: Ícone que será exibido color: type: string maxLength: 50 description: Cor do ícone que será exibido customFields: type: string description: Campos customizados cities: description: Entidade fachada Cidade type: object required: – name – active – state – country properties: id: type: integer format: int64 description: Código de identificação ibgeCode: type: integer format: int64 description: Código IBGE name: type: string maxLength: 50 description: Nome active: type: boolean description: Indicador se o registro está ativo dddCode: type: integer format: int64 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 pib: type: number format: double description: PIB customFields: type: string description: Campos customizados state: type: object allOf: – #/definitions/recordState description: Estado country: type: object allOf: – #/definitions/recordCountry description: País states: description: Entidade fachada Estado type: object required: – country – name – active – initials properties: id: type: integer format: int64 description: Código de identificação country: type: object allOf: – #/definitions/recordCountry description: País name: type: string maxLength: 50 description: Nome active: type: boolean description: Indicador se o registro está ativo initials: type: string maxLength: 2 description: Iniciais customFields: type: string description: Campos customizados countries: description: Entidade fachada País type: object required: – name – active properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 50 description: Nome active: type: boolean description: Indicador se o registro está ativo customFields: type: string description: Campos customizados 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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 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