2.0info: 1.11.0 register_pix description: Serviço de fachada para APIs públicas de cobrança PIX x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: register_pix 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_bnk_cobsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /register_pix/queries/healthcheck: post: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/queries/getStatusPixBilling: post: description: Query de listagem do status dos títulos de cobrança PIX\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_pix/queries/getStatusPixBilling tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterGetStatusPixBilling description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – pixBillingData properties: pixBillingData: type: array items: type: object allOf: – #/definitions/recPixBillingData minimum: 1 description: Dados da cobrança Pix 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não encontrado default: description: Error response schema: #/definitions/genericError /register_pix/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 /register_pix/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/queries/exportE070fil: 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 /register_pix/queries/exportCobrancaDadosPix: 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 /register_pix/queries/exportCobrancaItemPix: 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 /register_pix/queries/exportCancelamentoPix: 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 /register_pix/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 /register_pix/actions/registerPixBilling: post: description: API responsável pela criação do registro de cobrança assíncrona de PIX copia e cola\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_pix/actions/registerPixBilling tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – branch – receivableBankData – accountsReceivable properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento receivableBankCode: type: string maxLength: 3 description: Código do Banco de recebimento company: type: object allOf: – #/definitions/recCompany description: Identificação da empresa branch: type: object allOf: – #/definitions/recBranch description: Identificador da filial receivableBankData: type: object allOf: – #/definitions/recReceivableBankData description: Dados bancários do recebimento accountsReceivable: type: array items: type: object allOf: – #/definitions/recAccountReceivable minimum: 1 description: Lista de títulos que serão registrados as cobranças responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador do processo informado no input da API 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /register_pix/actions/cancelPixBilling: post: description: API responsável pelo cancelamento do registro de cobrança do PIX\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_pix/actions/cancelPixBilling tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – accountsReceivableId properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cancelamento) accountsReceivableId: type: array items: type: string minimum: 1 description: Lista de identificadores dos títulos a serem cancelados responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador do processo informado no input da API 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /register_pix/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/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 /register_pix/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/actions/importE070fil: 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 /register_pix/actions/importCobrancaDadosPix: 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 /register_pix/actions/importCobrancaItemPix: 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 /register_pix/actions/importCancelamentoPix: 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 /register_pix/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /register_pix/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /register_pix/events/importE070filEvent: 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 /register_pix/events/exportE070filEvent: 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 /register_pix/events/importCobrancaDadosPixEvent: 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 /register_pix/events/exportCobrancaDadosPixEvent: 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 /register_pix/events/importCobrancaItemPixEvent: 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 /register_pix/events/exportCobrancaItemPixEvent: 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 /register_pix/events/importCancelamentoPixEvent: 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 /register_pix/events/exportCancelamentoPixEvent: 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 /register_pix/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/entities/e070fil: 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: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/entities/cobrancaDadosPix/{parentId}/titulos: post: description: Esta entidade pode ser customizada. 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/cobrancaItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPix 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/cobrancaItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPix 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: 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/cobrancaItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_pix/entities/cobrancaDadosPix/{parentId}/titulos/{id}: put: description: Esta entidade pode ser customizada. 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/editCobrancaItemPix responses: 200: description: Ok schema: #/definitions/editCobrancaItemPix 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cobrancaItemPix responses: 200: description: Ok schema: #/definitions/cobrancaItemPix 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cobrancaItemPix 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: 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 definitions: enumTypeOrder: type: string enum: – ASC – DESC description: Enumeração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumReceivableBank: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – ABC – BV description: Enumeration de bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `ABC` – ABC – 246 * `BV` – BV – 655 enumCalculationType: type: string enum: – PERCENTAGE – FIXED_VALUE description: Enumeration do tipo de cálculo dos valores de cobrança do título: * `PERCENTAGE` – Percentual * `FIXED_VALUE` – Valor fixo enumCalculationTypeDiscount: type: string enum: – FIXED_VALUE_UNTIL_LIMIT_DATE – PERCENTAGE_UNTIL_LIMIT_DATE – VALUE_FOR_ADVANCE_CALENDAR_DAY – VALUE_FOR_ADVANCE_BUSINESS_DAY – PERCENTAGE_FOR_ADVANCE_CALENDAR_DAY – PERCENTAGE_FOR_ADVANCE_BUSINESS_DAY description: Enumeration do tipo de cálculo dos valores de desconto do título: * `FIXED_VALUE_UNTIL_LIMIT_DATE` – Valor fixo até a(s) data(s) informada(s) * `PERCENTAGE_UNTIL_LIMIT_DATE` – Percentual até a data informada * `VALUE_FOR_ADVANCE_CALENDAR_DAY` – Valor por antecipação dia corrido * `VALUE_FOR_ADVANCE_BUSINESS_DAY` – Valor por antecipação dia útil * `PERCENTAGE_FOR_ADVANCE_CALENDAR_DAY` – Percentual por antecipação dia corrido * `PERCENTAGE_FOR_ADVANCE_BUSINESS_DAY` – Percentual por antecipação dia útil enumCalculationTypeInterest: type: string enum: – VALUE_FOR_CALENDAR_DAYS – PERCENTAGE_FOR_CALENDAR_DAYS – PERCENTAGE_FOR_CALENDAR_MONTH – PERCENTAGE_FOR_CALENDAR_YEAR – VALUE_FOR_BUSINESS_DAYS – PERCENTAGE_FOR_BUSINESS_DAYS – PERCENTAGE_FOR_BUSINESS_MONTH – PERCENTAGE_FOR_BUSINESS_YEAR description: Enumeration do tipo de cálculo dos valores de juros do título: * `VALUE_FOR_CALENDAR_DAYS` – Valor (dias corridos) * `PERCENTAGE_FOR_CALENDAR_DAYS` – Percentual ao dia (dias corridos) * `PERCENTAGE_FOR_CALENDAR_MONTH` – Percentual ao mês (dias corridos) * `PERCENTAGE_FOR_CALENDAR_YEAR` – Percentual ao ano (dias corridos) * `VALUE_FOR_BUSINESS_DAYS` – Valor (dias úteis) * `PERCENTAGE_FOR_BUSINESS_DAYS` – Percentual ao dia (dias úteis) * `PERCENTAGE_FOR_BUSINESS_MONTH` – Percentual ao mês (dias úteis) * `PERCENTAGE_FOR_BUSINESS_YEAR` – Percentual ao ano (dias úteis) enumBancoRecebimento: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – ABC – BV description: Enumeration dos bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `ABC` – ABC – 246 * `BV` – BV – 655 enumTipoCalculo: type: string enum: – PERCENTUAL – VALOR_FIXO description: Enumeration do tipo de cálculo dos valores de cobrança do título: * `PERCENTUAL` – Percentual * `VALOR_FIXO` – Valor fixo enumTipoCalculoDesconto: type: string enum: – VALOR_FIXO_ATE_DATA_INFORMADA – PERCENTUAL_FIXO_ATE_DATA_INFORMADA – VALOR_POR_ANTECIPACAO_DIA_CORRIDO – VALOR_POR_ANTECIPACAO_DIA_UTIL – PERCENTUAL_POR_ANTECIPACAO_DIA_CORRIDO – PERCENTUAL_POR_ANTECIPACAO_DIA_UTIL description: Enumeration do tipo de cálculo dos valores de desconto do título: * `VALOR_FIXO_ATE_DATA_INFORMADA` – Valor fixo até a(s) data(s) informada(s) * `PERCENTUAL_FIXO_ATE_DATA_INFORMADA` – Percentual até a data informada * `VALOR_POR_ANTECIPACAO_DIA_CORRIDO` – Valor por antecipação dia corrido * `VALOR_POR_ANTECIPACAO_DIA_UTIL` – Valor por antecipação dia útil * `PERCENTUAL_POR_ANTECIPACAO_DIA_CORRIDO` – Percentual por antecipação dia corrido * `PERCENTUAL_POR_ANTECIPACAO_DIA_UTIL` – Percentual por antecipação dia útil enumTipoCalculoJuros: type: string enum: – VALOR_DIAS_CORRIDOS – PERCENTUAL_AO_DIA_DIAS_CORRIDOS – PERCENTUAL_AO_MES_DIAS_CORRIDOS – PERCENTUAL_AO_ANO_DIAS_CORRIDOS – VALOR_DIAS_UTEIS – PERCENTUAL_AO_DIA_DIAS_UTEIS – PERCENTUAL_AO_MES_DIAS_UTEIS – PERCENTUAL_AO_ANO_DIAS_UTEIS description: Enumeration do tipo de cálculo dos valores de juros do título: * `VALOR_DIAS_CORRIDOS` – Valor (dias corridos) * `PERCENTUAL_AO_DIA_DIAS_CORRIDOS` – Percentual ao dia (dias corridos) * `PERCENTUAL_AO_MES_DIAS_CORRIDOS` – Percentual ao mês (dias corridos) * `PERCENTUAL_AO_ANO_DIAS_CORRIDOS` – Percentual ao ano (dias corridos) * `VALOR_DIAS_UTEIS` – Valor (dias úteis) * `PERCENTUAL_AO_DIA_DIAS_UTEIS` – Percentual ao dia (dias úteis) * `PERCENTUAL_AO_MES_DIAS_UTEIS` – Percentual ao mês (dias úteis) * `PERCENTUAL_AO_ANO_DIAS_UTEIS` – Percentual ao ano (dias úteis) enumSituacaoCobrancaItem: type: string enum: – AGUARDANDO_COBRANCA – PROCESSANDO_COBRANCA – PROCESSANDO_CANCELAMENTO – FALHA_NA_VALIDACAO – COBRANCA_GERADA – COBRANCA_PAGA – COBRANCA_COM_PROBLEMAS – COBRANCA_CANCELADA – COBRANCA_INAPTA_PARA_PROCESSAMENTO – ERRO_INESPERADO – COBRANCA_INATIVADA description: Enumeration de situação da cobrança item: * `AGUARDANDO_COBRANCA` – Aguardando cobrança * `PROCESSANDO_COBRANCA` – Processando cobrança * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento * `FALHA_NA_VALIDACAO` – Falha na validação * `COBRANCA_GERADA` – Cobrança gerada * `COBRANCA_PAGA` – Cobrança paga * `COBRANCA_COM_PROBLEMAS` – Cobrança com problemas * `COBRANCA_CANCELADA` – Cobrança cancelada * `COBRANCA_INAPTA_PARA_PROCESSAMENTO` – Cobrança inapta para processamento * `ERRO_INESPERADO` – Erro inesperado * `COBRANCA_INATIVADA` – Cobrança inativada enumSituacaoCancelamento: type: string enum: – PROCESSANDO – FINALIZADO description: Enumeration da situação do cancelamento do registro PIX: * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado 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 recFilterGetStatusPixBilling: description: Record do filtro de status dos títulos de cobrança Pix type: object properties: billingId: type: array items: type: string description: Lista de Identificadores dos títulos startDate: type: string format: date description: Data de envio inicial endDate: type: string format: date description: Data de envio final recPixBillingData: description: Record de dados da cobrança Pix type: object required: – accountReceivableId – situation – valueReceived – originalValue – rebateValue – assessmentValue – discountValue – interestValue – payDate – endToEndId properties: accountReceivableId: type: string description: Identificador do título situation: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação da geração do PIX creationDate: type: string format: date description: Data de criação do PIX errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do PIX pixCopyAndPaste: type: string description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string description: Pix QRCode valueReceived: type: string description: Valor recebido originalValue: type: string description: Valor original rebateValue: type: string description: Valor de abatimento assessmentValue: type: string description: Valor de multa discountValue: type: string description: Valor de desconto interestValue: type: string description: Valor de juros payDate: type: string format: date-time description: Data/Hora do Recebimento payerInformation: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento recError: description: Record com informações de erro pix type: object required: – message properties: message: type: string description: Mensagem de erro field: type: string description: Campo do erro recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size 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 a serem pesquisados recFieldsOrderBy: 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) 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 recCompany: description: Record de identificação da empresa type: object properties: id: type: string description: Identificador do registro na plataforma code: type: integer format: int64 description: Código recBranch: description: Record de identificação da filial type: object properties: id: type: string description: Identificador do registro na plataforma code: type: integer format: int64 description: Código documentNumber: type: string description: Número do documento nifNumber: type: string description: Número de identificação fiscal recCustomer: description: Record de identificação do cliente type: object properties: id: type: string description: Identificador do registro na plataforma documentNumber: type: string maxLength: 14 description: Número do documento name: type: string maxLength: 100 description: Nome tradeName: type: string maxLength: 50 description: Nome fantasia codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 recAccountReceivable: description: Record com as informações do título para registro de cobrança type: object required: – accountReceivableId – accountReceivableNumber – accountReceivableType – customer – dueDate – values properties: accountReceivableId: type: string description: Identificador do título accountReceivableNumber: type: string description: Número do título accountReceivableType: type: string description: Tipo do título customer: type: object allOf: – #/definitions/recCustomer description: Identificador do cliente dueDate: type: string format: date description: Data de vencimento validityAfterExpiration: type: integer format: int64 description: Dias corridos após o vencimento que a cobrança poderá ser paga minimum: 0 maximum: 9999 values: type: object allOf: – #/definitions/recValuesRegisterBilling description: Valores do título additionalPixInformations: type: object allOf: – #/definitions/recAdditionalPixInformations description: Informações adicionais do pix recAdditionalPixInformations: description: Record de informações adicionais do pix type: object properties: payerRequest: type: string maxLength: 140 description: Solicitação do pagador additionalInformations: type: array items: type: object allOf: – #/definitions/recAdditionalInformations description: Informações adicionais recValuesRegisterBilling: description: Record de valores do título de cobrança type: object required: – original properties: original: type: string description: Valor original interest: type: object allOf: – #/definitions/recCalculationInterest description: Juros assessment: type: object allOf: – #/definitions/recCalculationValue description: Multas rebate: type: object allOf: – #/definitions/recCalculationValue description: Abatimentos discount: type: object allOf: – #/definitions/recCalculationDiscount description: Descontos recCalculationValue: description: Record das regras de cálculos dos valores type: object required: – calculationType – valueOrPercentage properties: calculationType: type: string allOf: – #/definitions/enumCalculationType description: Tipo de cálculo valueOrPercentage: type: string description: Valor ou porcentual recCalculationInterest: description: Record das regras de cálculos dos juros type: object required: – calculationType – valueOrPercentage properties: calculationType: type: string allOf: – #/definitions/enumCalculationTypeInterest description: Tipo de cálculo valueOrPercentage: type: string description: Valor ou porcentual recCalculationDiscount: description: Record das regras de cálculos dos descontos type: object required: – calculationType properties: calculationType: type: string allOf: – #/definitions/enumCalculationTypeDiscount description: Tipo de cálculo valueOrPercentage: type: string description: Valor ou porcentual discountFixedDate: type: array items: type: object allOf: – #/definitions/recDiscountFixedDate description: Descontos definidos de acordo com a data estabelecida recDiscountFixedDate: description: Record de descontos de acordo com uma data estabelecida type: object required: – limitDate – valueOrPercentage properties: limitDate: type: string format: date description: Data limite valueOrPercentage: type: string description: Valor ou percentual recAdditionalInformations: description: Record de informações adicionais type: object required: – name – value properties: name: type: string maxLength: 50 description: Nome value: type: string maxLength: 200 description: Valor recReceivableBankData: description: Record de dados do recebimento bancário type: object required: – pixKey – branchNumber – accountNumber properties: pixKey: type: string description: Chave pix branchNumber: type: string maxLength: 5 description: Número da agência branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: string maxLength: 15 description: Número da conta accountDigit: type: string maxLength: 2 description: Dígito da conta e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaDadosPix: description: Entidade de dados da cobrança de pix type: object required: – id – processoId – filialId properties: id: type: string format: uuid description: Identificador do registro processoId: type: string description: Identificador do processo (utilizado pelo ERP externo) filialId: type: string format: uuid description: Identificador da filial titulos: type: array items: type: object allOf: – #/definitions/cobrancaItemPix description: Títulos da cobrança usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaItemPix: description: Entidade de dados do título da cobrança de pix type: object required: – tituloId – situacao properties: id: type: string format: uuid description: Identificador do registro cobrancaDadosPix: type: object allOf: – #/definitions/cobrancaDadosPix description: Cobrança de dados pix relacionada tituloId: type: string format: uuid description: Identificador do título situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemPix: type: object required: – id allOf: – #/definitions/cobrancaItemPix cancelamentoPix: description: Entidade responsável por armazenar as informações de cancelamento de registro PIX type: object required: – processoId – situacao properties: id: type: string format: uuid description: Identificador do registro processoId: type: string description: Identificador do processo (utilizado pelo ERP externo) situacao: type: string allOf: – #/definitions/enumSituacaoCancelamento description: Situação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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