facade

2.0info: 1.3.1 facade description: APIs públicas para o módulo Finanças do ERPX. x-senior-domain: erpx_fin_int x-senior-domain-path: erpx_fin_int x-senior-service-path: facade 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_fin_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /facade/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 /facade/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 /facade/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 /facade/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/actions/refreshFdw: post: description: Realiza a criação das referências do FDW tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/events/personAccountsReceivableCreatedSuccess: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticker – id properties: ticker: type: string description: Ticket identifier id: type: string description: Entity identifier responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/personAccountsReceivableUpdatedSuccess: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticker properties: ticker: type: string description: Ticket identifier responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/personAccountsReceivableCreateError: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – errorMessage properties: ticket: type: string description: Ticket identifier errorMessage: type: string description: Error message stackTrace: type: string description: Stacktrace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/personAccountsReceivableUpdateError: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – errorMessage properties: ticket: type: string description: Ticket identifier errorMessage: type: string description: Error message stackTrace: type: string description: Stacktrace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/apis/getReceivableTitle: post: description: Utilizada para buscar informações detalhadas de um título a receber. tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getReceivableTitleFacadeInput responses: 200: description: Ok schema: #/definitions/getReceivableTitleFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/apis/personAccountsReceivable: post: description: Responsável pela criação, atualização e exclusão da entidade de especialização do contas a receber. tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/personAccountsReceivableFacadeInput responses: 200: description: Ok schema: #/definitions/personAccountsReceivableFacadeOutput 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/apis/personAccountsReceivable/{id}: put: description: Responsável pela criação, atualização e exclusão da entidade de especialização do contas a receber. tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/personAccountsReceivableFacadeInput responses: 200: description: Ok schema: #/definitions/personAccountsReceivableFacadeOutput 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Responsável pela criação, atualização e exclusão da entidade de especialização do contas a receber. tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down interestType: type: string enum: – SIMPLE_INTEREST – COMPOUND_INTEREST description: Tipo de juros: * `SIMPLE_INTEREST` – Juros Simples * `COMPOUND_INTEREST` – Juros Compostos enumSitReg: type: string enum: – ACTIVE – INACTIVE description: Situação do registro: * `ACTIVE` – Ativo * `INACTIVE` – Inativo earlyPaymentDiscountPeriod: type: string enum: – DAILY – WEEKLY – BIWEEKLY – MONTHLY – QUARTELY – SEMIANNUAL – ANNUAL description: Período para cálculo do desconto antecipado: * `DAILY` – Diário * `WEEKLY` – Semanal * `BIWEEKLY` – Quinzenal * `MONTHLY` – Mensal * `QUARTELY` – Trimestral * `SEMIANNUAL` – Semestral * `ANNUAL` – Anual enumBankingSituation: type: string enum: – NOT_SENT – SENT_GENERATION – RETURNED_GENERATION – RETURNED_PAID – CANCELED – ERROR – CANCELING description: Status do PIX: * `NOT_SENT` – Não Enviado * `SENT_GENERATION` – Enviado Geração * `RETURNED_GENERATION` – Retornado Geração * `RETURNED_PAID` – Retornado Pago * `CANCELED` – Cancelado * `ERROR` – Erro * `CANCELING` – Em cancelamento enumEmailStatus: type: string enum: – NOT_SENT – PROCESSING – SENT – ERROR description: Status do envio por email: * `NOT_SENT` – Não enviado * `PROCESSING` – Processando * `SENT` – Enviado * `ERROR` – Erro enumTitleSituation: type: string enum: – OPEN_CREDIT_PROTECTION_AGENCY – OPEN_NEGOTIATION – OPEN_LAWYER – OPEN_NORMAL – OPEN_NOTARY – OPEN_SETTLEMENT – OPEN_TAXES – OPEN_LEGAL_RETURN – OPEN_PROTESTED – OPEN_REPRESENTATIVE – OPEN_SUSPENDED – OPEN_HUMAN_RESOURCES – OPEN_EXTERNAL – CANCELED – OPEN_BOOK_COLLECTION – OPEN_COLLECTION – LIQUIDATED_NORMAL – LIQUIDATED_NOTARY – LIQUIDATED_TAXES – LIQUIDATED_COMPENSATED – LIQUIDATED_COLLECTION – LIQUIDATED_PROTESTED – LIQUIDATED_REPLACED – LIQUIDATED_HUMAN_RESOURCES – LIQUIDATED_EXTERNAL – OPEN_ELECTRONIC_PAYMENT – WRITE_OFF_PROCESSING – OPEN_ELECTRONIC_COLLECTION description: Situação do Título: * `OPEN_CREDIT_PROTECTION_AGENCY` – Aberto ao Órgão de Proteção ao Crédito * `OPEN_NEGOTIATION` – Aberto Negociação * `OPEN_LAWYER` – Aberto Advogado * `OPEN_NORMAL` – Aberto Normal * `OPEN_NOTARY` – Aberto Cartório * `OPEN_SETTLEMENT` – Aberto Encontro de Contas * `OPEN_TAXES` – Aberto Impostos * `OPEN_LEGAL_RETURN` – Aberto Retorno Jurídico * `OPEN_PROTESTED` – Aberto Protestado * `OPEN_REPRESENTATIVE` – Aberto Representante * `OPEN_SUSPENDED` – Aberto Suspenso * `OPEN_HUMAN_RESOURCES` – Aberto Gestão de Pessoas * `OPEN_EXTERNAL` – Aberto Externo * `CANCELED` – Cancelado * `OPEN_BOOK_COLLECTION` – Aberto CE (Cobrança Escritural) * `OPEN_COLLECTION` – Aberto Cobrança * `LIQUIDATED_NORMAL` – Liquidado Normal * `LIQUIDATED_NOTARY` – Liquidado Cartório * `LIQUIDATED_TAXES` – Liquidado Impostos * `LIQUIDATED_COMPENSATED` – Liquidado Compensado * `LIQUIDATED_COLLECTION` – Liquidado Cobrança * `LIQUIDATED_PROTESTED` – Liquidado Protestado * `LIQUIDATED_REPLACED` – Liquidado Substituído * `LIQUIDATED_HUMAN_RESOURCES` – Liquidado Gestão de Pessoas * `LIQUIDATED_EXTERNAL` – Liquidado Externo * `OPEN_ELECTRONIC_PAYMENT` – Aberto PE (Pagamento Eletrônico) * `WRITE_OFF_PROCESSING` – Em Processo de Baixa * `OPEN_ELECTRONIC_COLLECTION` – Aberto (Cobrança Eletrônica) enumValueType: type: string enum: – EQUAL – SPLIT description: Indica se o valor será igual ou dividido entre as parcelas: * `EQUAL` – Indica que o valor será igual entre as parcelas * `SPLIT` – Indica que o valor será dividido entre as parcelas enumAccountingBaseDate: type: string enum: – ENTRY – DUE description: Data base contábil: * `ENTRY` – Entrada * `DUE` – Vencimento 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 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 companyIdentifier: description: Dados de identificação da empresa type: object properties: id: type: string description: Identificador único da empresa code: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 branchIdentifier: description: Dados de identificação da filial type: object properties: id: type: string description: Identificador único da filial code: type: integer format: int64 description: Codigo da filial minimum: 0 maximum: 9999 documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF nifNumber: type: string maxLength: 40 description: Número de identificação fiscal genericIdCode: description: Record entrada de informações principais de uma entidade type: object properties: id: type: string description: Identificador da entidade code: type: string description: Código de negócio recBranchReceivable: description: Record da filial especializada type: object required: – branchId – bearerId properties: branchId: type: string description: Identificador da filial bearerId: type: string description: Identificador do portador recCompany: description: Record da empresa type: object required: – id – code – name – currency properties: id: type: string description: Identificador da empresa code: type: integer format: int64 description: Código da empresa name: type: string description: Nome da empresa currency: type: string description: Moeda da empresa recBranch: description: Record da filial type: object required: – id – code – name – companyId – companyCode properties: id: type: string description: Identificador da filial code: type: integer format: int64 description: Código da filial name: type: string description: Nome da filial companyId: type: string description: Identificador da empresa companyCode: type: integer format: int64 description: Código da empresa recOrigin: description: Record origem type: object properties: invoiceNumber: type: integer format: int64 description: Número nota fiscal serialCode: type: string description: Código série serialDescription: type: string description: Descrição série recGeneric: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string description: Identificador da entidade label: type: string description: Descrição do label code: type: string description: Código de negócio description: type: string description: Descrição de negócio recReceivable: description: Record de retorno da pesquisa de duplicatas a receber discriminator: _discriminator type: object required: – id – branch – titleType – customer – currency – titleNumber – titleSituation – predictedTitle – effectiveAdvanceTitle – originalDueDate – extendedDueDate – emissionDate – entryDate – probablePaymentDate – values – _discriminator properties: id: type: string description: Identificador do título company: type: object allOf: – #/definitions/recCompany description: Empresa + Moeda branch: type: object allOf: – #/definitions/recBranch description: Empresa + Codigo da filial + Nome da filial branchReceivable: type: object allOf: – #/definitions/recBranchReceivable description: Filial especializada titleType: type: object allOf: – #/definitions/recGeneric description: Tipo de título + Descrição customer: type: object allOf: – #/definitions/recGeneric description: Código do cliente + Nome do cliente paymentMethod: type: object allOf: – #/definitions/recPaymentMethod description: Forma de pagamento + Descrição currency: type: object allOf: – #/definitions/recGeneric description: Moeda + Sigla bearer: type: object allOf: – #/definitions/recGeneric description: Portador titleNumber: type: string maxLength: 15 description: Número do título titleSituation: type: string allOf: – #/definitions/enumTitleSituation description: Situação do título predictedTitle: type: boolean description: Indicativo se o título é previsto effectiveAdvanceTitle: type: boolean description: Indicativo se o título é adiantamento efetivo originalDueDate: type: string format: date description: Vencimento original extendedDueDate: type: string format: date description: Vencimento prorrogado emissionDate: type: string format: date description: Data de emissão entryDate: type: string format: date description: Data de entrada probablePaymentDate: type: string format: date description: Data de provável pagamento lastPaymentDate: type: string format: date description: Data do último pagamento interestDays: type: integer format: int64 description: Dias juros delayDays: type: integer format: int64 description: Dias atraso shippingNumber: type: integer format: int64 description: Número da remessa values: type: object allOf: – #/definitions/recTitleValues description: Valores do título emailStatus: type: string allOf: – #/definitions/enumEmailStatus description: Status do envio de email emailError: type: string description: Mensagem de erro do envio de email internalAccountSuggestion: type: object allOf: – #/definitions/recGeneric description: Sugestão Conta interna validSuggestedInternalAccount: type: boolean description: Indicativo se a conta interna sugerida é valida financialBatch: type: string description: Lote financeiro pixInformation: type: object allOf: – #/definitions/recPixInformation description: Informações do PIX do título _discriminator: type: string description: recEditionReceivable: description: Record de retorno da pesquisa de edição de títulos allOf: – #/definitions/recReceivable – type: object required: – observation – extensionWithInterests properties: transaction: type: object allOf: – #/definitions/recGeneric description: Transação billingPortfolio: type: object allOf: – #/definitions/recGeneric description: Carteira de cobrança group: type: object allOf: – #/definitions/recGeneric description: Grupo bankShippingNumber: type: string description: Número de remessa de envio ao banco observation: type: string description: Observação emissionCurrencyQuotation: type: string description: Cotação Moeda Emissão extensionWithInterests: type: boolean description: Prorrogação c/ Juros defaultInterestCalculatedDate: type: string format: date description: Data Juros Mora Calculado currentAccountDigit: type: string description: Dígito da Conta Corrente barCode: type: string description: Código Barra negotiatedValueDate: type: string format: date description: Data Valores Negociados negotiatedInterestValue: type: string description: Valor Juros Negociados negotiatedFineValue: type: string description: Valor Multa Negociada negotiatedDiscountValue: type: string description: Valor Descontos Negociados othersNegotiated: type: string description: Outros Negociados negotiatedCurrencyQuotation: type: string description: Cotação Moeda Negociada calculateAnticipatedDiscount: type: boolean description: Calcula Desc. Antecipação default: false discountCalculationPeriod: type: string description: Período para cálculo do desconto discountDate: type: string format: date description: Data/Tolerância Desconto discountPercentage: type: number format: double description: Percentual/Valor Desconto finePercentage: type: number format: double description: Percentual/Tolerância Multa fineToleranceDays: type: integer format: int64 description: Dias Tolerância Multa discountToleranceDays: type: integer format: int64 description: Dias Tolerância Desconto dailyDefaultInterestValue: type: string description: Valor Juros Mora Dia interestPercentage: type: number format: double description: Percentual/Tipo Juros interestType: type: string allOf: – #/definitions/interestType description: Tipo de Juros interestToleranceDays: type: integer format: int64 description: Dias Tolerância Juros creditTitle: type: boolean description: Indicativo se titulo é de crédito ourNumber: type: string description: Nosso número credit: type: boolean description: Crédito origin: type: object allOf: – #/definitions/recOrigin description: Origem recPaymentMethod: description: Record forma de pagamento type: object required: – id properties: id: type: string description: Identificador da entidade code: type: string maxLength: 5 description: Código da Entidade description: type: string maxLength: 60 description: Descrição/nome do registro da entidade label: type: string maxLength: 65 description: Label legível para o front type: type: string description: Tipo pagamento recTitleValues: description: Record de valores dos títulos type: object required: – originalValue – openValue properties: originalValue: type: string description: Valor original minimum: 0.00 maximum: 9999999999999.99 openValue: type: string description: Valor aberto do título minimum: 0.00 maximum: 9999999999999.99 writeOffValue: type: string description: Valor a baixar discountValue: type: string description: Valor descontos otherDiscountsValue: type: string description: Valor outros descontos interestValue: type: string description: Valor Juros finesValue: type: string description: Valor multa otherAdditionsValue: type: string description: Valor outros acréscimos chargesValue: type: string description: Valor encargos monetaryAdjustmentValue: type: string description: Valor correção monetária netValue: type: string description: Valor líquido withholdingTaxesValue: type: string description: Valor de impostos retidos movementQuotationValue: type: string description: Valor cotação movimento readjustingValue: type: string description: Valor reajuste recPixInformation: description: Record com as informações do PIX do título type: object properties: id: type: string description: Identificador da entidade expirationDaysAfterDueDate: type: integer format: int64 description: Data expiração em dias pós vencimento payerRequest: type: string description: Solicitação do pagador additionalInformation: type: array items: type: object allOf: – #/definitions/recPixTitleAdditionalInformation description: Informações adicionais pixCopyPaste: type: string description: Pix copia e cola pixQRCode: type: string description: Pix QRCode (Base64) integrationErrors: type: array items: type: object allOf: – #/definitions/recPixTitleError description: Erros da integração amountPaid: type: string description: Valor recebido paymentDateTime: 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 situation: type: string allOf: – #/definitions/enumBankingSituation description: Situação da geração do PIX recCustomerAddress: description: Retornar o endereço da pessoa para o front-end type: object required: – id properties: id: type: string description: Identificador da entidade customerAddress: type: string maxLength: 100 description: Endereço do cliente addressNumber: type: string maxLength: 60 description: Número do endereço addressComplement: type: string maxLength: 200 description: Complemento do endereço addressCep: type: string maxLength: 20 description: CEP do endereço addressNeighborhood: type: string maxLength: 75 description: Bairro do endereço addressCity: type: string maxLength: 60 description: Cidade do endereço addressState: type: string maxLength: 2 description: Estado do endereço recPixTitleAdditionalInformation: description: Record responsável pelas informações adicionais do PIX do título type: object required: – id – key – value properties: id: type: string description: Identificador do registro da entidade key: type: string description: Chave value: type: string description: Valor recPixTitleError: description: Record responsável pelos erros de integração do PIX do título type: object required: – id – field – message properties: id: type: string description: Identificador do registro da entidade field: type: string description: Campo message: type: string description: Mensagem 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 recFilterSugestionAccountsReceivable: description: Filtro com os parâmetros para a sugestão do título type: object required: – titleQuantity – companyIdentifier – branchIdentifier – emissionDate – entryDate – transactionId – value – firstExpiration – titleTypeId properties: titleQuantity: type: integer format: int64 description: Quantidade de títulos a serem sugeridos companyIdentifier: type: object allOf: – #/definitions/companyIdentifier description: Identificador da empresa branchIdentifier: type: object allOf: – #/definitions/branchIdentifier description: Identificador da filial emissionDate: type: string format: date description: Data de emissão do futuro título entryDate: type: string format: date description: Data de entrada do futuro título customerId: type: object allOf: – #/definitions/genericIdCode description: Identificador da pessoa transactionId: type: object allOf: – #/definitions/genericIdCode description: Identificador da transação paymentMethodId: type: object allOf: – #/definitions/genericIdCode description: Identificador da forma de pagamento financialAccountId: type: object allOf: – #/definitions/genericIdCode description: Identificador da conta financeira costCenterId: type: object allOf: – #/definitions/genericIdCode description: Identificador do centro custo value: type: string description: Valor a serem gerados os futuros títulos minimum: 0.00 maximum: 9999999999999.99 firstExpiration: type: string format: date description: Data do primeiro vencimento do primeiro título conditionPayment: type: object allOf: – #/definitions/genericIdCode description: Identificador da condição de pagamento observation: type: string description: Observação titlePrefix: type: string maxLength: 15 description: Número sugestivo do futuro título titleTypeId: type: object allOf: – #/definitions/genericIdCode description: Identificador do tipo de título titleCurrency: type: object allOf: – #/definitions/genericIdCode description: Identificador da moeda do título valueType: type: string allOf: – #/definitions/enumValueType description: Indica se o valor será igual ou dividido entre as parcelas accountingBaseDate: type: string allOf: – #/definitions/enumAccountingBaseDate description: Data base contábil quotation: type: string description: Cotação a ser utilizada na geração do título recSugestionAccountsReceivable: description: Duplicatas a receber sugeridas allOf: – #/definitions/recFinancialTitle – type: object required: – additionalInformation properties: discounts: type: object allOf: – #/definitions/recDiscounts description: Dados para descontos do título a pagar additionalInformation: type: object allOf: – #/definitions/recAdditionalInformationTitleReceiveble description: Informações adicionais do título a receber recFinancialTitle: description: Dados do título financeiro (pagar/receber) discriminator: _discriminator type: object required: – companyIdentifier – branchIdentifier – personIdentifier – titleNumber – titleTypeIdentifier – transaction – emissionDate – entryDate – originalDueDate – probablePayment – originalValue – currency – _discriminator properties: id: type: string description: Identificador do título companyIdentifier: type: object allOf: – #/definitions/companyIdentifier description: Identificador da empresa branchIdentifier: type: object allOf: – #/definitions/branchIdentifier description: Identificador da filial personIdentifier: type: object allOf: – #/definitions/personIdentifier description: Identificador do fornecedor/cliente titleNumber: type: string maxLength: 15 description: Nº Título titleTypeIdentifier: type: object allOf: – #/definitions/titleTypeIdentifier description: Identificador do tipo de título transaction: type: object allOf: – #/definitions/genericIdCode description: Identificador da transação de entrada do título emissionDate: type: string format: date description: Data Emissão entryDate: type: string format: date description: Data Entrada originalDueDate: type: string format: date description: Vencimento Original extendedDueDate: type: string format: date description: Vencimento Prorrogado/Juros probablePayment: type: string format: date description: Data Provável Pagamento titleSituation: type: string allOf: – #/definitions/enumTitleSituation description: Situação do título originalValue: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 openValue: type: string description: Valor aberto minimum: 0.00 maximum: 9999999999999.99 currency: type: object allOf: – #/definitions/genericIdCode description: Moeda do título apportionment: type: object allOf: – #/definitions/recApportionment description: Rateio interest: type: object allOf: – #/definitions/recInterest description: Dados para juros fine: type: object allOf: – #/definitions/recFine description: Dados para multa negotiatedValues: type: object allOf: – #/definitions/recNegotiatedValues description: Dados negociados credit: type: boolean description: Título é de crédito _discriminator: type: string description: recDiscounts: description: Indicativo das informações de desconto do título type: object properties: advancement: type: boolean description: Calcula Desc. Antecipação limitDate: type: string format: date description: Data/Tolerância Desconto tolerance: type: integer format: int64 description: Tolerância Desconto minimum: -9999 maximum: 9999 value: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 percentage: type: number format: double description: Percentual Desconto minimum: 0.00 maximum: 999.99 recAdditionalInformationTitleReceiveble: description: Indicativo das informações adicionados do título receber allOf: – #/definitions/recAdditionalInformationTitle – type: object properties: draweeCode: type: object allOf: – #/definitions/genericIdCode description: Identificador do sacado recAdditionalInformationTitle: description: Indicativo das informações adicionados do título discriminator: _discriminator type: object required: – _discriminator properties: observation: type: string maxLength: 250 description: Observação paymentMethod: type: object allOf: – #/definitions/genericIdCode description: Forma Pagamento bearer: type: object allOf: – #/definitions/genericIdCode description: Portador wallet: type: object allOf: – #/definitions/genericIdCode description: Carteira barCode: type: string maxLength: 50 description: Código Barra _discriminator: type: string description: personIdentifier: description: Dados de identificação da pessoa type: object properties: id: type: string description: Identificador único da pessoa code: type: integer format: int64 description: Codigo da pessoa minimum: 0 maximum: 9999 documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF nifNumber: type: string maxLength: 40 description: Número de identificação fiscal titleTypeIdentifier: description: Dados de identificação do tipo de título type: object properties: id: type: string description: Identificador únido do típo de título code: type: string maxLength: 3 description: Código do típo de título recApportionment: description: Indicativo das informações para geração de rateio type: object properties: financialAccount: type: object allOf: – #/definitions/recGeneric description: Indicativo da conta financeira costCenter: type: object allOf: – #/definitions/recGeneric description: Indicativo do centro de custos recInterest: description: Indicativo das informações dos juros do título type: object properties: dailyInterestAmount: type: string description: Valor Juros Dia minimum: 0.00 maximum: 9999999.99 interestPercentage: type: number format: double description: Percentual/Tipo Juros minimum: 0.00 maximum: 999.99 interestType: type: string allOf: – #/definitions/interestType description: Tipo de Juros interestToleranceDays: type: integer format: int64 description: Dias Tolerância Juros minimum: 0 maximum: 9999 extensionWithInterests: type: boolean description: Prorrogação c/ Juros recFine: description: Indicativo das informações da multa do título type: object properties: finePercentage: type: number format: double description: Percentual/Tolerância Multa minimum: 0.00 maximum: 999.99 fineToleranceDays: type: integer format: int64 description: Dias Tolerância Multa minimum: 0 maximum: 9999 recNegotiatedValues: description: Indicativo das informações negociadas do título type: object properties: negotiatedValueDate: type: string format: date description: Data Valores Negociados negotiatedInterestValue: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 negotiatedFineValue: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 negotiatedDiscountValue: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 othersNegotiated: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 negotiatedCurrencyQuotation: type: string description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 negotiatedQuotationValue: type: string description: Valor da cotação da moeda do reajuste na data do titulo minimum: 0.00 maximum: 999999999.9999999999 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. 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 getReceivableTitleFacadeInput: description: Utilizada para buscar informações detalhadas de um título a receber. type: object properties: id: type: string description: Identificador do título titleNumber: type: string maxLength: 15 description: Número do título company: type: object allOf: – #/definitions/companyIdentifier description: Identificador da empresa branch: type: object allOf: – #/definitions/branchIdentifier description: Identificador da filial person: type: object allOf: – #/definitions/personIdentifier description: Identificador da pessoa titleType: type: object allOf: – #/definitions/titleTypeIdentifier description: Identificador do tipo do título getReceivableTitleFacadeOutput: description: Utilizada para buscar informações detalhadas de um título a receber. type: object required: – title properties: type: object allOf: – #/definitions/recEditionReceivable description: Título personAccountsReceivableFacadeInput: description: Responsável pela criação, atualização e exclusão da entidade de especialização do contas a receber. type: object required: – person – company – branch properties: id: type: string description: Identificador único person: type: object allOf: – #/definitions/personIdentifier description: Identificador da pessoa creditLimit: type: string description: Limite de crédito minimum: 0.00 maximum: 9999999999999.99 default: 0.00 approvedCreditLimit: type: boolean description: Limite de crédito aprovado default: false categoryForCreditAnalysis: type: string description: Identificador de categoria para análise de crédito wallet: type: object allOf: – #/definitions/genericIdCode description: Carteira firstAcceptedCarrier: type: object allOf: – #/definitions/genericIdCode description: Primeiro portador aceito secondAcceptedCarrier: type: object allOf: – #/definitions/genericIdCode description: Segundo portador aceito firstNotAcceptedCarrier: type: object allOf: – #/definitions/genericIdCode description: Primeiro portador não aceito secondNotAcceptedCarrier: type: object allOf: – #/definitions/genericIdCode description: Segundo portador não aceito firstBankingInstruction: type: object allOf: – #/definitions/genericIdCode description: Primeira instrução bancária secondBankingInstruction: type: object allOf: – #/definitions/genericIdCode description: Segunda instrução bancária accountGroup: type: object allOf: – #/definitions/genericIdCode description: Grupo de contas readjustingFormula: type: string description: Fórmula de reajuste do título a receber interestType: type: string allOf: – #/definitions/interestType description: Tipo de Juros defaultInterestPercentage: type: number format: double description: Percentual de juros de mora minimum: 0.00 maximum: 100.0 defaultInterestGraceDays: type: integer format: int64 description: Dias de tolerância para cálculo de juros de mora minimum: 0 maximum: 99 finesToleranceDays: type: integer format: int64 description: Dias de tolerância para multa minimum: 0 maximum: 99 calculateEarlyReceiptDiscount: type: boolean description: Calcular desconto por antecipação de recebimento default: false periodForCalculatingAdvanceDiscount: type: string allOf: – #/definitions/earlyPaymentDiscountPeriod description: Período para cálculo do desconto antecipado discountToleranceDays: type: integer format: int64 description: Dias de tolerância para desconto minimum: 0 default: 0 defaultDiscountPercentageForGeneratedTitles: type: number format: double description: Percentual padrão de desconto para os títulos gerados minimum: 0 maximum: 100.0 default: 0.00 defaultAdvancedDiscountPercentageForGeneratedTitles: type: number format: double description: Percentual de desconto por antecipação para os títulos gerados minimum: 0.00 maximum: 100.0 default: 0.00 defaultPunctualityDiscountPercentageForGeneratedTitles: type: number format: double description: Percentual de desconto por pontualidade para os títulos gerados minimum: 0.00 maximum: 100.0 default: 0.00 percentageDelayFine: type: number format: double description: Percentual de multa para atraso minimum: 0.00 maximum: 100.0 numberOfDaysProtest: type: integer format: int64 description: Quantidade de dias para protesto minimum: 0 default: 0 invoiceEmail: type: string description: E-mail para envio de boletos company: type: object allOf: – #/definitions/companyIdentifier description: Identificador da empresa branch: type: object allOf: – #/definitions/branchIdentifier description: Identificador da filial personAccountsReceivableFacadeOutput: description: Responsável pela criação, atualização e exclusão da entidade de especialização do contas a receber. type: object required: – ticket properties: ticket: type: string description: Ticket processo assincrono 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