financas

2.0info: 1.0.0 financas description: Serviço de integração com o módulo de finanças x-senior-domain: Domínio base da logística x-senior-domain-path: erp_log_int x-senior-service-path: financas 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/erp_log_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /financas/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 /financas/queries/listarFaturas: post: description: Query para listagem de faturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltroFatura description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – faturas – totalRegistros properties: faturas: type: array items: type: object allOf: – #/definitions/recFaturaCompleta minimum: 1 description: Lista de faturas totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/queries/listarErros: post: description: Query para listagem de erros da fatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFatura – pageRequest properties: idFatura: type: string description: Identificador da fatura pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – erros – totalRegistros properties: erros: type: array items: type: object allOf: – #/definitions/recFaturaErroCompleto minimum: 1 description: Lista de erros totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/queries/listarEstagios: post: description: Query para listagem de estágios da fatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFatura properties: idFatura: type: string description: Identificador da fatura responses: 200: description: Ok schema: type: object required: – estagios properties: estagios: type: array items: type: object allOf: – #/definitions/recFaturaEstagioCompleto minimum: 1 description: Lista de estagios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para listagem de estágios da fatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idFatura description: Identificador da fatura in: query required: true type: string responses: 200: description: Ok schema: type: object required: – estagios properties: estagios: type: array items: type: object allOf: – #/definitions/recFaturaEstagioCompleto minimum: 1 description: Lista de estagios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/queries/listarTitulos: post: description: Query para listagem de títulos da fatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFatura – pageRequest properties: idFatura: type: string description: Identificador da fatura pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – titulos – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recFaturaTituloCompleto minimum: 1 description: Lista de títulos totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/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 /financas/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/queries/exportParticipante: 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 /financas/queries/exportFatura: 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 /financas/queries/exportFaturaErro: 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 /financas/queries/exportFaturaEstagio: 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 /financas/queries/exportFaturaTitulo: 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 /financas/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 /financas/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/actions/importParticipante: 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 /financas/actions/importFatura: 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 /financas/actions/importFaturaErro: 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 /financas/actions/importFaturaEstagio: 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 /financas/actions/importFaturaTitulo: 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 /financas/signals/registrarFatura: post: description: API responsável pelo registro da fatura no ERP Senior tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idFatura – filial – origemFatura – tipoFatura – numeroFatura – dataEmissao – participante – parcelas properties: idFatura: type: string description: Identificador da fatura filial: type: object allOf: – #/definitions/recFilial description: Filial origemFatura: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem da fatura tipoFatura: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura numeroFatura: type: string description: Número da fatura dataEmissao: type: string format: date description: Data de emissão participante: type: object allOf: – #/definitions/recParticipante description: Participante parcelas: type: array items: type: object allOf: – #/definitions/recTitulo minimum: 1 description: Parcelas da fatura documentos: type: array items: type: object allOf: – #/definitions/recDocumento description: Documentos da fatura camposPersonalizados: type: array items: type: object allOf: – #/definitions/recCampoPersonalizado description: Campos personalizados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /financas/signals/notificarFaturaGerada: post: description: API responsável pelo retorno do registro de fatura no ERP Senior tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idFatura – parcelas properties: idFatura: type: string description: Identificador da fatura parcelas: type: array items: type: object allOf: – #/definitions/recTitutloGerado minimum: 1 description: Parcelas da fatura responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /financas/signals/notificarFaturaRejeitada: post: description: API responsável pelo retorno da rejeição de integração da fatura no ERP Senior tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idFatura – motivo properties: idFatura: type: string description: Identificador da fatura motivo: type: string description: Motivo da rejeição responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /financas/events/faturaIncluida: post: description: Evento responsável pela confirmação do registro de fatura no ERP Senior x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – fatura properties: fatura: type: object allOf: – #/definitions/recFatura description: Fatura incluída responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /financas/events/faturaRejeitada: post: description: Evento responsável pela rejeição de integração da fatura com o ERP Senior x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – fatura – motivo properties: fatura: type: object allOf: – #/definitions/recFatura description: Fatura rejeitada motivo: type: string description: Motivo da rejeição responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /financas/events/importFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /financas/events/exportFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /financas/events/importParticipanteEvent: 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 /financas/events/exportParticipanteEvent: 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 /financas/events/importFaturaEvent: 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 /financas/events/exportFaturaEvent: 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 /financas/events/importFaturaErroEvent: 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 /financas/events/exportFaturaErroEvent: 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 /financas/events/importFaturaEstagioEvent: 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 /financas/events/exportFaturaEstagioEvent: 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 /financas/events/importFaturaTituloEvent: 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 /financas/events/exportFaturaTituloEvent: 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 /financas/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/filial/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFilial responses: 200: description: Ok schema: #/definitions/editFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/participante: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/participante responses: 200: description: The created resource schema: #/definitions/participante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/participante responses: 200: description: The created resource schema: #/definitions/participante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/participante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/participante/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editParticipante responses: 200: description: Ok schema: #/definitions/editParticipante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/participante responses: 200: description: Ok schema: #/definitions/participante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/participante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/participante/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/participante responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/fatura: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fatura responses: 200: description: The created resource schema: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fatura responses: 200: description: The created resource schema: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/fatura/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFatura responses: 200: description: Ok schema: #/definitions/editFatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fatura responses: 200: description: Ok schema: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/fatura/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fatura responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaErro: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaErro responses: 200: description: The created resource schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaErro responses: 200: description: The created resource schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaErro/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaErro responses: 200: description: Ok schema: #/definitions/editFaturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaErro responses: 200: description: Ok schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/fatura/{parentId}/erros: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaErro responses: 200: description: The created resources schema: type: array items: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaErro responses: 200: description: The created resources schema: type: array items: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/fatura/{parentId}/erros/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaErro responses: 200: description: Ok schema: #/definitions/editFaturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaErro responses: 200: description: Ok schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaErro/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faturaErro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaEstagio: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaEstagio responses: 200: description: The created resource schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaEstagio responses: 200: description: The created resource schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaEstagio/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaEstagio responses: 200: description: Ok schema: #/definitions/editFaturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaEstagio responses: 200: description: Ok schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/fatura/{parentId}/estagios: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaEstagio responses: 200: description: The created resources schema: type: array items: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaEstagio responses: 200: description: The created resources schema: type: array items: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/fatura/{parentId}/estagios/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaEstagio responses: 200: description: Ok schema: #/definitions/editFaturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaEstagio responses: 200: description: Ok schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaEstagio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaEstagio/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faturaEstagio responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaTitulo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaTitulo responses: 200: description: The created resource schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faturaTitulo responses: 200: description: The created resource schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaTitulo/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaTitulo responses: 200: description: Ok schema: #/definitions/editFaturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaTitulo responses: 200: description: Ok schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /financas/entities/fatura/{parentId}/titulos: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaTitulo responses: 200: description: The created resources schema: type: array items: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/faturaTitulo responses: 200: description: The created resources schema: type: array items: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/fatura/{parentId}/titulos/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFaturaTitulo responses: 200: description: Ok schema: #/definitions/editFaturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faturaTitulo responses: 200: description: Ok schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faturaTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financas/entities/faturaTitulo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faturaTitulo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumSortType: type: string enum: – ASC – DESC description: Define o tipo de ordenação: * `ASC` – Crescente * `DESC` – Decrescente enumSistemaOrigem: type: string enum: – ERP_SENIOR – TMS_TRANSPORTADOR description: Sistema de origem: * `ERP_SENIOR` – ERP Senior * `TMS_TRANSPORTADOR` – TMS Transportador enumTipoFatura: type: string enum: – FATURA_PAGAR – FATURA_RECEBER description: Tipo da fatura: * `FATURA_PAGAR` – Fatura a pagar * `FATURA_RECEBER` – Fatura a receber enumTipoConta: type: string enum: – CONTA_CORRENTE – CONTA_POUPANCA – CONTA_INVESTIMENTO – CONTA_APLICACAO_FINANCEIRA – CONTA_EMPRESTIMO – CONTA_CAPITAL – CONTA_RETENCAO – CONTA_LOJA – CONTA_SALARIO – OUTROS description: Tipo de conta: * `CONTA_CORRENTE` – Conta corrente * `CONTA_POUPANCA` – Conta poupança * `CONTA_INVESTIMENTO` – Conta investimento * `CONTA_APLICACAO_FINANCEIRA` – Conta aplicação financeira * `CONTA_EMPRESTIMO` – Conta empréstimo * `CONTA_CAPITAL` – Conta capital * `CONTA_RETENCAO` – Conta retenção * `CONTA_LOJA` – Conta loja * `CONTA_SALARIO` – Conta salário * `OUTROS` – OUTROS enumTipoDocumento: type: string enum: – CTE – NFSE – DOCNAOFISCAL description: Tipo do documento: * `CTE` – Conhecimento de transporte eletrônico * `NFSE` – Nota fiscal de serviço eletrônica * `DOCNAOFISCAL` – Documento não fiscal enumSituacaoFatura: type: string enum: – ERRO_INESPERADO – FATURA_VALIDADA – FATURA_PENDENTE – FATURA_INTEGRADA – FATURA_GERADA – FATURA_CANCELADA – PROCESSANDO_FATURA – PROCESSANDO_CONFIRMACAO – PROCESSANDO_CANCELAMENTO description: Situação da fatura: * `ERRO_INESPERADO` – Erro inesperado * `FATURA_VALIDADA` – Fatura validada * `FATURA_PENDENTE` – Fatura pendente * `FATURA_INTEGRADA` – Fatura integrada * `FATURA_GERADA` – Fatura gerada * `FATURA_CANCELADA` – Fatura cancelada * `PROCESSANDO_FATURA` – Processando fatura * `PROCESSANDO_CONFIRMACAO` – Processando confirmação * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento enumSituacaoTitulo: type: string enum: – FALHA_NA_VALIDACAO – PENDENTE – TITULO_GERADO – TITULO_BAIXADO – TITULO_CANCELADO – ERRO_INESPERADO description: Situação do título: * `FALHA_NA_VALIDACAO` – Falha na validação * `PENDENTE` – Pendente * `TITULO_GERADO` – Título gerado * `TITULO_BAIXADO` – Titulo baixado * `TITULO_CANCELADO` – Título cancelado * `ERRO_INESPERADO` – Erro inesperado userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_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 recFilial: description: Dados da filial type: object required: – cnpj – nome properties: cnpj: type: string description: CNPJ nome: type: string description: Nome fantasia: type: string description: Fantasia recParticipante: description: Dados do participante type: object required: – nome – fantasia – cnpjCpf – inscricaoEstadual – inscricaoMunicipal – endereco properties: nome: type: string description: Nome fantasia: type: string description: Fantasia cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal endereco: type: object allOf: – #/definitions/recParticipanteEndereco description: Endereço do participante codigoExterno: type: integer format: int64 description: Código externo recParticipanteEndereco: description: Endereço do participante type: object required: – cep – logradouro – cidade – estado properties: cep: type: string description: CEP logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado codigoMunicipio: type: integer format: int64 description: Código do município recTitulo: description: Dados do título type: object required: – idTitulo – numero – dataEmissao – dataEntrada – dataVencimento – valorOriginal properties: idTitulo: type: string description: Identificador do registro numero: type: string description: Número do título dataEmissao: type: string format: date description: Data de emissão dataEntrada: type: string format: date description: Data de entrada dataVencimento: type: string format: date description: Data de vencimento valorOriginal: type: string description: Valor original dataDesconto: type: string format: date description: Data do desconto valorDesconto: type: string description: Valor do desconto dataBaixa: type: string format: date description: Data da baixa valorBaixa: type: string description: Valor da baixa banco: type: string description: Banco agencia: type: string description: Agência tipoConta: type: string allOf: – #/definitions/enumTipoConta description: Tipo de conta numeroConta: type: string description: Número da conta rateio: type: object allOf: – #/definitions/recRateio description: Rateio do título recRateio: description: Rateio do título type: object properties: contas: type: array items: type: object allOf: – #/definitions/recConta description: Contas do rateio recConta: description: Conta do rateio type: object required: – contaFinanceira – percentual – centroCustos properties: contaFinanceira: type: string description: Conta financeira contaContabil: type: string description: Conta contábil percentual: type: number format: double description: Percentual centroCustos: type: array items: type: object allOf: – #/definitions/recCentroCusto minimum: 1 description: Centro de custos recCentroCusto: description: Centro de custo do rateio type: object required: – centroCusto – percentual properties: centroCusto: type: string description: Centro de custo percentual: type: number format: double description: Percentual recDocumento: description: Dados do documento type: object required: – tipo – cnpjEmitente – serie – numero – chaveAcesso properties: tipo: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento cnpjEmitente: type: string description: CNPJ do emitente serie: type: string description: Série do documento numero: type: string description: Número do documento chaveAcesso: type: string description: Chave de acesso recCampoPersonalizado: description: Campo personalizado para customizações type: object required: – chave – valor properties: chave: type: string description: Chave valor: type: string description: Valor recFatura: description: Dados para identificação da fatura type: object required: – idFatura – cnpjFilial – tipoFatura – numeroFatura – dataEmissao – cnpjCpfParticipante properties: idFatura: type: string description: Identificador do registro cnpjFilial: type: string description: CNPJ da filial tipoFatura: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura numeroFatura: type: string description: Número da fatura dataEmissao: type: string format: date description: Data de emissão cnpjCpfParticipante: type: string description: CNPJ/CPF do participante recTitutloGerado: description: Dados do título gerado no ERP Senior type: object required: – idTitulo – codigoEmpresa – codigoFilial – codigoParticipante – tipo – numero – valorAberto properties: idTitulo: type: string description: Identificador do registro codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial codigoParticipante: type: integer format: int64 description: Código do participante tipo: type: string description: Tipo de título numero: type: string description: Número do título valorAberto: type: string description: Valor em aberto recFiltroFatura: description: Dados do filtro para listagem das faturas type: object properties: idFilial: type: string description: Identificador da filial idParticipante: type: string description: Identificador do participante tipoFatura: type: array items: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoFatura description: Situação da fatura dataEmissaoInicial: type: string format: date description: Data de emissão inicial dataEmissaoFinal: type: string format: date description: Data de emissão final numeroFatura: type: string description: Número da fatura recFaturaCompleta: description: Dados para listagem das faturas type: object required: – id – origem – tipo – numero – dataEmissao – situacao – idExterno – dataGeracao – dataAtualizacao properties: id: type: string description: Identificador do registro filial: type: object allOf: – #/definitions/recFilial description: Filial participante: type: object allOf: – #/definitions/recParticipante description: Participante origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem da fatura tipo: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura numero: type: string description: Número do documento dataEmissao: type: string format: date description: Data de emissão situacao: type: string allOf: – #/definitions/enumSituacaoFatura description: Situação do registro nomeArquivo: type: string description: Nome do arquivo urlArquivo: type: string description: URL do arquivo idExterno: type: string description: Identificador externo da fatura dataGeracao: type: string format: date-time description: Data de geração dataAtualizacao: type: string format: date-time description: Data de atualização recFaturaErroCompleto: description: Dados para listagem de erros da fatura type: object required: – id – origem – motivo – dataGeracao – dataAtualizacao properties: id: type: string description: Identificador do registro origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem do erro motivo: type: string description: Motivo do erro dataGeracao: type: string format: date-time description: Data de geração dataAtualizacao: type: string format: date-time description: Data de atualização recFaturaEstagioCompleto: description: Dados para listagem de estágios da fatura type: object required: – id – situacao – mensagem properties: id: type: string description: Identificador do registro situacao: type: string allOf: – #/definitions/enumSituacaoFatura description: Situação do registro mensagem: type: string description: Descrição da ocorrência recFaturaTituloCompleto: description: Dados para listagem de títulos da fatura type: object required: – id – numero – situacao – idExterno – dataGeracao – dataAtualizacao properties: id: type: string description: Identificador do registro numero: type: string description: Número do título situacao: type: string allOf: – #/definitions/enumSituacaoTitulo description: Situação do título tipoErp: type: string description: Tipo do título no ERP Senior numeroErp: type: string description: Número do título no ERP Senior idExterno: type: string description: Identificador externo do título dataGeracao: type: string format: date-time description: Data de geração dataAtualizacao: type: string format: date-time description: Data de atualização recPageRequest: description: Dados dos parâmetros de paginação type: object properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros recFieldsOrderBy: description: Dados dos campos para ordenação type: object properties: field: type: string description: Nome do campo a ser ordenado sortType: type: string allOf: – #/definitions/enumSortType description: Tipo de ordenação do campo filial: description: Dados da filial type: object required: – id – cnpj – nome – fantasia properties: id: type: string format: uuid description: Identificador do registro cnpj: type: string description: CNPJ nome: type: string description: Nome fantasia: type: string description: Fantasia usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editFilial: type: object required: – id allOf: – #/definitions/filial participante: description: Dados do participante type: object required: – id – cnpjCpf – nome – fantasia properties: id: type: string format: uuid description: Identificador do registro cnpjCpf: type: string description: CNPJ/CPF nome: type: string description: Nome fantasia: type: string description: Fantasia usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editParticipante: type: object required: – id allOf: – #/definitions/participante fatura: description: Dados da fatura type: object required: – id – origem – tipo – numero – dataEmissao – situacao – idExterno properties: id: type: string format: uuid description: Identificador do registro filial: type: object allOf: – #/definitions/filial description: Filial participante: type: object allOf: – #/definitions/participante description: Participante origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem da fatura tipo: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura numero: type: string description: Número do documento dataEmissao: type: string format: date description: Data de emissão situacao: type: string allOf: – #/definitions/enumSituacaoFatura description: Situação do registro nomeArquivo: type: string description: Nome do arquivo urlArquivo: type: string description: URL do arquivo idExterno: type: string description: Identificador externo erros: type: array items: type: object allOf: – #/definitions/faturaErro description: Erros da fatura estagios: type: array items: type: object allOf: – #/definitions/faturaEstagio description: Estágios da fatura titulos: type: array items: type: object allOf: – #/definitions/faturaTitulo description: Títulos da fatura usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editFatura: type: object required: – id allOf: – #/definitions/fatura faturaErro: description: Erros da fatura type: object required: – id – origem – motivo properties: id: type: string format: uuid description: Identificador do registro origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem do erro motivo: type: string description: Motivo do erro fatura: type: object allOf: – #/definitions/fatura description: Fatura origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editFaturaErro: type: object required: – id allOf: – #/definitions/faturaErro faturaEstagio: description: Estágios da fatura type: object required: – id – situacao – mensagem properties: id: type: string format: uuid description: Identificador do registro situacao: type: string allOf: – #/definitions/enumSituacaoFatura description: Situação do registro mensagem: type: string description: Descrição da ocorrência fatura: type: object allOf: – #/definitions/fatura description: Fatura origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editFaturaEstagio: type: object required: – id allOf: – #/definitions/faturaEstagio faturaTitulo: description: Títulos da fatura type: object required: – id – numero – situacao – idExterno properties: id: type: string format: uuid description: Identificador do registro numero: type: string description: Número do título situacao: type: string allOf: – #/definitions/enumSituacaoTitulo description: Situação do título tipoErp: type: string description: Tipo do título no ERP Senior numeroErp: type: string description: Número do título no ERP Senior idExterno: type: string description: Identificador externo fatura: type: object allOf: – #/definitions/fatura description: Fatura usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editFaturaTitulo: type: object required: – id allOf: – #/definitions/faturaTitulo 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage