2.0info: 1.17.0 cotacao_precos_database description: Serviço de database da cotação de preços x-senior-domain: Domínio de Cotação de Preços x-senior-domain-path: erpx_cot x-senior-service-path: cotacao_precos_database 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/erpx_cotsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cotacao_precos_database/queries/healthcheck: post: description: Query para o SRE 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/checkData 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 SRE 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/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/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 /cotacao_precos_database/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE073pes: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE006pai: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE007ufs: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE008rai: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE001end: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE095pes: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE070ent: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE075der: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE012fam: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE083ori: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE015med: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE075derSupEst: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/queries/exportE028cpg: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /cotacao_precos_database/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 /cotacao_precos_database/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/migrateSchemaReport: post: description: Executa a migração da base de relatórios para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base de relatórios migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base de relatórios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE073pes: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE006pai: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE007ufs: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE008rai: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE001end: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE095pes: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE070ent: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE075der: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE012fam: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE083ori: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE015med: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE075derSupEst: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/actions/importE028cpg: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /cotacao_precos_database/events/importE070empEvent: 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 /cotacao_precos_database/events/exportE070empEvent: 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 /cotacao_precos_database/events/importE001pesEvent: 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 /cotacao_precos_database/events/exportE001pesEvent: 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 /cotacao_precos_database/events/importE073pesEvent: 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 /cotacao_precos_database/events/exportE073pesEvent: 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 /cotacao_precos_database/events/importE006paiEvent: 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 /cotacao_precos_database/events/exportE006paiEvent: 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 /cotacao_precos_database/events/importE007ufsEvent: 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 /cotacao_precos_database/events/exportE007ufsEvent: 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 /cotacao_precos_database/events/importE008raiEvent: 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 /cotacao_precos_database/events/exportE008raiEvent: 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 /cotacao_precos_database/events/importE001endEvent: 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 /cotacao_precos_database/events/exportE001endEvent: 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 /cotacao_precos_database/events/importE095pesEvent: 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 /cotacao_precos_database/events/exportE095pesEvent: 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 /cotacao_precos_database/events/importE070filEvent: 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 /cotacao_precos_database/events/exportE070filEvent: 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 /cotacao_precos_database/events/importE070entEvent: 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 /cotacao_precos_database/events/exportE070entEvent: 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 /cotacao_precos_database/events/importE075derEvent: 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 /cotacao_precos_database/events/exportE075derEvent: 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 /cotacao_precos_database/events/importE012famEvent: 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 /cotacao_precos_database/events/exportE012famEvent: 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 /cotacao_precos_database/events/importE083oriEvent: 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 /cotacao_precos_database/events/exportE083oriEvent: 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 /cotacao_precos_database/events/importE015medEvent: 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 /cotacao_precos_database/events/exportE015medEvent: 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 /cotacao_precos_database/events/importE075derSupEstEvent: 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 /cotacao_precos_database/events/exportE075derSupEstEvent: 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 /cotacao_precos_database/events/importE028cpgEvent: 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 /cotacao_precos_database/events/exportE028cpgEvent: 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 /cotacao_precos_database/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e001pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e001pes/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e073pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e073pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e073pes/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e073pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e006pai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e006pai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e007ufs: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e007ufs/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e008rai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e008rai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e001end: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e001end/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e095pes: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e095pes/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e070ent: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070ent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e070ent/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070ent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e012fam: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e012fam/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e083ori: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e083ori 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cotacao_precos_database/entities/e083ori/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e083ori 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumJurFis: description: Tipo da pessoa type: string enum: – VJ – VF enumIndNif: description: Tipo do número de identificação fiscal type: string enum: – V1 – V2 – V3 enumTipMer: description: Tipo de mercado type: string enum: – VI – VE enumTipEmp: description: Tipo de empresa type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumZonFra: description: Indicativo de qual o benefício fiscal do cliente type: string enum: – V0 – V1 – V2 – V3 – V4 enumSitReg: description: Situação do registro type: string enum: – VA – VI enumTipEnd: description: Tipo de endereço type: string enum: – V3 – V4 enumIndOba: description: Indicativo de prestação de serviços em obra de construção civil type: string enum: – V0 – V1 – V2 enumTipEmc: description: Tipo do direito de propriedade do cliente type: string enum: – V1 – V2 enumIndFor: description: Tipo do fornecedor type: string enum: – VM – VP – VA enumAplMot: description: Aplicação do motivo type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V36 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 – V50 – V51 – V52 – V53 – V99 enumProEpe: description: Enquadramento de produto específico type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V9 enumTipPro: description: tipo de produto type: string enum: – VP – VC – VS enumCifFob: description: Tipo de frete da transportadora type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 enumTipoOrigem: description: Tipo da origem da entidade type: string enum: – USUARIO – SENIOR – PARCEIRO enumCtrVld: description: Indicativo de tipo de controle de validade type: string enum: – VO – VD – VL enumAplCpg: description: Enumeração de aplicação da condição de pagamento type: string enum: – VV – VC – VA enumDiaEsp: description: Enumeração de dia especial type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – VA – VS – VD – VQ – VM enumTipPar: description: Enumeração do tipo de parcela type: string enum: – V1 – V2 – V3 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 – LOCALDATETIME – 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 checkData: 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 e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa usaAgr: type: boolean description: Utiliza agrupamento filial excluido: type: boolean description: Indica se o registro foi excluído default: false homePage: type: string maxLength: 255 description: Home page extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001pes: description: Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 80 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numRge: type: string maxLength: 15 description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string maxLength: 6 description: Órgão emissor do RG insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal indNif: type: string allOf: – #/definitions/enumIndNif description: Utilização do número de identificação fiscal (NIF) numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado do cliente tipEmp: type: string allOf: – #/definitions/enumTipEmp description: Tipo de ramo de atividade zonFra: type: string allOf: – #/definitions/enumZonFra description: Indicativo de qual o benefício fiscal do cliente codSuf: type: string maxLength: 10 description: Código do SUFRAMA datSuf: type: string format: date description: Validade do registro do SUFRAMA postalCode: type: string maxLength: 20 description: Código Postal endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade cxaPst: type: integer format: int64 description: Caixa postal minimum: 0 maximum: 999999 zipCod: type: string maxLength: 20 description: Zip code fonPes: type: string maxLength: 20 description: Telefone fonPe2: type: string maxLength: 20 description: Telefone 2 faxPes: type: string maxLength: 20 description: Fax intNet: type: string maxLength: 500 description: E-mail emaNfe: type: string maxLength: 100 description: E-mail para envio de documentos eletrônicos sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação e001end: type: array items: type: object allOf: – #/definitions/e001end description: Endereços e073pes: type: object allOf: – #/definitions/e073pes description: Transportadora e095pes: type: object allOf: – #/definitions/e095pes description: Fornecedor excluido: type: boolean description: Indica se o registro foi excluído default: false cpfRes: type: string maxLength: 11 description: CPF do responsável nomRes: type: string maxLength: 100 description: Nome do responsável extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e073pes: description: Transportadora type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa cifFob: type: string allOf: – #/definitions/enumCifFob description: Indicativo se o frete da transportadora é CIF ou FOB nomCto: type: string maxLength: 150 description: Nome da pessoa de contato na transportadora nrnTrc: type: string maxLength: 14 description: Registro nacional de transportadores rodoviários de carga – RNTRC codTaf: type: string maxLength: 12 description: Termo de autorização dos serviços em regime de fretamento – TAF nroRes: type: string maxLength: 25 description: Número de registro adquirido junto a administração estadual sitTra: type: string allOf: – #/definitions/enumSitReg description: Situação da transportadora excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e006pai: description: País type: object properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto entrada paiDir: type: integer format: int64 description: Código do país na DIRF minimum: 0 maximum: 999 paiSis: type: integer format: int64 description: País Siscomex/Siscoserv minimum: 0 maximum: 999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado popCid: type: integer format: int64 description: População minimum: 0 maximum: 999999999 potAlf: type: number format: double description: Potencial consumo minimum: 0.00 maximum: 99.999 locGeo: type: string maxLength: 6 description: Localização geográfica cepMin: type: integer format: int64 description: CEP inicial minimum: 0 maximum: 99999999 cepMax: type: integer format: int64 description: CEP final minimum: 0 maximum: 99999999 codFis: type: integer format: int64 description: Código fiscal município minimum: 0 maximum: 9999999 codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001end: description: Endereço da pessoa type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false postalCode: type: string maxLength: 20 description: Código Postal endPes: type: string maxLength: 100 description: Endereço nenEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiEnd: type: string maxLength: 75 description: Bairro prxEnd: type: string maxLength: 200 description: Ponto de referência e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade tipLoc: type: string allOf: – #/definitions/enumTipEnd description: Tipo do local nomRes: type: string maxLength: 50 description: Nome do responsável tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF insEst: type: string maxLength: 25 description: Inscrição estadual fonRes: type: string maxLength: 21 description: Telefone celRes: type: string maxLength: 22 description: Celular faxRes: type: string maxLength: 20 description: Fax emaRes: type: string maxLength: 100 description: E-mail indOba: type: string allOf: – #/definitions/enumIndOba description: Indicativo de prestação de serviços em obra de construção civil nroCno: type: string maxLength: 21 description: Número de inscrição do cadastro nacional de obra (CNO) sitEnd: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false indCol: type: boolean description: Indica se o endereço é utilizado para coleta default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e095pes: description: Fornecedor type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa marFor: type: string maxLength: 20 description: Marca tipEmc: type: string allOf: – #/definitions/enumTipEmc description: Tipo do direito de propriedade da empresa endNet: type: string maxLength: 200 description: Site arrAbn: type: boolean description: Utilizar a regra de arredondamento da ABNT indFor: type: string allOf: – #/definitions/enumIndFor description: Tipo do fornecedor sitFor: type: string allOf: – #/definitions/enumSitReg description: Situação do fornecedor excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia tipEmp: type: string allOf: – #/definitions/enumTipEmp description: Ramo de atividade tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal insNfs: type: string maxLength: 16 description: Inscrição municipal NFS numIdf: type: string maxLength: 40 description: Número identificação fiscal zonFra: type: string allOf: – #/definitions/enumZonFra description: Indicativo de qual o benefício fiscal da filial codSuf: type: string maxLength: 10 description: Código da empresa/filial junto a Suframa postalCodeFil: type: string maxLength: 20 description: Código Postal endFil: type: string maxLength: 100 description: Endereço nenFil: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiFil: type: string maxLength: 75 description: Bairro e008rai: type: object allOf: – #/definitions/e008rai description: Código cidade ISS cidFil: type: string maxLength: 60 description: Cidade e007ufsSigUfs: type: object allOf: – #/definitions/e007ufs description: Estado postalCodeEnt: type: string maxLength: 20 description: Código Postal endEnt: type: string maxLength: 100 description: Endereço entrega nenEnt: type: string maxLength: 60 description: Número entrega cplEnt: type: string maxLength: 200 description: Complemento entrega cidEnt: type: string maxLength: 60 description: Cidade entrega e007ufsEstEnt: type: object allOf: – #/definitions/e007ufs description: Estado entrega postalCodeCob: type: string maxLength: 20 description: Código Postal endCob: type: string maxLength: 100 description: Endereço cobrança nenCob: type: string maxLength: 60 description: Número cobrança cplCob: type: string maxLength: 200 description: Complemento cobrança baiCob: type: string maxLength: 75 description: Bairro cobrança cidCob: type: string maxLength: 60 description: Cidade cobrança e007ufsEstCob: type: object allOf: – #/definitions/e007ufs description: Estado cobrança numFon: type: string maxLength: 20 description: Telefone numFax: type: string maxLength: 20 description: Fax cxaPst: type: integer format: int64 description: Caixa postal minimum: 0 maximum: 999999 intNet: type: string maxLength: 100 description: E-mail e001pesFilPes: type: object allOf: – #/definitions/e001pes description: Filial como pessoa filMat: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído default: false e070ent: type: array items: type: object allOf: – #/definitions/e070ent description: Endereços Filial extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070ent: description: Endereço de entrega type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false postalCode: type: string maxLength: 20 description: Código Postal endEnt: type: string maxLength: 100 description: Endereço nenEnt: type: string maxLength: 60 description: Número cplEnt: type: string maxLength: 200 description: Complemento baiEnt: type: string maxLength: 75 description: Bairro cidEnt: type: string maxLength: 60 description: Cidade e008raiCidEnt: type: object allOf: – #/definitions/e008rai description: Cidade e007ufsEstEnt: type: object allOf: – #/definitions/e007ufs description: Estado e006paiPaiEnt: type: object allOf: – #/definitions/e006pai description: País sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075der: description: Produto – derivação type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e012fam: type: object allOf: – #/definitions/e012fam description: Família e075derSupEst: type: object allOf: – #/definitions/e075derSupEst description: Cadastros – Produtos – Derivações – Estoque codDer: type: string maxLength: 23 description: Derivação desDer: type: string maxLength: 120 description: Descrição desCpl: type: string maxLength: 255 description: Descrição complementar codBar: type: string maxLength: 14 description: Código de barras codBa2: type: string maxLength: 30 description: Código barras livre codGtn: type: string maxLength: 14 description: Gtin uni. trib idePro: type: string maxLength: 20 description: Identificação produto pesBru: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999.99999 pesLiq: type: number format: double description: Peso líquido minimum: 0.00 maximum: 999999.99999 codRef: type: string maxLength: 40 description: Código da Referência sitDer: type: string allOf: – #/definitions/enumSitReg description: Situação proEpe: type: string allOf: – #/definitions/enumProEpe description: Enquadramento de produto específico excluido: type: boolean description: Indica se o registro foi excluído default: false comprimento: type: number format: double description: Comprimento minimum: 0.00 maximum: 999999.99999 largura: type: number format: double description: Largura minimum: 0.00 maximum: 999999.99999 altura: type: number format: double description: Altura minimum: 0.00 maximum: 999999.99999 extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e012fam: description: Família type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFam: type: string maxLength: 6 description: Código desFam: type: string maxLength: 50 description: Descrição e083ori: type: object allOf: – #/definitions/e083ori description: Origem sitFam: type: string allOf: – #/definitions/enumSitReg description: Situação tipPro: type: string allOf: – #/definitions/enumTipPro description: Tipo produto excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e083ori: description: Origem type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codOri: type: string maxLength: 3 description: Código da origem do produto desOri: type: string maxLength: 40 description: Descrição da origem do produto tipPro: type: string allOf: – #/definitions/enumTipPro description: Tipo produto excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e015med: description: Unidades de Medida type: object properties: id: type: string format: uuid description: Id da entidade uniMed: type: string maxLength: 6 description: Unidade de medida desMed: type: string maxLength: 100 description: Descrição da unidade de medida qtdDec: type: integer format: int64 description: Quantidade Decimais minimum: 0 maximum: 5 tipoOrigem: type: string allOf: – #/definitions/enumTipoOrigem description: Tipo da origem do registro origem: type: string maxLength: 150 description: Tenant de origem do cadastro baseLegal: type: string maxLength: 500 description: Base legal excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075derSupEst: description: Produtos – Estoque type: object properties: id: type: string format: uuid description: Id da entidade e075der: type: object allOf: – #/definitions/e075der description: Produto ctrSep: type: boolean description: Controla p/ Série? ctrLot: type: boolean description: Controla por Lote? ctrVld: type: string allOf: – #/definitions/enumCtrVld description: Controle Validade e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida (estoque) diaVlt: type: integer format: int64 description: Dias Cálculo Validade Lote minimum: 0 maximum: 999999 preMed: type: string description: Valor/Data Preço Médio datMed: type: string format: date description: Data Preço Médio indReq: type: boolean description: Indicativo se o produto pode ser requisitado (movimento estoque) curAbc: type: string maxLength: 1 description: Curva ABC curAb2: type: string maxLength: 1 description: Curva ABC (Valor) curAb3: type: string maxLength: 1 description: Curva ABC (Consumo/Quantidade) curAb4: type: string maxLength: 1 description: Curva ABC (Consumo/Valor) preCus: type: string description: Valor do preço de custo para entrada via produção minimum: 0.00 maximum: 999999999.99999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e028cpg: description: Condição de pagamento – Foundation type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codCpg: type: string maxLength: 6 description: Código da condição de pagamento desCpg: type: string maxLength: 50 description: Descrição da condição de pagamento abrCpg: type: string maxLength: 10 description: Abreviatura aplCpg: type: string allOf: – #/definitions/enumAplCpg description: Aplicação sitCpg: type: string allOf: – #/definitions/enumSitReg description: Situação przMed: type: integer format: int64 description: Prazo Médio minimum: 0 maximum: 999 qtdPar: type: integer format: int64 description: Quantidade Parcelas minimum: 0 maximum: 999 diaEsp: type: string allOf: – #/definitions/enumDiaEsp description: Dia Vencimento Semana tipPar: type: string allOf: – #/definitions/enumTipPar description: Tipo Parcela diaMe1: type: integer format: int64 description: Primeiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 diaMe2: type: integer format: int64 description: Segundo dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 diaMe3: type: integer format: int64 description: Terceiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 31 frePar: type: boolean description: Indicativo se o valor total do frete deve estar na 1ª parcela segPar: type: boolean description: Indicativo se o valor total do seguro deve estar na 1ª parcela embPar: type: boolean description: Indicativo se o valor total das embalagens deve estar na 1ª parcela outPar: type: boolean description: Indicativo se o valor total das outras despesas deve estar na 1ª parcela ipiPar: type: boolean description: Indicativo se o valor total do IPI deve estar na 1ª parcela icmPar: type: boolean description: Indicativo se o valor total do ICMS deve estar na 1ª parcela subPar: type: boolean description: Indicativo se o valor total do ICMS substituído deve estar na 1ª parcela encPar: type: boolean description: Indicativo se o valor total dos encargos deve estar na 1ª parcela issPar: type: boolean description: Indicativo se o valor total do ISS deve estar na 1ª parcela irfPar: type: boolean description: Indicativo se o valor total do irrf deve estar na 1ª parcela diaFix: type: boolean description: Indicativo se o dia do vencimento é fixo para períodos de 30 em 30 dias cprDsc: type: number format: double description: Percentual a acrescentar ou diminuir para formação do preço de venda minimum: -999.99 maximum: 999.99 inssPrimeiraParcela: type: boolean description: Deduzir INSS da 1ª parcela default: false csrfPrimeiraParcela: type: boolean description: Deduzir CSRF da 1ª parcela default: false excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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