erpx_com

PESSOA (pessoa)

51 views 27/02/2020 12/05/2021 integrador 0

2.0info: 1.3.1 PESSOA description: ERPX x-senior-domain: ERPX_COM x-senior-domain-path: erpx_com x-senior-service-path: pessoa 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_comsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pessoa/queries/getDefinitionClientComGer: post: description: Retorna a definição do cliente de comercial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e085pesId – e070filId properties: e085pesId: type: string description: Identificador do cliente e070filId: type: string description: Identificador da filial responses: 200: description: Ok schema: type: object required: – e085hclComGer properties: e085hclComGer: type: object allOf: – #/definitions/e085hclComGer description: Definição do cliente de comercial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do cliente de comercial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: e085pesId description: Identificador do cliente in: query required: true type: string – name: e070filId description: Identificador da filial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e085hclComGer properties: e085hclComGer: type: object allOf: – #/definitions/e085hclComGer description: Definição do cliente de comercial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/getDefinitionRepresentativeComGer: post: description: Retorna a definição do representante de comercial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e090pesId – e070filId properties: e090pesId: type: string description: Identificador do representante e070filId: type: string description: Identificador da filial responses: 200: description: Ok schema: type: object required: – e090hrpComGer properties: e090hrpComGer: type: object allOf: – #/definitions/e090hrpComGer description: Definição do representante de comercial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do representante de comercial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: e090pesId description: Identificador do representante in: query required: true type: string – name: e070filId description: Identificador da filial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e090hrpComGer properties: e090hrpComGer: type: object allOf: – #/definitions/e090hrpComGer description: Definição do representante de comercial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/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 /pessoa/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 /pessoa/queries/exportE001end: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE001pes: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE006pai: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE007ufs: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE008cep: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE008rai: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE028cpg: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE064cat: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE066fpg: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE067fin: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE073pes: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE081tab: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE085pes: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE090pes: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE017rve: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE090hrpComGer: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE085hclComGer: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE069gre: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/exportE021mot: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /pessoa/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 /pessoa/actions/importE001end: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE001pes: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE006pai: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE007ufs: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE008cep: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE008rai: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE028cpg: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE064cat: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE066fpg: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE067fin: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE073pes: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE081tab: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE085pes: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE090pes: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE017rve: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE090hrpComGer: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE085hclComGer: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE069gre: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/actions/importE021mot: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e001end: get: description: This entity is customizable. 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/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e001end/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e001pes: get: description: This entity is customizable. 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e001pes/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e006pai: get: description: This entity is customizable. 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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e006pai/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e007ufs: get: description: This entity is customizable. 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e007ufs/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e008cep: get: description: This entity is customizable. 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/e008cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e008cep/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e008rai: get: description: This entity is customizable. 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e008rai/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e028cpg: get: description: This entity is customizable. 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/e028cpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e028cpg/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e028cpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e064cat: get: description: This entity is customizable. 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/e064cat 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e064cat/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e064cat 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e066fpg: get: description: This entity is customizable. 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/e066fpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e066fpg/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e066fpg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e067fin: get: description: This entity is customizable. 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/e067fin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e067fin/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e067fin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e070emp: get: description: This entity is customizable. 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e070emp/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e073pes: get: description: This entity is customizable. 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/e073pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e073pes/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e070fil: get: description: This entity is customizable. 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e070fil/{id}: get: description: This entity is customizable. 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 /pessoa/entities/e081tab: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e081tab responses: 200: description: The created resource schema: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e081tab responses: 200: description: The created resource schema: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e081tab/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e081tab responses: 200: description: Ok schema: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e081tab responses: 200: description: Ok schema: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e081tab 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /pessoa/entities/e081tab/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e081tab responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e085pes: get: description: This entity is customizable. 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/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e085pes/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e090pes: get: description: This entity is customizable. 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/e090pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e090pes/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e090pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e017rve: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e017rve responses: 200: description: The created resource schema: #/definitions/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e017rve responses: 200: description: The created resource schema: #/definitions/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e017rve/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e017rve responses: 200: description: Ok schema: #/definitions/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e017rve responses: 200: description: Ok schema: #/definitions/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e017rve 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /pessoa/entities/e017rve/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e017rve responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e090hrpComGer: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e090hrpComGer responses: 200: description: The created resource schema: #/definitions/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e090hrpComGer responses: 200: description: The created resource schema: #/definitions/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e090hrpComGer/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e090hrpComGer responses: 200: description: Ok schema: #/definitions/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e090hrpComGer responses: 200: description: Ok schema: #/definitions/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e090hrpComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /pessoa/entities/e090hrpComGer/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e090hrpComGer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e085hclComGer: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e085hclComGer responses: 200: description: The created resource schema: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e085hclComGer responses: 200: description: The created resource schema: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e085hclComGer/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e085hclComGer responses: 200: description: Ok schema: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e085hclComGer responses: 200: description: Ok schema: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e085hclComGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /pessoa/entities/e085hclComGer/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e085hclComGer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e069gre: get: description: This entity is customizable. 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/e069gre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e069gre/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e069gre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e021mot: get: description: This entity is customizable. 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/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pessoa/entities/e021mot/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumDiaEsp: description: Dia da semana para vencimento parcelas type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – VA – VS – VD – VQ – VM enumAntPos: description: Critério para vencimento das parcelas type: string enum: – VA – VS – VN – VU enumAplMot: description: Aplicações 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 enumJurFis: description: Tipo da pessoa type: string enum: – VJ – VF enumTipMer: description: Tipo de mercado type: string enum: – VI – VE enumSitReg: description: Situação do registro type: string enum: – VA – VI enumTipEmc: description: Tipo do direito de propriedade do cliente type: string enum: – V1 – V2 enumTipAce: description: Tipo de acerto type: string enum: – V1 – V2 enumAplCpg: description: Aplicação da condição de pagamento type: string enum: – VV – VC – VA enumCifFob: description: Tipo de frete type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 enumIndPre: description: Indicativo presencial do consumidor type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V9 enumTipEqf: description: Tipo type: string enum: – V0 – V1 – V2 – V3 enumAplSnf: description: Aplicação type: string enum: – VS – VM – VE – VF – VD enumUtiImpCurto: description: Forma de integração para controladoria type: string enum: – VS – VN – VO enumDisAut: description: Dispositivo autorizado type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 enumCatRep: description: Categoria do representante type: string enum: – VMAT – VREP – VVEN – VOPE – VSUB – VGER – VDIS – VDIR – VGRE – VASS – VCRE – VCAI – VPRE – VSUP – VGEC – VANS – VGES upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 e001end: description: Endereço de 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 indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança e008cep: type: object allOf: – #/definitions/e008cep description: CEP 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 sitEnd: type: string allOf: – #/definitions/enumSitReg description: Situaçã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: Pessoa minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 50 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) insEst: type: string maxLength: 25 description: Inscrição estadual e073pes: type: object allOf: – #/definitions/e073pes description: Transportadora e085pes: type: object allOf: – #/definitions/e085pes description: Cliente e090pes: type: object allOf: – #/definitions/e090pes description: Representante e069gre: type: object allOf: – #/definitions/e069gre description: Grupo Empresas e008rai: type: object allOf: – #/definitions/e008rai description: Rai insMun: type: string maxLength: 16 description: Inscrição Municipal numRge: type: string maxLength: 13 description: Número/Órgão/Data RG orgRge: type: string maxLength: 6 description: Órgão Emissor RG datRge: type: string format: date description: Data Emissão RG datNas: type: string format: date description: Data Nascimento tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado do cliente excluido: type: boolean description: Excluído default: false endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 100 description: Numero cplEnd: type: string maxLength: 100 description: Complemento nomBai: type: string maxLength: 100 description: Nome do bairro e006pai: type: object allOf: – #/definitions/e006pai description: País e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008cep: type: object allOf: – #/definitions/e008cep description: CEP 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 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008cep: description: Tabelas – CEP type: object properties: id: type: string format: uuid description: Id da entidade cepIni: type: integer format: int64 description: CEP endereço minimum: 0 maximum: 99999999 baiEnd: type: string maxLength: 75 description: Bairro logEnd: type: string maxLength: 255 description: Logradouro e008rai: type: object allOf: – #/definitions/e008rai description: Cidade 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 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 type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Código da 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 da condição de pagamento aplCpg: type: string allOf: – #/definitions/enumAplCpg description: Aplicação da condição de pagamento sitCpg: type: string allOf: – #/definitions/enumSitReg description: Situação da condição de pagamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e064cat: description: Tabelas – categorias para clientes type: object properties: id: type: string format: uuid description: Id da entidade catCli: type: integer format: int64 description: Categoria do cliente minimum: 0 maximum: 999 nomCat: type: string maxLength: 40 description: Nome usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e066fpg: description: Forma de pagamento type: object required: – codFpg properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFpg: type: integer format: int64 description: Código forma pagamento minimum: 0 maximum: 99 desFpg: type: string maxLength: 30 description: Descrição sitFpg: type: string allOf: – #/definitions/enumSitReg description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e067fin: description: Finalidade de compra type: object properties: id: type: string format: uuid description: Id entidade codFin: type: integer format: int64 description: Código da finalidade de compra maximum: 9999 desFin: type: string maxLength: 80 description: Descrição da finalidade de compra sitFin: type: string allOf: – #/definitions/enumSitReg description: Situação da finalidade de compra usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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: 10 description: Nome fantasia da empresa 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 required: – nomCto properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitTra: type: string allOf: – #/definitions/enumSitReg description: Situação nomCto: type: string maxLength: 150 description: Nome cifFob: type: string allOf: – #/definitions/enumCifFob description: Frete CIF ou FOB numIdf: type: string maxLength: 40 description: Número Identificação Fiscal 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 excluido: type: boolean description: Indica se o registro foi excluído default: false 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 numCgc: type: string maxLength: 18 description: CPF/CNPJ usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e081tab: description: Tabela de preço type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTpr: type: string maxLength: 4 description: Código desTpr: type: string maxLength: 250 description: Descrição abrTpr: type: string maxLength: 10 description: Abreviatura sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e085pes: description: Cliente type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa e021mot: type: object allOf: – #/definitions/e021mot description: Código do motivo da situação do cliente obsMot: type: string maxLength: 250 description: Observação do motivo da situação do usuário sitCli: type: string allOf: – #/definitions/enumSitReg description: Situação do cliente tipEmc: type: string allOf: – #/definitions/enumTipEmc description: Tipo do direito de propriedade da empresa marCli: type: string maxLength: 20 description: Marca do cliente tipAce: type: string allOf: – #/definitions/enumTipAce description: Tipo de acerto (arredondamento) do cliente excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e090pes: description: Representante type: object required: – e021mot properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação e021mot: type: object allOf: – #/definitions/e021mot description: Código do motivo da situação do representante obsMot: type: string maxLength: 250 description: Observação do motivo da situação do representante excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e017rve: description: Tabelas – Regiões de Venda type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codRve: type: string maxLength: 3 description: Região Venda nomRve: type: string maxLength: 30 description: Nome usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e090hrpComGer: description: Definições de representante – comercial geral type: object required: – e070fil – catRep properties: id: type: string format: uuid description: Id da entidade – Representante e090pes: type: object allOf: – #/definitions/e090pes description: Representante e070fil: type: object allOf: – #/definitions/e070fil description: Filial catRep: type: string allOf: – #/definitions/enumCatRep description: Categoria do representante venVmp: type: string description: Valor mínimo aceito para pedidos minimum: 0.00 maximum: 9999999999999.99 perCom: type: number format: double description: Percentual de comissão padrão para produtos do representante minimum: 0.00 maximum: 100.0 perCos: type: number format: double description: Percentual de comissão padrão para serviços do representante minimum: 0.00 maximum: 100.0 comFat: type: number format: double description: Percentual de comissão pago ao representante no faturamento minimum: 0.00 maximum: 100.0 comPri: type: boolean description: Indicativo se a comissão é totalmente na primeira parcela default: false encCom: type: boolean description: Indicativo se o valor dos encargos está ou não na base de comissão outCom: type: boolean description: Indicativo se o valor das outras despesas está ou não na base de comissão embCom: type: boolean description: Indicativo se o valor das embalagens está ou não na base de comissão segCom: type: boolean description: Indicativo se o seguro está ou não na base de comissão freCom: type: boolean description: Indicativo se o frete está ou não na base de comissão ipiCom: type: boolean description: Base Comissão IPI icmCom: type: boolean description: Base Comissão ICMS subCom: type: boolean description: Base Comissão ICMS Substituído insCom: type: boolean description: Base Comissão INSS issCom: type: boolean description: Base Comissão ISS cffCom: type: boolean description: COFINS Faturamento Base Comissão cofCom: type: boolean description: COFINS Retido Base Comissão pifCom: type: boolean description: PIS Faturamento Base Comissão pisCom: type: boolean description: PIS Retido Base Comissão irfCom: type: boolean description: Base Comissão IRRF cslCom: type: boolean description: CSLL Retido Base Comissão e081tab: type: object allOf: – #/definitions/e081tab description: Tabela de preço padrão do representante excluido: type: boolean description: Excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e085hclComGer: description: Definições do cliente – Comercial geral type: object properties: id: type: string format: uuid description: Id da entidade e085pes: type: object allOf: – #/definitions/e085pes description: Cliente e070fil: type: object allOf: – #/definitions/e070fil description: Filial e064cat: type: object allOf: – #/definitions/e064cat description: Categoria do cliente e028cpg: type: object allOf: – #/definitions/e028cpg description: Condição de pagamento e066fpg: type: object allOf: – #/definitions/e066fpg description: Forma de pagamento e067fin: type: object allOf: – #/definitions/e067fin description: Finalidade de venda e090pes: type: object allOf: – #/definitions/e090pes description: Representante e073pesCodTra: type: object allOf: – #/definitions/e073pes description: Transportadora e073pesCodRed: type: object allOf: – #/definitions/e073pes description: Código da transportadora de redespacho padrão para o cliente cifFob: type: string allOf: – #/definitions/enumCifFob description: Tipo de frete conFin: type: boolean description: Consumidor Final e081tab: type: object allOf: – #/definitions/e081tab description: Tabela de preço indPre: type: string allOf: – #/definitions/enumIndPre description: Indicativo presencial do consumidor exiLcp: type: boolean description: N Exige ligação cliente x produto e001endSeqCob: type: object allOf: – #/definitions/e001end description: Endereço de cobrança e001endSeqEnt: type: object allOf: – #/definitions/e001end description: Endereço de entrega apmDen: type: boolean description: Aceita pedido com a mesma data de entrega epcPed: type: boolean description: Exige número do pedido do cliente no pedido datUpe: type: string format: date description: Data do último pedido vlrUpe: type: string description: Valor do último pedido acePar: type: boolean description: Aceita faturamento parcial de pedidos perAqa: type: number format: double description: Percentual de quantidade acima do pedido aceito no faturamento perCom: type: number format: double description: Percentual de comissão minimum: -100 maximum: 100 perDad: type: number format: double description: Percentual de desconto minimum: 0 maximum: 100 ecpCnp: type: boolean description: Exige Produto Cliente no Pedido criEdv: type: string allOf: – #/definitions/enumAntPos description: Critério para escolha do dia de vencimento das parcelas e títulos qtdDcv: type: integer format: int64 description: Quantidade de dias para cálculo de vencimento minimum: 0 maximum: 999 default: 0 diaEsp: type: string allOf: – #/definitions/enumDiaEsp description: Dia da semana para vencimento parcelas diaMe1: type: integer format: int64 description: Primeiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 99 diaMe2: type: integer format: int64 description: Segundo dia especial do mês para vencimento das parcelas minimum: 0 maximum: 99 diaMe3: type: integer format: int64 description: Terceiro dia especial do mês para vencimento das parcelas minimum: 0 maximum: 99 sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e069gre: description: Cadastros – Grupos de Empresas type: object required: – codGre – nomGre – excluido properties: id: type: string format: uuid description: Id da entidade codGre: type: integer format: int64 description: Grupo Empresa minimum: 0 maximum: 999999999 nomGre: type: string maxLength: 100 description: Nome cnpRai: type: number format: double description: CNPJ Raiz minimum: 0 maximum: 99999999 e001pes: type: object allOf: – #/definitions/e001pes description: Cliente Base excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e021mot: description: Tabelas – Motivos das Situações das Tabelas type: object required: – codMot – desMot properties: id: type: string format: uuid description: Id da entidade codMot: type: integer format: int64 description: Motivo minimum: 0 maximum: 999999 desMot: type: string maxLength: 30 description: Descrição aplMot: type: string allOf: – #/definitions/enumAplMot description: Aplicação dos motivos das situações das tabelas excluido: type: boolean description: Indica se o registro foi excluído default: false 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

Este artigo foi útil para você?

Leave A Comment