2.0info: 1.15.0 (PRIVATE) – Financeiro description: ERPX x-senior-domain: ERPX_FND x-senior-domain-path: erpx_fnd x-senior-service-path: financeiro contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /private/erpx_fnd/financeirosecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/upDown checks: #/definitions/checkData default: description: Error response schema: #/definitions/genericError /obterIndiceDataBase: post: description: API para obter o maior índice para a moeda x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dataBase – quantidadeDias – moeda properties: dataBase: type: string description: Data de emissão do documento quantidadeDias: type: integer description: Quantidade de dias moeda: type: string description: Moeda de conversão responses: 200: description: Ok schema: type: object required: – indice – dataBase properties: indice: type: string description: Índice dataBase: type: string description: Data base considerada default: description: Error response schema: #/definitions/genericError /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: default: description: Error response schema: #/definitions/genericError /currencyQuote: post: description: Cotação de Moeda x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – idTo – quoteDate properties: idTo: type: string description: Id Moeda quoteDate: type: string description: Data responses: 200: description: Ok schema: type: object required: – conversionResult properties: conversionResult: type: string description: Valor moeda default: description: Error response schema: #/definitions/genericError /odata: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e001tnsCreated: post: description: Event of e001tns create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e001tnsDeleted: post: description: Event of e001tns delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e001tnsMerged: post: description: Event of e001tns merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e001tnsUpdated: post: description: Event of e001tns update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e002tptCreated: post: description: Event of e002tpt create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e002tptDeleted: post: description: Event of e002tpt delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e002tptMerged: post: description: Event of e002tpt merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e002tptUpdated: post: description: Event of e002tpt update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ageCreated: post: description: Event of e030age create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030age responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ageDeleted: post: description: Event of e030age delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030age responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ageMerged: post: description: Event of e030age merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030age responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ageUpdated: post: description: Event of e030age update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030age responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030banCreated: post: description: Event of e030ban create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030banDeleted: post: description: Event of e030ban delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030banMerged: post: description: Event of e030ban merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030banUpdated: post: description: Event of e030ban update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ccbCreated: post: description: Event of e030ccb create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ccbDeleted: post: description: Event of e030ccb delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ccbMerged: post: description: Event of e030ccb merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030ccbUpdated: post: description: Event of e030ccb update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030pcbDeleted: post: description: Event of e030pcb delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030pcb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030pcbMerged: post: description: Event of e030pcb merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030pcb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030pcbUpdated: post: description: Event of e030pcb update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030pcb responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030supCreated: post: description: Event of e030sup create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030supDeleted: post: description: Event of e030sup delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030supMerged: post: description: Event of e030sup merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e030supUpdated: post: description: Event of e030sup update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imeCreated: post: description: Event of e031ime create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imeDeleted: post: description: Event of e031ime delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imeMerged: post: description: Event of e031ime merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imeUpdated: post: description: Event of e031ime update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031vmmCreated: post: description: Event of e031vmm create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031vmmDeleted: post: description: Event of e031vmm delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031vmmMerged: post: description: Event of e031vmm merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031vmmUpdated: post: description: Event of e031vmm update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031smoCreated: post: description: Event of e031smo create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031smoDeleted: post: description: Event of e031smo delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031smoMerged: post: description: Event of e031smo merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031smoUpdated: post: description: Event of e031smo update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imoCreated: post: description: Event of e031imo create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imoDeleted: post: description: Event of e031imo delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imoMerged: post: description: Event of e031imo merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031imoUpdated: post: description: Event of e031imo update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031moeCreated: post: description: Event of e031moe create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031moeDeleted: post: description: Event of e031moe delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031moeMerged: post: description: Event of e031moe merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /e031moeUpdated: post: description: Event of e031moe update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031ime: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031ime responses: 200: description: The created resource schema: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031ime responses: 200: description: The created resource schema: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError /entities/e031ime/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok schema: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031ime responses: 200: description: Ok schema: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031ime default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031ime/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e031ime responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e007ufs: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e007ufs default: description: Error response schema: #/definitions/genericError /entities/e030ccb: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030ccb responses: 200: description: The created resource schema: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030ccb responses: 200: description: The created resource schema: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError /entities/e030ccb/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok schema: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030ccb responses: 200: description: Ok schema: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e030ccb default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e030ccb/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e030ccb responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e031moe: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: The created resource schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: The created resource schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError /entities/e031moe/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031moe responses: 200: description: Ok schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031moe/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e031moe responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e030age: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030age responses: 200: description: The created resource schema: #/definitions/e030age default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030age responses: 200: description: The created resource schema: #/definitions/e030age default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e030age default: description: Error response schema: #/definitions/genericError /entities/e030age/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030age responses: 200: description: Ok schema: #/definitions/e030age default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030age responses: 200: description: Ok schema: #/definitions/e030age default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e030age default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e030age/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e030age responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e020snf: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e020snf default: description: Error response schema: #/definitions/genericError /entities/e008cep: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e008cep responses: 200: description: The created resource schema: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e008cep responses: 200: description: The created resource schema: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError /entities/e008cep/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e008cep responses: 200: description: Ok schema: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e008cep responses: 200: description: Ok schema: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008cep default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e008cep/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e008cep responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e031vmm: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031vmm responses: 200: description: The created resource schema: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031vmm responses: 200: description: The created resource schema: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError /entities/e031vmm/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok schema: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031vmm responses: 200: description: Ok schema: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031vmm default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031vmm/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e031vmm responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e070emp: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e070emp default: description: Error response schema: #/definitions/genericError /entities/e070fil: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e070fil default: description: Error response schema: #/definitions/genericError /entities/e031smo: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031smo responses: 200: description: The created resource schema: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031smo responses: 200: description: The created resource schema: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError /entities/e031smo/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok schema: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031smo responses: 200: description: Ok schema: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031smo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031smo/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e031smo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e008rai: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e008rai default: description: Error response schema: #/definitions/genericError /entities/e006pai: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e006pai default: description: Error response schema: #/definitions/genericError /entities/e002tpt: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e002tpt responses: 200: description: The created resource schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e002tpt responses: 200: description: The created resource schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError /entities/e002tpt/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e002tpt responses: 200: description: Ok schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e002tpt/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e002tpt responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e030sup: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030sup responses: 200: description: The created resource schema: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030sup responses: 200: description: The created resource schema: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError /entities/e030sup/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok schema: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030sup responses: 200: description: Ok schema: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e030sup default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e030sup/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e030sup responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e030pcb: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030pcb responses: 200: description: The created resource schema: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030pcb responses: 200: description: The created resource schema: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError /entities/e030pcb/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030pcb responses: 200: description: Ok schema: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030pcb responses: 200: description: Ok schema: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e030pcb default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e030pcb/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e030pcb responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e030ban: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030ban responses: 200: description: The created resource schema: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e030ban responses: 200: description: The created resource schema: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError /entities/e030ban/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok schema: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e030ban responses: 200: description: Ok schema: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e030ban default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e030ban/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e030ban responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e001tns: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e001tns responses: 200: description: The created resource schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e001tns responses: 200: description: The created resource schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError /entities/e001tns/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tns responses: 200: description: Ok schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e001tns/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e001tns responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/e080ser: get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e080ser default: description: Error response schema: #/definitions/genericError /entities/e031imo: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031imo responses: 200: description: The created resource schema: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/e031imo responses: 200: description: The created resource schema: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError /entities/e031imo/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok schema: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e031imo responses: 200: description: Ok schema: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031imo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/e031imo/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/e031imo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN enumTipMoeCurto: type: string enum: – VD – VH enumTipCot: type: string enum: – VD – VM enumLisMod: type: string enum: – VVEP – VVEF – VVES – VESN – VESR – VESB – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT enumSitReg: type: string enum: – VA – VI enumAplGrp: type: string enum: – VA – VR – VP enumSomTit: type: string enum: – VD – VO – VC enumTipEmp: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumJurFis: type: string enum: – VJ – VF enumAplSnf: type: string enum: – VS – VM – VE – VF – VD enumCatBan: type: string enum: – VP – VM – VG enumTipBan: type: string enum: – V1 – V2 – V3 enumCbrCom: type: string enum: – V1 – V2 enumPdtTef: type: string enum: – V1 – V2 – V99 userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None checkData: type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: #/definitions/upDown e001tns: type: object required: – e070emp – codTns – desTns – lisMod – detTns – aceMan properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codTns: type: string description: Transação desTns: type: string description: Descrição lisMod: #/definitions/enumLisMod detTns: type: string description: Detalhamento aceMan: type: boolean description: Aceita movimentação manuais sitTns: #/definitions/enumSitReg excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e070emp: type: object required: – codEmp – nomEmp – e031moe properties: id: type: string description: format: uuid codEmp: type: integer description: Empresa nomEmp: type: string description: Nome da empresa e031moe: #/definitions/e031moe excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e031moe: type: object required: – codMoe – desMoe – sigMoe – tipMoe – tipCot properties: id: type: string description: format: uuid codMoe: type: string description: Código moeda desMoe: type: string description: Descrição sigMoe: type: string description: Sigla tipMoe: #/definitions/enumTipMoeCurto tipCot: #/definitions/enumTipCot diaBas: type: integer description: Dia base cotação qtdInt: type: integer description: Quantidade inteiros qtdDec: type: integer description: Quantidade decimais e031smoIdeSmo: #/definitions/e031smo codBac: type: integer description: Código moeda BACEN separadorMilhar: type: string description: Separador de milhar separadorDecimal: type: string description: Separador de decimal excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e031smo: type: object required: – codSmo properties: id: type: string description: format: uuid codSmo: type: integer description: Código da série da moeda desSmo: type: string description: Descrição da série da moeda excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e002tpt: type: object required: – codTpt – desTpt – abrTpt – recSom – pagSom properties: id: type: string description: format: uuid codTpt: type: string description: Tipo de título desTpt: type: string description: Descrição do tipo de título abrTpt: type: string description: Abreviatura do tipo de título sitTpt: #/definitions/enumSitReg aplTpt: #/definitions/enumAplGrp recSom: #/definitions/enumSomTit pagSom: #/definitions/enumSomTit excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e006pai: type: object required: – codPai – nomPai – merSul – visEnt properties: id: type: string description: format: uuid codPai: type: string description: Código nomPai: type: string description: Nome e031moe: #/definitions/e031moe merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto entrada paiDir: type: integer description: Código do país na DIRF paiSis: type: integer description: País Siscomex/Siscoserv excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e007ufs: type: object required: – e006pai – sigUfs – nomUfs properties: id: type: string description: format: uuid e006pai: #/definitions/e006pai sigUfs: type: string description: Sigla nomUfs: type: string description: Nome excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e008cep: type: object required: – cepIni properties: id: type: string description: format: uuid cepIni: type: integer description: CEP endereço baiEnd: type: string description: Bairro logEnd: type: string description: Logradouro e008rai: #/definitions/e008rai excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e008rai: type: object required: – codRai – nomCid – e007ufs – cepMin – cepMax properties: id: type: string description: format: uuid codRai: type: integer description: Código cidade nomCid: type: string description: Nome cidade e007ufs: #/definitions/e007ufs popCid: type: integer description: População potAlf: type: number description: Potencial consumo format: double locGeo: type: string description: Localização geográfica cepMin: type: integer description: CEP inicial cepMax: type: integer description: CEP final codFis: type: integer description: Código fiscal município codIbg: type: integer description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e020snf: type: object required: – e070fil – codSnf – desSnf – abrSnf – aplSnf properties: id: type: string description: format: uuid e070fil: #/definitions/e070fil codSnf: type: string description: Série de nota fiscal desSnf: type: string description: Descrção da série de nota fiscal abrSnf: type: string description: Abreviatura da série de nota fiscal aplSnf: #/definitions/enumAplSnf excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e070fil: type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string description: format: uuid e070emp: #/definitions/e070emp codFil: type: integer description: Filial nomFil: type: string description: Nome sigFil: type: string description: Fantasia tipEmp: #/definitions/enumTipEmp tipPes: #/definitions/enumJurFis numCgc: type: string description: CPF/CNPJ insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal insNfs: type: string description: Inscrição municipal NFS numIdf: type: string description: Número identificação fiscal endFil: type: string description: Endereço nenFil: type: string description: Número cplEnd: type: string description: Complemento baiFil: type: string description: Bairro cidFil: type: string description: Cidade e007ufsSigUfs: #/definitions/e007ufs endEnt: type: string description: Endereço entrega nenEnt: type: string description: Número entrega cplEnt: type: string description: Complemento entrega cidEnt: type: string description: Cidade entrega e007ufsEstEnt: #/definitions/e007ufs endCob: type: string description: Endereço cobrança nenCob: type: string description: Número cobrança cplCob: type: string description: Complemento cobrança baiCob: type: string description: Bairro cobrança cidCob: type: string description: Cidade cobrança e007ufsEstCob: #/definitions/e007ufs numFon: type: string description: Telefone numFax: type: string description: Fax cxaPst: type: integer description: Caixa postal intNet: type: string description: E-mail ctbDia: type: string description: Data início atividade format: date ctbObs: type: string description: Objeto social ageAnp: type: integer description: Código do agente insAnp: type: integer description: Código da instalação filMat: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e030age: type: object required: – e030ban – codAge – nomAge – abrAge properties: id: type: string description: format: uuid e030ban: #/definitions/e030ban codAge: type: string description: Agência digAge: type: string description: Digito verificador da agência nomAge: type: string description: Nome abrAge: type: string description: Abreviatura e008cep: #/definitions/e008cep endAge: type: string description: Endereço numEnd: type: string description: Número baiAge: type: string description: Bairro cplAge: type: string description: Complemento ctoAge: type: string description: Pessoa contato fonAge: type: string description: Fone faxAge: type: string description: Fax cxaPst: type: integer description: Caixa postal intNet: type: string description: E-mail e030sup: #/definitions/e030sup nomGer: type: string description: Nome gerente excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e030ban: type: object required: – codBan – nomBan – abrBan properties: id: type: string description: format: uuid codBan: type: string description: Banco nomBan: type: string description: Nome abrBan: type: string description: Abreviatura catBan: #/definitions/enumCatBan tipBan: #/definitions/enumTipBan cgcCpf: type: string description: CNPJ ispb: type: integer description: Código Identificador do Sistema de Pagamento Brasileiro valorMinimoTed: type: string description: Valor mínimo TED excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e030sup: type: object required: – e030ban – codSup – desSup properties: id: type: string description: format: uuid e030ban: #/definitions/e030ban codSup: type: string description: Superintendência desSup: type: string description: Descrição excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e030ccb: type: object required: – e030ban – e070emp – cbrCom properties: id: type: string description: format: uuid e030ban: #/definitions/e030ban e070emp: #/definitions/e070emp e002tptTptPgt: #/definitions/e002tpt e001tnsTnsPgt: #/definitions/e001tns cbrCom: #/definitions/enumCbrCom e002tptTptRec: #/definitions/e002tpt e001tnsTnsRec: #/definitions/e001tns e070filFilSnf: #/definitions/e070fil e020snfCodSnf: #/definitions/e020snf e080serCodSer: #/definitions/e080ser e001tnsTnsSnf: #/definitions/e001tns excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e080ser: type: object required: – codSer – desSer properties: id: type: string description: format: uuid codSer: type: string description: Serviço desSer: type: string description: Descrição do serviço excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e030pcb: type: object required: – e030ban – codPcb – desPcb – ideTef properties: id: type: string description: format: uuid e030ban: #/definitions/e030ban codPcb: type: integer description: Código do produto de correspondente bancário desPcb: type: string description: Descrição do produto de correspondente bancário vlrCom: type: string description: Valor de comissão para o produto perCom: type: number description: Percentual de comissão do produto format: double pdtTef: #/definitions/enumPdtTef ideTef: type: string description: Identificador deste produto no retorno do TEF excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e031ime: type: object required: – e031moe – datMoe properties: id: type: string description: format: uuid e031moe: #/definitions/e031moe datMoe: type: string description: Data cotação format: date vlrC01: type: string description: Valor cotação 1m vlrP01: type: string description: Valor previsão 1m vlrC02: type: string description: Valor cotação 2m vlrP02: type: string description: Valor previsão 2m vlrC03: type: string description: Valor cotação 3m vlrP03: type: string description: Valor previsão 3m vlrC04: type: string description: Valor cotação 4m vlrP04: type: string description: Valor previsão 4m vlrC05: type: string description: Valor cotação 5m vlrP05: type: string description: Valor previsão 5m vlrC06: type: string description: Valor cotação 6m vlrP06: type: string description: Valor previsão 6m vlrC07: type: string description: Valor cotação 7m vlrP07: type: string description: Valor previsão 7m vlrC08: type: string description: Valor cotação 8m vlrP08: type: string description: Valor previsão 8m vlrC09: type: string description: Valor cotação 9m vlrP09: type: string description: Valor previsão 9m vlrC10: type: string description: Valor cotação 10m vlrP10: type: string description: Valor previsão 10m vlrC11: type: string description: Valor cotação 11m vlrP11: type: string description: Valor previsão 11m vlrC12: type: string description: Valor cotação 12m vlrP12: type: string description: Valor previsão 12m excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e031vmm: type: object required: – e031moe – e070fil – datIni – datFim – seqVmm properties: id: type: string description: format: uuid e031moe: #/definitions/e031moe e070fil: #/definitions/e070fil datIni: type: string description: Data início valorização format: date datFim: type: string description: Data final valorização format: date seqVmm: type: integer description: Sequência valorização cotIni: type: number description: Valor cotação do período inicial format: double cotFim: type: number description: Valor cotação do período final format: double excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time e031imo: type: object required: – e031moe – datMoe properties: id: type: string description: format: uuid e031moe: #/definitions/e031moe datMoe: type: string description: Data cotação format: date vlrCot: type: string description: Valor cotação vlrPre: type: string description: Valor previsão excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string description: format: date-time usualt: type: string description: dthalt: type: string description: format: date-time notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority 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 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