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: api.senior.com.br /erpx_fin_int/facadesecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /personAccountsReceivableCreatedSuccess: post: description: x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /personAccountsReceivableUpdatedSuccess: post: description: x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /personAccountsReceivableCreateError: post: description: x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /personAccountsReceivableUpdateError: post: description: x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 /apis/personAccountsReceivable: post: description: The create request primitive for the personAccountsReceivable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/personAccountsReceivableFacadeInput responses: 200: description: Ok schema: #/definitions/personAccountsReceivableFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/personAccountsReceivable/{id}: put: description: The update request primitive for the personAccountsReceivable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/personAccountsReceivableFacadeInput responses: 200: description: Ok schema: #/definitions/personAccountsReceivableFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the personAccountsReceivable facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/getReceivableTitle: post: description: The create request primitive for the getReceivableTitle facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/getReceivableTitleFacadeInput responses: 200: description: Ok schema: #/definitions/getReceivableTitleFacadeOutput default: description: Error response schema: #/definitions/genericErrordefinitions: 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 enumEmailStatus: type: string enum: – NOT_SENT – PROCESSING – SENT – ERROR enumBankingSituation: type: string enum: – NOT_SENT – SENT_GENERATION – RETURNED_GENERATION – RETURNED_PAID – CANCELED – ERROR – CANCELING interestType: type: string enum: – SIMPLE_INTEREST – COMPOUND_INTEREST earlyPaymentDiscountPeriod: type: string enum: – DAILY – WEEKLY – BIWEEKLY – MONTHLY – QUARTELY – SEMIANNUAL – ANNUAL getReceivableTitleFacadeInput: type: object properties: id: type: string description: Identificador do título titleNumber: type: string description: Número do título company: #/definitions/companyIdentifier branch: #/definitions/branchIdentifier person: #/definitions/personIdentifier titleType: #/definitions/titleTypeIdentifier companyIdentifier: type: object properties: id: type: string description: Identificador único da empresa code: type: integer description: Código da empresa branchIdentifier: type: object properties: id: type: string description: Identificador único da filial code: type: integer description: Codigo da filial documentNumber: type: string description: Número do CNPJ ou CPF nifNumber: type: string description: Número de identificação fiscal personIdentifier: type: object properties: id: type: string description: Identificador único da pessoa code: type: integer description: Codigo da pessoa documentNumber: type: string description: Número do CNPJ ou CPF nifNumber: type: string description: Número de identificação fiscal titleTypeIdentifier: type: object properties: id: type: string description: Identificador únido do típo de título code: type: string description: Código do típo de título getReceivableTitleFacadeOutput: type: object required: – title properties: #/definitions/recEditionReceivable recEditionReceivable: type: object required: – id – branch – titleType – customer – currency – titleNumber – titleSituation – predictedTitle – effectiveAdvanceTitle – originalDueDate – extendedDueDate – emissionDate – entryDate – probablePaymentDate – values – observation – extensionWithInterests properties: id: type: string description: Identificador do título company: #/definitions/recCompany branch: #/definitions/recBranch branchReceivable: #/definitions/recBranchReceivable titleType: #/definitions/recGeneric customer: #/definitions/recGeneric paymentMethod: #/definitions/recPaymentMethod currency: #/definitions/recGeneric bearer: #/definitions/recGeneric titleNumber: type: string description: Número do título titleSituation: #/definitions/enumTitleSituation predictedTitle: type: boolean description: Indicativo se o título é previsto effectiveAdvanceTitle: type: boolean description: Indicativo se o título é adiantamento efetivo originalDueDate: type: string description: Vencimento original format: date extendedDueDate: type: string description: Vencimento prorrogado format: date emissionDate: type: string description: Data de emissão format: date entryDate: type: string description: Data de entrada format: date probablePaymentDate: type: string description: Data de provável pagamento format: date lastPaymentDate: type: string description: Data do último pagamento format: date interestDays: type: integer description: Dias juros delayDays: type: integer description: Dias atraso shippingNumber: type: integer description: Número da remessa values: #/definitions/recTitleValues emailStatus: #/definitions/enumEmailStatus emailError: type: string description: Mensagem de erro do envio de email internalAccountSuggestion: #/definitions/recGeneric validSuggestedInternalAccount: type: boolean description: Indicativo se a conta interna sugerida é valida financialBatch: type: string description: Lote financeiro pixInformation: #/definitions/recPixInformation transaction: #/definitions/recGeneric billingPortfolio: #/definitions/recGeneric group: #/definitions/recGeneric 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 description: Data Juros Mora Calculado format: date currentAccountDigit: type: string description: Dígito da Conta Corrente barCode: type: string description: Código Barra negotiatedValueDate: type: string description: Data Valores Negociados format: date 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 discountCalculationPeriod: type: string description: Período para cálculo do desconto discountDate: type: string description: Data/Tolerância Desconto format: date discountPercentage: type: number description: Percentual/Valor Desconto format: double finePercentage: type: number description: Percentual/Tolerância Multa format: double fineToleranceDays: type: integer description: Dias Tolerância Multa discountToleranceDays: type: integer description: Dias Tolerância Desconto dailyDefaultInterestValue: type: string description: Valor Juros Mora Dia interestPercentage: type: number description: Percentual/Tipo Juros format: double interestType: #/definitions/interestType interestToleranceDays: type: integer 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: #/definitions/recOrigin recCompany: type: object required: – id – code – name – currency properties: id: type: string description: Identificador da empresa code: type: integer description: Código da empresa name: type: string description: Nome da empresa currency: type: string description: Moeda da empresa recBranch: type: object required: – id – code – name – companyId – companyCode properties: id: type: string description: Identificador da filial code: type: integer description: Código da filial name: type: string description: Nome da filial companyId: type: string description: Identificador da empresa companyCode: type: integer description: Código da empresa recBranchReceivable: type: object required: – branchId – bearerId properties: branchId: type: string description: Identificador da filial bearerId: type: string description: Identificador do portador recGeneric: 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 recPaymentMethod: type: object required: – id properties: id: type: string description: Identificador da entidade code: type: string description: Código da Entidade description: type: string description: Descrição/nome do registro da entidade label: type: string description: Label legível para o front type: type: string description: Tipo pagamento recTitleValues: type: object required: – originalValue – openValue properties: originalValue: type: string description: Valor original openValue: type: string description: Valor aberto do título 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: type: object properties: id: type: string description: Identificador da entidade expirationDaysAfterDueDate: type: integer description: Data expiração em dias pós vencimento payerRequest: type: string description: Solicitação do pagador additionalInformation: type: array items: #/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: #/definitions/recPixTitleError description: Erros da integração amountPaid: type: string description: Valor recebido paymentDateTime: type: string description: Data/Hora do recebimento format: date-time payerInformation: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento situation: #/definitions/enumBankingSituation recPixTitleAdditionalInformation: 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: 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 recOrigin: type: object properties: invoiceNumber: type: integer description: Número nota fiscal serialCode: type: string description: Código série serialDescription: type: string description: Descrição série personAccountsReceivableFacadeInput: type: object required: – person – company – branch properties: id: type: string description: Identificador único person: #/definitions/personIdentifier creditLimit: type: string description: Limite de crédito approvedCreditLimit: type: boolean description: Limite de crédito aprovado categoryForCreditAnalysis: type: string description: Identificador de categoria para análise de crédito wallet: #/definitions/genericIdCode firstAcceptedCarrier: #/definitions/genericIdCode secondAcceptedCarrier: #/definitions/genericIdCode firstNotAcceptedCarrier: #/definitions/genericIdCode secondNotAcceptedCarrier: #/definitions/genericIdCode firstBankingInstruction: #/definitions/genericIdCode secondBankingInstruction: #/definitions/genericIdCode accountGroup: #/definitions/genericIdCode readjustingFormula: type: string description: Fórmula de reajuste do título a receber interestType: #/definitions/interestType defaultInterestPercentage: type: number description: Percentual de juros de mora format: double defaultInterestGraceDays: type: integer description: Dias de tolerância para cálculo de juros de mora finesToleranceDays: type: integer description: Dias de tolerância para multa calculateEarlyReceiptDiscount: type: boolean description: Calcular desconto por antecipação de recebimento periodForCalculatingAdvanceDiscount: #/definitions/earlyPaymentDiscountPeriod discountToleranceDays: type: integer description: Dias de tolerância para desconto defaultDiscountPercentageForGeneratedTitles: type: number description: Percentual padrão de desconto para os títulos gerados format: double defaultAdvancedDiscountPercentageForGeneratedTitles: type: number description: Percentual de desconto por antecipação para os títulos gerados format: double defaultPunctualityDiscountPercentageForGeneratedTitles: type: number description: Percentual de desconto por pontualidade para os títulos gerados format: double percentageDelayFine: type: number description: Percentual de multa para atraso format: double numberOfDaysProtest: type: integer description: Quantidade de dias para protesto invoiceEmail: type: string description: E-mail para envio de boletos company: #/definitions/companyIdentifier branch: #/definitions/branchIdentifier genericIdCode: type: object properties: id: type: string description: Identificador da entidade code: type: string description: Código de negócio personAccountsReceivableFacadeOutput: 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE