Replicação de dados (replicacao)

2.0info: 0.1.6 Replicação de dados description: Serviço que replicará os dados de outros serviços da Senior X para o TMSX x-senior-domain: TMSX Foundation x-senior-domain-path: tmsx_fnd x-senior-service-path: replicacao 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/tmsx_fndsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /replicacao/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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData 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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/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 /replicacao/queries/exportPais: 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 /replicacao/queries/exportEstado: 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 /replicacao/queries/exportCidade: 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 /replicacao/queries/exportFilial: 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 /replicacao/queries/exportFilialFiscal: 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 /replicacao/queries/exportEmpresa: 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 /replicacao/queries/exportPessoa: 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 /replicacao/queries/exportPessoaCliente: 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 /replicacao/queries/exportPessoaEndereco: 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 /replicacao/queries/exportCep: 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 /replicacao/queries/exportFinalidadeCompraVenda: 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 /replicacao/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 /replicacao/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 /replicacao/actions/importPais: 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 /replicacao/actions/importEstado: 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 /replicacao/actions/importCidade: 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 /replicacao/actions/importFilial: 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 /replicacao/actions/importFilialFiscal: 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 /replicacao/actions/importEmpresa: 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 /replicacao/actions/importPessoa: 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 /replicacao/actions/importPessoaCliente: 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 /replicacao/actions/importPessoaEndereco: 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 /replicacao/actions/importCep: 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 /replicacao/actions/importFinalidadeCompraVenda: 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 /replicacao/events/importPaisEvent: 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 /replicacao/events/exportPaisEvent: 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 /replicacao/events/importEstadoEvent: 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 /replicacao/events/exportEstadoEvent: 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 /replicacao/events/importCidadeEvent: 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 /replicacao/events/exportCidadeEvent: 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 /replicacao/events/importFilialEvent: 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 /replicacao/events/exportFilialEvent: 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 /replicacao/events/importFilialFiscalEvent: 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 /replicacao/events/exportFilialFiscalEvent: 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 /replicacao/events/importEmpresaEvent: 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 /replicacao/events/exportEmpresaEvent: 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 /replicacao/events/importPessoaEvent: 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 /replicacao/events/exportPessoaEvent: 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 /replicacao/events/importPessoaClienteEvent: 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 /replicacao/events/exportPessoaClienteEvent: 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 /replicacao/events/importPessoaEnderecoEvent: 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 /replicacao/events/exportPessoaEnderecoEvent: 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 /replicacao/events/importCepEvent: 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 /replicacao/events/exportCepEvent: 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 /replicacao/events/importFinalidadeCompraVendaEvent: 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 /replicacao/events/exportFinalidadeCompraVendaEvent: 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 /replicacao/apis/pais: get: description: País tags: – APIS 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/paisFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pais/{id}: get: description: País tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paisFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/estado: get: description: Estado tags: – APIS 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/estadoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/estado/{id}: get: description: Estado tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/estadoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/cidade: get: description: Cidade tags: – APIS 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/cidadeFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/cidade/{id}: get: description: Cidade tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cidadeFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/empresa: get: description: Empresa tags: – APIS 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/empresaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/empresa/{id}: get: description: Empresa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/filial: get: description: Filial tags: – APIS 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/filialFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/filial/{id}: get: description: Filial tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filialFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/filialFiscal: get: description: Filial Fiscal tags: – APIS 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/filialFiscalFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/filialFiscal/{id}: get: description: Filial Fiscal tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filialFiscalFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoa: post: description: Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pessoaFacadeInput responses: 200: description: Ok schema: #/definitions/pessoaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pessoa tags: – APIS 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/pessoaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoa/{id}: get: description: Pessoa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoaCliente: get: description: Pessoa Cliente tags: – APIS 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/pessoaClienteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoaCliente/{id}: get: description: Pessoa Cliente tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoaClienteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoaEndereco: get: description: Pessoa Endereço tags: – APIS 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/pessoaEnderecoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/pessoaEndereco/{id}: get: description: Pessoa Endereço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoaEnderecoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/cep: get: description: tags: – APIS 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/cepFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/finalidadeCompraVenda: get: description: Finalidade de Compra e Venda tags: – APIS 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/finalidadeCompraVendaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/apis/finalidadeCompraVenda/{id}: get: description: Finalidade de Compra e Venda tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/finalidadeCompraVendaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/entities/pessoa: 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 responses: 200: description: Ok schema: type: array items: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/entities/pessoa/{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/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/entities/cep: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cep responses: 200: description: The created resource schema: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cep responses: 200: description: The created resource schema: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError 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 responses: 200: description: Ok schema: type: array items: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/entities/cep/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cep responses: 200: description: Ok schema: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cep responses: 200: description: Ok schema: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError 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/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /replicacao/entities/cep/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cep responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumUpDown: description: Up or down type: string enum: – UP – DOWN enumTipoPessoa: description: Tipo da pessoa type: string enum: – PESSOA_JURIDICA – PESSOA_FISICA enumTipoMercado: description: Tipo de mercado type: string enum: – MERCADO_INTERNO – MERCADO_EXTERNO enumRamoAtividade: description: Tipo do ramo de atividade type: string enum: – INDUSTRIA – COMERCIO – DISTRIBUIDOR – TRANSPORTADOR_REVENDEDOR_RETALHISTA – EXTRACAO_MINERAL_OUTROS – INDUSTRIA_TRANSPORTE – PRODUTOR_RURAL – PRESTADOR_SERVICO – ATIVIDADE_FINANCEIRA – ATIVIDADE_IMOBILIARIA – COOPERATIVA – SOCIEDADE_SEGURADORES_PREVIDENCIA_COMPLEMENTAR – DISTRIBUIDOR_ENERGIA_ELETRICA – PRESTADOR_SERVICO_COMUNICACAO – OUTROS enumCodRegimeTributario: description: Código do regime tributário type: string enum: – SIMPLES_NACIONAL – SIMPLES_NACIONAL_EXCESSO – REGIME_NORMAL 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 recCheckData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/enumUpDown description: Status do healthcheck recFacadePaisOutput: description: Dados referente ao País type: object required: – codigo – codigoIso – nome – mercosul properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeEstadoOutput: description: Dados referente ao Estado type: object required: – codigo – nome – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/recFacadePaisOutput description: País excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeCidadeOutput: description: Dados referente a Cidade type: object required: – codigo – nome – estado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeEmpresaOutput: description: Dados referente a Empresa type: object required: – codigo – nome – sigla – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa sigla: type: string description: Nome fantasia da empresa pais: type: object allOf: – #/definitions/recFacadePaisOutput description: País excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação ativoTmsx: type: boolean description: Situação default: true recFacadePessoaOutput: description: Dados referentes a Pessoa type: object required: – codigo – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string description: Id da pessoa codigo: type: integer format: int64 description: Código nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumRamoAtividade description: Tipo do ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro ativo: type: boolean description: Situação default: true pessoaCliente: type: string description: Cliente createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeCepOutput: description: Dados referente ao Cep type: object required: – codigo properties: codigo: type: string maxLength: 20 description: Código cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade distrito: type: string maxLength: 90 description: distrito bairro: type: string maxLength: 90 description: bairro logradouro: type: string maxLength: 100 description: Logradouro recListaCepSourceResult: description: Lista Cep por fonte de Dados type: object required: – source – totalPages – totalElements – contents properties: source: type: string maxLength: 20 description: Source totalPages: type: integer format: int64 description: Total Pages totalElements: type: integer format: int64 description: Total elements contents: type: array items: type: object allOf: – #/definitions/recFacadeCepOutput minimum: 1 description: Contents pais: description: País type: object required: – codigo – codigoIso – nome – mercosul properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: estado: description: Estado type: object required: – codigo – nome – pais properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cidade: description: Cidade type: object required: – codigo – nome – estado properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/estado description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Filial type: object required: – empresa – codigo – nome – sigla properties: id: type: string format: uuid description: Id da entidade empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: integer format: int64 description: Código filial nome: type: string description: Nome filial sigla: type: string description: Nome Fantasia filial numeroCgc: type: string description: CPF/CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: object allOf: – #/definitions/cidade description: Cidade estado: type: object allOf: – #/definitions/estado description: Estado telefone: type: string description: Telefone matriz: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído default: false filialFiscal: type: object allOf: – #/definitions/filialFiscal description: Filial Fiscal extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração filialComoPessoa: type: object allOf: – #/definitions/pessoa description: Filial como pessoa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filialFiscal: description: Filial Fiscal type: object required: – codigoRegimeTributario properties: id: type: string format: uuid description: Id da entidade codigoRegimeTributario: type: string allOf: – #/definitions/enumCodRegimeTributario description: Codigo do Regime Tributário filial: type: object allOf: – #/definitions/filial description: Filial excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: empresa: description: Empresa type: object required: – codigo – nome – sigla – pais properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código empresa nome: type: string description: Nome empresa sigla: type: string description: Nome fantasia empresa pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração ativoTmsx: type: boolean description: Situação default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoa: description: Pessoa type: object required: – codigo – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumRamoAtividade description: Tipo de ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro pais: type: object allOf: – #/definitions/pais description: Pais estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade emailsEletronicos: type: string description: E-mails Eletrônicos ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaCliente: description: Cliente type: object properties: id: type: string format: uuid description: Id da entidade ativo: type: boolean description: Situação do cliente default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaEndereco: description: Endereço da pessoa type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa aceitaEntrega: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true aceitaCobranca: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false aceitaColeta: type: boolean description: Indica se o endereço é utilizado para coleta default: false cepCodigo: type: string maxLength: 20 description: Código Postal endereco: type: string maxLength: 100 description: Endereço enderecoNumero: type: string maxLength: 60 description: Número enderecoComplemento: type: string maxLength: 200 description: Complemento bairro: type: string maxLength: 75 description: Bairro enderecoPontoReferencia: type: string maxLength: 200 description: Ponto de referência pais: type: object allOf: – #/definitions/pais description: Pais estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cep: description: CEP type: object required: – codigo – cidade properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 20 description: Código cidade: type: object allOf: – #/definitions/cidade description: Cidade distrito: type: string maxLength: 90 description: distrito bairro: type: string maxLength: 90 description: bairro logradouro: type: string maxLength: 100 description: Logradouro extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: finalidadeCompraVenda: description: Tabelas – Finalidade de compra e venda type: object required: – descricao – codigo properties: id: type: string format: uuid description: Id da entidade descricao: type: string maxLength: 80 description: Descrição codigo: type: integer format: int64 description: Código da Finalidade minimum: 0 maximum: 9999 ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: 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. 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 paisFacadeInput: description: País type: object required: – codigo – codigoIso – nome properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome paisFacadeOutput: description: País type: object required: – codigo – codigoIso – nome – mercosul properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação estadoFacadeInput: description: Estado type: object required: – codigo – nome – idPais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome idPais: type: string description: Id da entidade Pais estadoFacadeOutput: description: Estado type: object required: – codigo – nome – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/recFacadePaisOutput description: País excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação cidadeFacadeInput: description: Cidade type: object required: – codigo – nome – idEstado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade idEstado: type: string description: Id da entidade Estado codigoIbge: type: integer format: int64 description: Código IBGE município cidadeFacadeOutput: description: Cidade type: object required: – codigo – nome – estado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação empresaFacadeInput: description: Empresa type: object required: – codigo – nome – sigla – paisId properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa sigla: type: string description: Nome fantasia da empresa paisId: type: string description: Id da entidade Pais ativoTmsx: type: boolean description: Situação default: true empresaFacadeOutput: description: Empresa type: object required: – codigo – nome – sigla – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa sigla: type: string description: Nome fantasia da empresa pais: type: object allOf: – #/definitions/recFacadePaisOutput description: Id da entidade Pais excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação ativoTmsx: type: boolean description: Situação default: true filialFacadeInput: description: Filial type: object required: – empresaId – codigo – nome – sigla properties: id: type: string description: Id da entidade empresaId: type: string description: Empresa codigo: type: integer format: int64 description: Filial nome: type: string description: Nome sigla: type: string description: Fantasia numeroCgc: type: string description: CPF/CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal codigoPostal: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro cidadeId: type: string description: Cidade estadoId: type: string description: Estado telefone: type: string description: Telefone matriz: type: boolean description: Filial matriz filialComoPessoa: type: string description: Filial com pessoa filialFacadeOutput: description: Filial type: object required: – empresa – codigo – nome – sigla properties: id: type: string description: Id da entidade empresa: type: object allOf: – #/definitions/recFacadeEmpresaOutput description: Empresa codigo: type: integer format: int64 description: Filial nome: type: string description: Nome sigla: type: string description: Fantasia numeroCgc: type: string description: CPF/CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal codigoPostal: type: string description: Código Postal cepCodigo: type: string description: CEP endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado telefone: type: string description: Telefone matriz: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação filialComoPessoa: type: object allOf: – #/definitions/recFacadePessoaOutput description: Filial com pessoa filialFiscalFacadeInput: description: Filial Fiscal type: object properties: id: type: string description: Id da entidade filialFiscalFacadeOutput: description: Filial Fiscal type: object properties: id: type: string description: Id da entidade codigoRegimeTributario: type: string allOf: – #/definitions/enumCodRegimeTributario description: Código do Regime Tributário excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação pessoaFacadeInput: description: Pessoa type: object required: – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string description: Id da pessoa codigo: type: integer format: int64 description: Código nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumRamoAtividade description: Tipo de ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro ativo: type: boolean description: Situação default: true pessoaCliente: type: string description: Cliente emailsEletronicos: type: string description: E-mails Eletrônicos pessoaFacadeOutput: description: Pessoa type: object required: – codigo – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string description: Id da pessoa codigo: type: integer format: int64 description: Código nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumRamoAtividade description: Tipo de ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado pais: type: object allOf: – #/definitions/recFacadePaisOutput description: Pais enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro ativo: type: boolean description: Situação default: true pessoaCliente: type: string description: Cliente emailsEletronicos: type: string description: E-mails Eletrônicos createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação pessoaClienteFacadeInput: description: Pessoa Cliente type: object required: – codigo properties: id: type: string description: Id pessoa cliente codigo: type: integer format: int64 description: Código ativo: type: boolean description: Ativo default: true pessoaClienteFacadeOutput: description: Pessoa Cliente type: object required: – codigo properties: id: type: string description: Id da pessoa cliente codigo: type: integer format: int64 description: Código ativo: type: boolean description: Ativo default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação pessoaEnderecoFacadeInput: description: Pessoa Endereço type: object properties: id: type: string description: Id pessoa endereço pessoaId: type: string description: Pessoa aceitaEntrega: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true aceitaCobranca: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false aceitaColeta: type: boolean description: Indica se o endereço é utilizado para coleta default: false cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro enderecoPontoReferencia: type: string description: Ponto de referência pais: type: string description: Pais estado: type: string description: Estado cidade: type: string description: Cidade ativo: type: boolean description: Situação default: true pessoaEnderecoFacadeOutput: description: Pessoa Endereço type: object properties: id: type: string description: Id pessoa endereço pessoa: type: string description: Pessoa aceitaEntrega: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true aceitaCobranca: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false aceitaColeta: type: boolean description: Indica se o endereço é utilizado para coleta default: false cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro enderecoPontoReferencia: type: string description: Ponto de referência pais: type: string description: Pais estado: type: string description: Estado cidade: type: string description: Cidade ativo: type: boolean description: Situação default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação cepFacadeInput: description: type: object required: – codigo properties: codigo: type: string maxLength: 20 description: Código cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade distrito: type: string maxLength: 90 description: distrito bairro: type: string maxLength: 90 description: bairro logradouro: type: string maxLength: 100 description: Logradouro cepFacadeOutput: description: type: object required: – source – totalPages – totalElements – contents properties: source: type: string maxLength: 20 description: Source totalPages: type: integer format: int64 description: Total Pages totalElements: type: integer format: int64 description: Total elements contents: type: array items: type: object allOf: – #/definitions/recFacadeCepOutput minimum: 1 description: Contents finalidadeCompraVendaFacadeInput: description: Finalidade de Compra e Venda type: object required: – descricao – codigo properties: id: type: string description: Id da entidade descricao: type: string maxLength: 80 description: Descrição codigo: type: integer format: int64 description: Código da Finalidade minimum: 0 maximum: 9999 ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false finalidadeCompraVendaFacadeOutput: description: Finalidade de Compra e Venda type: object required: – descricao – codigo properties: id: type: string description: Id da entidade descricao: type: string maxLength: 80 description: Descrição codigo: type: integer format: int64 description: Código da Finalidade ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação 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