Mais pesquisados:Customização, Tutorial, Documentação

cpl_ctb_accounts_receivable

60 views 0 23/07/2021 Atualizado em 15/07/2024 integrador

2.0info: 2.2.1 cpl_ctb_accounts_receivable description: Serviço responsável por executar a integração do modulo Contas a Receber x-senior-domain: erpx_int x-senior-domain-path: erpx_int x-senior-service-path: cpl_ctb_accounts_receivable 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_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cpl_ctb_accounts_receivable/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 /cpl_ctb_accounts_receivable/queries/getTasksWithErrorFromTicket: post: description: Lista de tarefas com erro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticketId properties: ticketId: type: string description: Id do Ticket pageRequest: type: object allOf: – #/definitions/recPageRequest description: Page Request responses: 200: description: Ok schema: type: object required: – integrationTasks – totalElements properties: integrationTasks: type: array items: type: object allOf: – #/definitions/integrationTaskData minimum: 1 description: Lista de Tarefas totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/getWorksWithErrorFromTask: post: description: Query para retornar a listagem dos trabalhos de integração com erro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taskId properties: taskId: type: string description: Identificador da tarefa de integração pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – total properties: integrationWorks: type: array items: type: object allOf: – #/definitions/integrationWorkData description: Lista de trabalhos de integração total: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/exportAccountingFact: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/exportIntegrationTaskLot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/exportJournalEntryPreparation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/exportPreparationApportionment: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/queries/exportPreparationAuxiliary: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/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 /cpl_ctb_accounts_receivable/actions/performAccountingIntegration: post: description: Action para iniciar o processamento da integração contábil tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchId – startDate – endDate properties: companyId: type: string description: Identificador da empresa branchId: type: string description: Identificador da filial startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/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 /cpl_ctb_accounts_receivable/actions/importAccountingFact: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/actions/importIntegrationTaskLot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/actions/importJournalEntryPreparation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/actions/importPreparationApportionment: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/actions/importPreparationAuxiliary: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/rulesAsyncResponse: post: description: Resposta async do rules tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/recRuleResult description: Resultado errorMsg: type: string description: Mensagem de erro identifier: type: string description: Identificador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/startIntegration: post: description: Inicia a criação e processamento das tasks tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – ticketId – companyId – branchId – startDate – endDate properties: ticketId: type: string description: Ticket – Id do ticket companyId: type: string description: Identificador da empresa branchId: type: string description: Identificador da filial startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/processExternalTaskEvent: post: description: Signal que dispara a lógica pós finalização das tasks tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId properties: taskId: type: string description: Identificador do task responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/processIntegrationTask: post: description: Evento responsável por iniciar o processamento da task paralelizada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – workerName – workers – lastWorkId properties: taskId: type: string description: Identificador da task workerName: type: string description: Nome do worker workers: type: integer format: int64 description: Número de workers lastWorkId: type: string description: identificador do último work alocado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/finishIntegrationTaskWithError: post: description: Finaliza a task com erro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId properties: taskId: type: string description: id da task errorMsg: type: string description: Mensagem de erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/integrationTaskFinished: post: description: Evento que sinaliza a finalização da task tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – taskStatus properties: taskId: type: string description: Identificador da task taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da task responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/integrationTicketFinished: post: description: Evento que sinaliza a finalização do ticket tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – ticketId – ticketStatus properties: ticketId: type: string description: Identificador do ticket ticketStatus: type: string allOf: – #/definitions/ticketStatus description: Status de finalização do ticket errorMsg: type: string description: Mensagem de erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/deleteTaskPreparation: post: description: Deleta preparações da task tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – task properties: task: type: string description: Identificador da task responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/signals/doWork: post: description: Processa o work tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – workers – workerName – lastWorkId – pid properties: taskId: type: string description: Identificador da task workers: type: integer format: int64 description: Número de workers workerName: type: string description: Nome do worker lastWorkId: type: string description: identificador do último work alocado pid: type: string description: Identificador do PID responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/events/integrationAccountReceivableTicketFinished: post: description: Evento que sinaliza a finalização do ticket x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – ticketStatus properties: ticket: type: string description: Identificador do ticket ticketStatus: type: string allOf: – #/definitions/ticketStatus description: Status de finalização do ticket errorMsg: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/events/importAccountingFactEvent: 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 /cpl_ctb_accounts_receivable/events/exportAccountingFactEvent: 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 /cpl_ctb_accounts_receivable/events/importIntegrationTaskLotEvent: 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 /cpl_ctb_accounts_receivable/events/exportIntegrationTaskLotEvent: 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 /cpl_ctb_accounts_receivable/events/importJournalEntryPreparationEvent: 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 /cpl_ctb_accounts_receivable/events/exportJournalEntryPreparationEvent: 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 /cpl_ctb_accounts_receivable/events/importPreparationApportionmentEvent: 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 /cpl_ctb_accounts_receivable/events/exportPreparationApportionmentEvent: 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 /cpl_ctb_accounts_receivable/events/importPreparationAuxiliaryEvent: 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 /cpl_ctb_accounts_receivable/events/exportPreparationAuxiliaryEvent: 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 /cpl_ctb_accounts_receivable/entities/accountingFact: 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/accountingFact responses: 200: description: The created resource schema: #/definitions/accountingFact 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/accountingFact responses: 200: description: The created resource schema: #/definitions/accountingFact 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/accountingFact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/accountingFact/{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/accountingFact responses: 200: description: Ok schema: #/definitions/accountingFact 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/accountingFact responses: 200: description: Ok schema: #/definitions/accountingFact 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/accountingFact 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 /cpl_ctb_accounts_receivable/entities/accountingFact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountingFact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/integrationTaskLot: 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/integrationTaskLot responses: 200: description: The created resource schema: #/definitions/integrationTaskLot 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/integrationTaskLot responses: 200: description: The created resource schema: #/definitions/integrationTaskLot 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/integrationTaskLot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/integrationTaskLot/{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/integrationTaskLot responses: 200: description: Ok schema: #/definitions/integrationTaskLot 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/integrationTaskLot responses: 200: description: Ok schema: #/definitions/integrationTaskLot 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/integrationTaskLot 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 /cpl_ctb_accounts_receivable/entities/integrationTaskLot/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationTaskLot responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/journalEntryPreparation: 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/journalEntryPreparation responses: 200: description: The created resource schema: #/definitions/journalEntryPreparation 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/journalEntryPreparation responses: 200: description: The created resource schema: #/definitions/journalEntryPreparation 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/journalEntryPreparation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/journalEntryPreparation/{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/journalEntryPreparation responses: 200: description: Ok schema: #/definitions/journalEntryPreparation 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/journalEntryPreparation responses: 200: description: Ok schema: #/definitions/journalEntryPreparation 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/journalEntryPreparation 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 /cpl_ctb_accounts_receivable/entities/journalEntryPreparation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/journalEntryPreparation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/preparationApportionment: 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/preparationApportionment responses: 200: description: The created resource schema: #/definitions/preparationApportionment 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/preparationApportionment responses: 200: description: The created resource schema: #/definitions/preparationApportionment 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/preparationApportionment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/preparationApportionment/{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/preparationApportionment responses: 200: description: Ok schema: #/definitions/preparationApportionment 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/preparationApportionment responses: 200: description: Ok schema: #/definitions/preparationApportionment 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/preparationApportionment 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 /cpl_ctb_accounts_receivable/entities/preparationApportionment/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preparationApportionment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/preparationAuxiliary: 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/preparationAuxiliary responses: 200: description: The created resource schema: #/definitions/preparationAuxiliary 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/preparationAuxiliary responses: 200: description: The created resource schema: #/definitions/preparationAuxiliary 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/preparationAuxiliary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cpl_ctb_accounts_receivable/entities/preparationAuxiliary/{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/preparationAuxiliary responses: 200: description: Ok schema: #/definitions/preparationAuxiliary 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/preparationAuxiliary responses: 200: description: Ok schema: #/definitions/preparationAuxiliary 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/preparationAuxiliary 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 /cpl_ctb_accounts_receivable/entities/preparationAuxiliary/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preparationAuxiliary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumAnaSin: description: Analítico/Sintético type: string enum: – VA – VS taskStatus: description: Status da tarefa de integração type: string enum: – STARTING – PROCESSING – DONE – DONE_WITH_ERROR – ERROR – CANCELED – EXTERNAL_PROCESSING workStatus: description: Status da tarefa de integração type: string enum: – WAITING – PENDING – PROCESSING – DONE – ERROR – CANCELED – PAUSED contabilizationType: description: Tipos de contabilização type: string enum: – VA – VS – VN – VT – VX – VY – VU enumDebCre: description: Débito/crédito type: string enum: – D – C enumOriLct: description: Origem dos lançamentos type: string enum: – VVEN – VEST – VREC – VCPR – VPAG – VTES – VPAT – VIVE – VICO – VIOD – VIMP – VICI – VISP – VIRJ ticketStatus: description: Status do Ticket type: string enum: – STARTING – PROCESSING – FINISHED – FINISHED_WITH_ERROR enumTypeOrder: description: Enumaração para o tipo de ordenação type: string enum: – ASC – DESC userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck integrationTaskData: description: Tarefa integração type: object required: – id – ticket – description – taskStatus – taskDate properties: id: type: string description: Id da Integração ticket: type: string description: Ticket description: type: string description: Descrição taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da tarefa taskDate: type: string format: date description: Data da tarefa message: type: string description: Mensagem numberOfOccurrences: type: integer format: int64 description: Número de ocorrências integrationWorkData: description: Record para listagem de trabalhos de integração com erro type: object required: – id – taskId – key properties: id: type: string description: Identificador do trabalho de integração taskId: type: string description: Identificador da tarefa workStatus: type: string allOf: – #/definitions/workStatus description: Status da tarefa de integração key: type: string description: Chave de negócio message: type: string description: Mensagem sequenceId: type: string description: Identificador da sequência de contabilização contabilizationFormId: type: string description: Forma de Contabilização recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página size: type: integer format: int64 description: Quantidade de registros por página orderBy: type: array items: type: object allOf: – #/definitions/fieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados fieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recRuleResult: description: Agrupador para resultados da lista de regras type: object properties: identifier: type: string description: identificador result: type: string description: resultado errorMsg: type: string description: mensagem de erro accountingFact: description: Fato contábil type: object required: – id – factId properties: id: type: string format: uuid description: Id da entidade number: type: integer format: int64 description: Número do fato groupFactId: type: string format: uuid description: Agrupador do fato factId: type: string format: uuid description: Indentificador do fato typeAccountingFact: type: string allOf: – #/definitions/enumAnaSin description: Tipo do fato contábil typeContabilization: type: string allOf: – #/definitions/enumAnaSin description: Tipo da contabilização usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: integrationTaskLot: description: Relacionamento lote x task type: object required: – task – accountingLot properties: id: type: string format: uuid description: ID task: type: string format: uuid description: Tarefas accountingLot: type: string format: uuid description: Lote Contábil usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: journalEntryPreparation: description: Preparação do lançamento type: object required: – id – accountingFact – indOrigin – sequenceGenerator – branch – datLct – process – debitAccount – debitAccRequiresAux – debitAccRequiresApport – creditAccount – creditAccRequiresAux – creditAccRequiresApport – valueLct – defaultHistory – complement properties: id: type: string format: uuid description: Id da entidade accountingFact: type: object allOf: – #/definitions/accountingFact description: Fato contábil indOrigin: type: string allOf: – #/definitions/enumOriLct description: Origem do lançamento origin: type: string format: uuid description: Identificador da origem do lancamento sequenceGenerator: type: string format: uuid description: Sequência geradora branch: type: string format: uuid description: Filial datLct: type: string format: date description: Data process: type: string format: uuid description: Id do processo debitAccount: type: string format: uuid description: Conta de débito debitAccRequiresAux: type: boolean description: Conta de débito exige composição auxiliar debitAccRequiresApport: type: boolean description: Conta de débito exige rateio creditAccount: type: string format: uuid description: Conta de crédito creditAccRequiresAux: type: boolean description: Conta de débito exige composição auxiliar creditAccRequiresApport: type: boolean description: Conta de débito exige rateio valueLct: type: string description: Valor do lançamento defaultHistory: type: string format: uuid description: Histórico padrão complement: type: string description: Complemento contabilizationType: type: string description: Forma de contabilização params: type: string format: byte description: Campo auxiliar para trafegar/persistir parâmetros. Uso interno message: type: string maxLength: 1000 description: Mensagem summarizedId: type: string format: uuid description: Preparação sumarizada journalEntryHistory: type: string description: Histórico do lançamento observation: type: string description: Observação complementar debitCgc: type: string format: uuid description: CPF/CNPJ de débito do lançamento creditCgc: type: string format: uuid description: CPF/CNPJ de crédito do lançamento workWithError: type: string format: uuid description: Work com erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: preparationApportionment: description: Rateio da preparação do lançamento type: object required: – id – preparation – costCenter – percent properties: id: type: string format: uuid description: Id da entidade preparation: type: object allOf: – #/definitions/journalEntryPreparation description: Preparação do lançamento costCenter: type: string format: uuid description: Centro de custos percent: type: number format: double description: Percentual rateio minimum: 0.0000 maximum: 999.9999 value: type: string description: Valor rateio minimum: 0.00 maximum: 9999999999.99 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: preparationAuxiliary: description: Composição auxiliar da preparação do lançamento type: object required: – id – preparation – auxiliaryAccount – debCre properties: id: type: string format: uuid description: Id da entidade preparation: type: object allOf: – #/definitions/journalEntryPreparation description: Preparação do lançamento auxiliaryAccount: type: string format: uuid description: Conta auxiliar relacionada à conta do pré lançamento debCre: type: string allOf: – #/definitions/enumDebCre description: Débito/crédito value: type: string description: Valor minimum: 0.00 maximum: 9999999999.99 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação