TRANSACAO (transacao)

2.0info: 1.16.0 TRANSACAO description: ERPX x-senior-domain: ERPX_FIN x-senior-domain-path: erpx_fin x-senior-service-path: transacao 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /transacao/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 /transacao/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsFinCre: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE031moe: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE002tpt: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE047ntg: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tns: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsFinCpa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsFinTes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE501tcp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE301tcr: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/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 /transacao/actions/importE001tnsFinCre: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE031moe: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE002tpt: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE047ntg: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tns: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tnsFinCpa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tnsFinTes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE501tcp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/actions/importE301tcr: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/events/importE001tnsFinCreEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE001tnsFinCreEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE031moeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE031moeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE002tptEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE002tptEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE047ntgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE047ntgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE001tnsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE001tnsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE001tnsFinCpaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE001tnsFinCpaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE001tnsFinTesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE001tnsFinTesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE501tcpEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE501tcpEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/importE301tcrEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/events/exportE301tcrEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCre: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinCre responses: 200: description: The created resource schema: #/definitions/e001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinCre responses: 200: description: The created resource schema: #/definitions/e001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCre/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editE001tnsFinCre responses: 200: description: Ok schema: #/definitions/editE001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsFinCre responses: 200: description: Ok schema: #/definitions/e001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCre/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsFinCre responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e031moe: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e031moe/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e002tpt: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e002tpt/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e047ntg: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e047ntg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e047ntg/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e047ntg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tns: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tns/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCpa: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinCpa responses: 200: description: The created resource schema: #/definitions/e001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinCpa responses: 200: description: The created resource schema: #/definitions/e001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCpa/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editE001tnsFinCpa responses: 200: description: Ok schema: #/definitions/editE001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsFinCpa responses: 200: description: Ok schema: #/definitions/e001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinCpa/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsFinCpa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinTes: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinTes responses: 200: description: The created resource schema: #/definitions/e001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsFinTes responses: 200: description: The created resource schema: #/definitions/e001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinTes/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editE001tnsFinTes responses: 200: description: Ok schema: #/definitions/editE001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsFinTes responses: 200: description: Ok schema: #/definitions/e001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsFinTes/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsFinTes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e501tcp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e501tcp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /transacao/entities/e301tcr: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e301tcr 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumSitReg: description: Situação do registro type: string enum: – VA – VI enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEF – VVES – VESN – VESR – VESB – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT enumTipBai: description: Tipo de baixa type: string enum: – VPG – VDV – VAB – VCA – VCR – VCP – VLP – VSU – VNA enumAdiSub: description: Adiciona ou subtrai type: string enum: – V1 – V2 – V3 – V4 – V5 enumAplGrp: description: Aplicação Tipo type: string enum: – VA – VR – VP enumSomTit: description: Soma C. Receber type: string enum: – VD – VO – VC enumTipCom: description: Tipo de comissão type: string enum: – VC – VD – VN enumDebCre: description: Tipo de lançamento type: string enum: – VD – VC enumTipDeb: description: Tipo de débito type: string enum: – VC – VA – VO – VT – VN enumSitTit: description: Situação do Título type: string enum: – VAO – VAN – VAA – VAB – VAC – VAE – VAI – VAJ – VAP – VAR – VAS – VAV – VAX – VCA – VCO – VLQ – VLC – VLI – VLM – VLO – VLP – VLS – VLV – VLX – VPE – VCE enumTipTcc: description: Tipo de Título type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 enumTipJrs: description: Tipo de Juros type: string enum: – VS – VC enumTipCnc: description: Tipo da Operação type: string enum: – VA – VM userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck e001tnsFinCre: description: Transação financeiro contas a receber type: object properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação e002tptVenTpt: type: object allOf: – #/definitions/e002tpt description: Tipo de título gerado no contas a receber pela transação de NF saída e031moeVenMoe: type: object allOf: – #/definitions/e031moe description: Código de moeda padrão para os títulos gerados no contas a receber recDec: type: string allOf: – #/definitions/enumAdiSub description: Transação adiciona (entradas) ou subtrai (baixas) dos saldos duplicatas, outros ou créditos recAdc: type: boolean description: Transação é de crédito de cliente recTpb: type: string allOf: – #/definitions/enumTipBai description: Tipo de baixa gerada pela transação no contas a receber recAsh: type: boolean description: Transação atualiza saldos nos históricos dos clientes, grupo e portador recHis: type: boolean description: Transação atualiza outros dados nos históricos dos clientes recTic: type: boolean description: Indicativo se a transação é de cartão de crédito/débito default: false excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editE001tnsFinCre: type: object required: – id allOf: – #/definitions/e001tnsFinCre e031moe: description: Moeda type: object required: – codMoe – desMoe – sigMoe properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código moeda desMoe: type: string maxLength: 30 description: Descrição sigMoe: type: string maxLength: 5 description: Sigla excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e002tpt: description: Tipo de título type: object required: – codTpt – desTpt – abrTpt properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Tipo de título desTpt: type: string maxLength: 40 description: Descrição do tipo de título abrTpt: type: string maxLength: 5 description: Abreviatura do tipo de título sitTpt: type: string allOf: – #/definitions/enumSitReg description: Situação aplTpt: type: string allOf: – #/definitions/enumAplGrp description: Aplicação Tipo excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e047ntg: description: Natureza de gasto type: object required: – e070emp – codNtg – desNtg properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codNtg: type: integer format: int64 description: Natureza de gasto do custo ou despesa maximum: 9999 desNtg: type: string maxLength: 40 description: Descrição da natureza de gasto excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e001tns: description: Transação type: object required: – e070emp – codTns – desTns – lisMod – aceMan properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTns: type: string maxLength: 5 description: Transação desTns: type: string maxLength: 60 description: Descrição lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo aceMan: type: boolean description: Aceita movimentação manuais sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação e001tnsFinCre: type: object allOf: – #/definitions/e001tnsFinCre description: Especialização financas contas a receber e001tnsFinCpa: type: object allOf: – #/definitions/e001tnsFinCpa description: Especialização financas contas a pagar e001tnsFinTes: type: object allOf: – #/definitions/e001tnsFinTes description: Especialização financas tesouraria excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa e031moe: type: object allOf: – #/definitions/e031moe description: Moeda excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e001tnsFinCpa: description: Transação financeiro contas a pagar type: object properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação pagDec: type: string allOf: – #/definitions/enumAdiSub description: Transação adiciona (Entradas) ou subtrai (Baixas) dos saldos duplicatas, outros ou créditos pagTpb: type: string allOf: – #/definitions/enumTipBai description: Tipo de baixa gerada pela transação no contas a pagar cprTnf: type: boolean description: Transação soma o valor do item no valor total do financeiro default: false pagAdf: type: boolean description: Transação é crédito a fornecedor ou representante default: false pagAsh: type: boolean description: Indicativo se a transação atualiza saldos nos históricos dos fornecedores default: false pagHis: type: boolean description: Indicativo se a transação atualiza outros dados nos históricos dos fornecedores default: false e002tptCprTpt: type: object allOf: – #/definitions/e002tpt description: Tipo de título gerado no contas a pagar pela transação NF de entrada e031moeCprMoe: type: object allOf: – #/definitions/e031moe description: Código moeda padrão para os títulos gerados no contas a pagar excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editE001tnsFinCpa: type: object required: – id allOf: – #/definitions/e001tnsFinCpa e001tnsFinTes: description: Transação financeiro tesouraria type: object properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação e001tnsTnsTel: type: object allOf: – #/definitions/e001tns description: Código da transação para estorno da transação principal cxbDec: type: string allOf: – #/definitions/enumDebCre description: Transação na tesouraria é débito ou crédito cxbChe: type: string allOf: – #/definitions/enumTipDeb description: Transação é de débito por cheque ou aviso de débito e001tnsCxbTrf: type: object allOf: – #/definitions/e001tns description: Transação correspondente de transferência no caixa e bancos prjDec: type: string allOf: – #/definitions/enumDebCre description: Transação do Movimento é de Débito ou Crédito cxbTte: type: boolean description: Indicativo se a transação é de transferência eletrônica default: false cxbBlq: type: boolean description: Indicativo se soma saldo bloqueado na conta interna default: false excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editE001tnsFinTes: type: object required: – id allOf: – #/definitions/e001tnsFinTes e501tcp: description: C. Pagar – Títulos – Dados Gerais type: object required: – e070emp – e070filCodFil – numTit – e002tptCodTpt – e001pesCodFor – e001tnsCodTns – sitTit – datEmi – datEnt – vctOri – vlrOri – proJrs – datPpt – e039porCodPor properties: id: type: string format: uuid description: Id da entidade e070emp: type: string format: uuid description: Empresa e070filCodFil: type: string format: uuid description: Filial numTit: type: string maxLength: 15 description: Nº Título e002tptCodTpt: type: string format: uuid description: Tipo Título e001pesCodFor: type: string format: uuid description: Fornecedor fatoFinanceiro: type: string format: uuid description: Identificador do fato financeiro do título e001tnsCodTns: type: string format: uuid description: Transação obsTcp: type: string maxLength: 250 description: Observação sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação codTri: type: string maxLength: 5 description: Código Tributação p/ DARF e001pesCodFav: type: string format: uuid description: Favorecido e047ntg: type: string format: uuid description: Natureza Gasto e615prjFinRat: type: string format: uuid description: Projeto e615fpjFinRat: type: string format: uuid description: Fase e091plfFinRat: type: string format: uuid description: Conta Financeira e045plaFinRat: type: string format: uuid description: Conta Contábil Reduzida e044ccuFinRat: type: string format: uuid description: Centro de Custo e023crp: type: string format: uuid description: Grupo Contas Pagar datEmi: type: string format: date description: Data Emissão datEnt: type: string format: date description: Data Entrada vctOri: type: string format: date description: Vencimento Original vlrOri: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 e031moe: type: string format: uuid description: Moeda Base vctPro: type: string format: date description: Vencimento Prorrogado/Juros proJrs: type: boolean description: Prorrogação c/ Juros e029mpt: type: string format: uuid description: Motivo Prorrogação e066fpgCodFpg: type: string format: uuid description: Forma Pagamento vlrAbe: type: string description: Valor Aberto minimum: 0.00 maximum: 9999999999999.99 datNeg: type: string format: date description: Data Valores Negociados jrsNeg: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 mulNeg: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 dscNeg: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 outNeg: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 cotNeg: type: number format: double description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 datPpt: type: string format: date description: Data Provável Pagamento antDsc: type: boolean description: Calcula Desc. Antecipação datDsc: type: string format: date description: Data/Tolerância Desconto tolDsc: type: integer format: int64 description: Tolerância Desconto minimum: -9999 maximum: 9999 perDsc: type: number format: double description: Percentual/Valor Desconto minimum: 0.00 maximum: 999.99 vlrDsc: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 e039porCodPor: type: string format: uuid description: Portador e033crtCodCrt: type: string format: uuid description: Carteira e030ban: type: string format: uuid description: Banco/Agência/Nº Conta Fornecedor e030age: type: string maxLength: 255 description: Agência Fornecedor ccbFor: type: string maxLength: 14 description: Nº CC no Banco tipTcc: type: string allOf: – #/definitions/enumTipTcc description: Tipo de Conta titBan: type: string maxLength: 20 description: Número Título Banco priPgt: type: integer format: int64 description: Prioridade Pagamento Título minimum: 0 maximum: 999999999 perMul: type: number format: double description: Percentual/Tolerância Multa minimum: 0.00 maximum: 999.99 tolMul: type: integer format: int64 description: Dias Tolerância Multa minimum: 0 maximum: 9999 jrsDia: type: number format: double description: Valor Juros Dia minimum: 0.00 maximum: 9999999.99 perJrs: type: number format: double description: Percentual/Tipo Juros minimum: 0.00 maximum: 999.99 tipJrs: type: string allOf: – #/definitions/enumTipJrs description: Tipo de Juros tolJrs: type: integer format: int64 description: Dias Tolerância Juros minimum: 0 maximum: 9999 datCjm: type: string format: date description: Data último cálculo juros usuSit: type: integer format: int64 description: Usuário Responsável Situação minimum: 0 sitAnt: type: string allOf: – #/definitions/enumSitTit description: Situação Anterior cotEmi: type: string description: Cotação Moeda Emissão minimum: 0.00 maximum: 999999999.9999999999 e037frj: type: string format: uuid description: Fórmula Reajuste usuNeg: type: integer format: int64 description: Usuário Valores Negociados minimum: 0 corNeg: type: number format: double description: Controle de Correções minimum: 0.00 maximum: 9999999999999.99 ultPgt: type: string format: date description: Data Último Pagamento e039porPorAnt: type: string format: uuid description: Portador Anterior e033crtCrtAnt: type: string format: uuid description: Carteira Anterior datUcm: type: string format: date description: Data Última Cotação Valorizada cotUcm: type: number format: double description: Cotação Última Valorização minimum: 0.00 maximum: 999999999.9999999999 codBar: type: string maxLength: 50 description: Código Barra tipEfe: type: string allOf: – #/definitions/enumTipCnc description: Tipo Efetivação e001tnsTnsPre: type: string format: uuid description: Transação de Previsão datPre: type: string format: date description: Data Entrada da Previsão vlrPre: type: string description: Valor Previsto minimum: 0.00 maximum: 9999999999999.99 numArb: type: integer format: int64 description: Nº Arquivo Banco minimum: 0 maximum: 999999999 gerTep: type: boolean description: Gerou título estorno pagamento numPge: type: string maxLength: 10 description: Título PE impEnt: type: boolean description: Gerou Imposto Entrada digCcb: type: string maxLength: 2 description: Dígito da Conta Corrente loteFinanceiroReprocessamentoId: type: string format: uuid description: Lote Financeiro reprocessamento excluido: type: boolean description: Indica se o registro foi excluído default: false e600ccoSugestaoTitulo: type: string format: uuid description: Sugestão conta interna usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e301tcr: description: C. Receber – Títulos – Dados Gerais type: object required: – e070emp – e001tnsCodTns – e070filCodFil – e001pesCodCli – numTit – e002tptCodTpt – e039porCodPor – sitTit – vctOri – vlrOri properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e001tnsCodTns: type: object allOf: – #/definitions/e001tns description: Transação e070filCodFil: type: string format: uuid description: Filial e001pesCodCli: type: string format: uuid description: Cliente numTit: type: string maxLength: 15 description: Nº Título e002tptCodTpt: type: object allOf: – #/definitions/e002tpt description: Tipo Título e039porCodPor: type: string format: uuid description: Portador sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação vctOri: type: string format: date description: Vencimento Original vlrOri: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 vlrAbe: type: string description: Valor Aberto minimum: 0.00 maximum: 9999999999999.99 vctPro: type: string format: date description: Vencimento Prorrogado/Juros e001endIdEndCob: type: string format: uuid description: Endereço usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 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 maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 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 maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 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 maxLength: 255 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 maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 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 maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 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 maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 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