# Create Invoice Request Webhook ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v0/invoice/req-send-invoice: post: summary: Create Invoice Request Webhook deprecated: false description: '' tags: - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Webhook/Invoice parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInvoiceRequest' examples: {} responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ApplicationResponseCreateInvoiceResponse' headers: {} x-apidog-name: Success security: [] x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Webhook/Invoice x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-18788115-run components: schemas: CreateInvoiceRequest: required: - b2bIds - invoice type: object properties: device: $ref: '#/components/schemas/Device' b2bIds: $ref: '#/components/schemas/NbblB2BIdsModel' invoice: &ref_0 $ref: '#/components/schemas/Invoice' x-apidog-orders: - device - b2bIds - invoice x-apidog-ignore-properties: [] x-apidog-folder: '' Invoice: type: object properties: id: type: integer format: int64 parentInvoiceId: type: integer format: int64 invoiceNumber: type: string vendorInvoiceRefNo: type: string externalRefNumber: type: string purchaseNo: type: string supplierInvoiceNo: type: string supplierInvoiceDate: type: string format: date sourceCompany: type: integer format: int64 targetCompany: type: integer format: int64 totalAmount: type: number invoiceAmount: type: number amountPaidTillNow: type: number surcharge: type: number surchargeGst: type: number mdr: type: number mdrGst: type: number sgst: type: number cgst: type: number igst: type: number tds: type: number amountPaidByEnterprise: type: number amountToBePaidToVendor: type: number description: type: string createdBy: type: integer format: int64 createdDate: type: string format: date-time dueDate: type: string format: date-time lastModifiedDate: type: string format: date-time lastModifiedBy: type: integer format: int64 makerId: type: integer format: int64 checkerId: type: integer format: int64 approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED paymentStatus: type: string enum: - INIT - PROCESS - SUCCESS - FAILED - PENDING - CANCELLED - EXPIRED - PARTIAL_REFUNDED - REFUNDED - IN_PROCESS - AUTHENTICATION_IN_PROCESS - OTP_RENDERED - CHECKOUT_RENDERED - MPI_PROCESSED - MPI_RENDERED - REFUND_IN_PROGRESS - REFUND_REQUESTED - PENDING_WITH_BANK - SWAPPED - PAID_OFFLINE - PARTIAL_PAID invoiceStatus: type: string enum: - PAID - UNPAID - PARTIAL_PAID - REFUNDED autoRelease: type: boolean invoiceDate: type: string format: date pgId: type: integer format: int64 phone: type: string email: type: string paymentGatewayTransactions: uniqueItems: true type: array items: &ref_2 $ref: '#/components/schemas/PaymentGatewayTransaction' deleted: type: boolean dateApproved: type: string format: date-time maskedCardNumber: type: string subscription: type: integer format: int64 retryLeft: type: integer format: int32 paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER payoutData: &ref_3 $ref: '#/components/schemas/PayoutData' productCode: type: string enum: - INV001 - INV002 - INV003 - INV004 - INV005 purchaseOrder: $ref: '#/components/schemas/PurchaseOrder' hsnCode: type: string approverApprovedCount: type: integer format: int32 attachment: type: boolean companyBranchCodeId: type: integer format: int64 bankApprovals: type: string bankCard: &ref_4 $ref: '#/components/schemas/BankCard' approvalAuthorizations: uniqueItems: true type: array items: &ref_5 $ref: '#/components/schemas/ApprovalAuthorization' nextApprovalGroups: uniqueItems: true type: array items: &ref_6 $ref: '#/components/schemas/ApprovalGroup' earlyPaymentDetails: uniqueItems: true type: array items: $ref: '#/components/schemas/EarlyPaymentDetail' previousUserApprovals: uniqueItems: true type: array items: &ref_7 $ref: '#/components/schemas/ApprovalGroupUser' refundDate: type: string format: date-time refundBy: type: integer format: int64 via: type: string collectionReferenceId: type: string collectionInvoiceId: type: string paidThrough: type: string enum: - COLLECTIONS - PAYABLES collectionSyncRequired: type: boolean invoiceDiscounting: type: boolean remarks: type: string earlyPaymentEnabled: type: boolean earlyPaymentMarkup: maximum: 100 minimum: 0 type: number earlyPaymentBaseRate: maximum: 100 minimum: 0 type: number earlyPaymentBaseRateSlab: type: string earlyPaymentStatus: type: string enum: - PENDING - APPROVED - REJECTED - EXPIRED refundTransactions: uniqueItems: true type: array items: &ref_8 $ref: '#/components/schemas/RefundTransaction' additionalDataMapping: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] invoiceAttachments: uniqueItems: true type: array items: $ref: '#/components/schemas/InvoiceAttachment' reverseSync: type: boolean nbblEnabled: type: boolean nbblInvoiceId: type: string billStartDate: type: string format: date billEndDate: type: string format: date penalty: type: number nbblInvoiceStatus: type: string enum: - CREATED - SENT_TO_BUYER - ACCEPTED - REJECTED - UNDER_REVIEW - CANCELLED - DELETED - PARTIALLY_PAID - FULLY_PAID - CLOSED - ABANDONED - PAYMENT_INITIATED - PARTIALLY_PAID_AND_PAYMENT_INITIATED nbblInvoiceData: type: object additionalProperties: type: object x-apidog-orders: [] x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nbblInvoiceItems: uniqueItems: true type: array items: $ref: '#/components/schemas/NbblInvoiceItem' nbblPayments: uniqueItems: true type: array items: $ref: '#/components/schemas/NbblPayment' nbblInvoiceFinances: uniqueItems: true type: array items: &ref_1 $ref: '#/components/schemas/NbblInvoiceFinance' paymentAdviceUrl: type: string ponumber: type: string einvoice: type: boolean x-apidog-orders: - id - parentInvoiceId - invoiceNumber - vendorInvoiceRefNo - externalRefNumber - purchaseNo - supplierInvoiceNo - supplierInvoiceDate - sourceCompany - targetCompany - totalAmount - invoiceAmount - amountPaidTillNow - surcharge - surchargeGst - mdr - mdrGst - sgst - cgst - igst - tds - amountPaidByEnterprise - amountToBePaidToVendor - description - createdBy - createdDate - dueDate - lastModifiedDate - lastModifiedBy - makerId - checkerId - approvalStatus - paymentStatus - invoiceStatus - autoRelease - invoiceDate - pgId - phone - email - paymentGatewayTransactions - deleted - dateApproved - maskedCardNumber - subscription - retryLeft - paymentMode - payoutData - productCode - purchaseOrder - hsnCode - approverApprovedCount - attachment - companyBranchCodeId - bankApprovals - bankCard - approvalAuthorizations - nextApprovalGroups - earlyPaymentDetails - previousUserApprovals - refundDate - refundBy - via - collectionReferenceId - collectionInvoiceId - paidThrough - collectionSyncRequired - invoiceDiscounting - remarks - earlyPaymentEnabled - earlyPaymentMarkup - earlyPaymentBaseRate - earlyPaymentBaseRateSlab - earlyPaymentStatus - refundTransactions - additionalDataMapping - invoiceAttachments - reverseSync - nbblEnabled - nbblInvoiceId - billStartDate - billEndDate - penalty - nbblInvoiceStatus - nbblInvoiceData - nbblInvoiceItems - nbblPayments - nbblInvoiceFinances - paymentAdviceUrl - ponumber - einvoice x-apidog-ignore-properties: [] x-apidog-folder: '' NbblInvoiceFinance: type: object properties: id: type: integer format: int64 financingRequestId: type: string faId: type: string financierId: type: string invoice: *ref_0 nbblRequestStatus: type: string enum: - REQUEST_FAILED - PENDING - COMPLETED nbblFinanceStatus: type: string enum: - FINANCE_REQUEST_AVAILABLE - FINANCE_REQUESTED - BIDS_RECEIVED - FINANCED financeRequestAmount: type: number initiatorB2bId: type: string financeRequestData: type: object additionalProperties: type: object x-apidog-orders: [] x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] deleted: type: boolean nbblInvoiceFinanceBids: uniqueItems: true type: array items: $ref: '#/components/schemas/NbblInvoiceFinanceBid' x-apidog-orders: - id - financingRequestId - faId - financierId - invoice - nbblRequestStatus - nbblFinanceStatus - financeRequestAmount - initiatorB2bId - financeRequestData - deleted - nbblInvoiceFinanceBids x-apidog-ignore-properties: [] x-apidog-folder: '' NbblInvoiceFinanceBid: type: object properties: id: type: integer format: int64 nbblInvoiceFinance: *ref_1 bidId: type: string financierId: type: string bidValue: type: number approvedAmount: type: number bidResponse: type: string enum: - ACCEPT - REJECT - RETURN financeTermDoc: type: string x-apidog-orders: - id - nbblInvoiceFinance - bidId - financierId - bidValue - approvedAmount - bidResponse - financeTermDoc x-apidog-ignore-properties: [] x-apidog-folder: '' NbblPayment: type: object properties: id: type: integer format: int64 paymentId: type: string pgTransactionId: type: string paymentType: type: string enum: - OFFPLATFORM - ONPLATFORM paymentMode: type: string enum: - INTERNET_BANKING - DEBIT_CARD - CREDIT_CARD - IMPS - CASH - UPI - WALLET - NEFT - PREPAID_CARD - ACCOUNT_TRANSFER - CHEQUE utr: type: string totalAmount: type: number paymentDate: type: string format: date-time supplierResponse: type: string enum: - ACCEPT - REJECT - RETURN chequeNumber: type: string bankName: type: string bankRefNumber: type: string remark: type: string paymentData: type: object additionalProperties: type: object x-apidog-orders: [] x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] invoices: uniqueItems: true type: array items: *ref_0 createdOn: type: string format: date-time modifiedOn: type: string format: date-time requestCompleted: type: boolean x-apidog-orders: - id - paymentId - pgTransactionId - paymentType - paymentMode - utr - totalAmount - paymentDate - supplierResponse - chequeNumber - bankName - bankRefNumber - remark - paymentData - invoices - createdOn - modifiedOn - requestCompleted x-apidog-ignore-properties: [] x-apidog-folder: '' NbblInvoiceItem: type: object properties: id: type: integer format: int64 invoice: *ref_0 serialno: type: string productDescription: type: string isService: type: string enum: - 'YES' - 'NO' hsnCode: type: string barCode: type: string quantity: type: number unitPrice: type: number totalAmt: type: number assessmentAmount: type: number totalItemValue: type: number deleted: type: boolean x-apidog-orders: - id - invoice - serialno - productDescription - isService - hsnCode - barCode - quantity - unitPrice - totalAmt - assessmentAmount - totalItemValue - deleted x-apidog-ignore-properties: [] x-apidog-folder: '' InvoiceAttachment: type: object properties: id: type: integer format: int64 invoiceAttachmentId: type: string invoice: *ref_0 referenceId: type: string originalFilename: type: string fileExt: type: string url: type: string shared: type: boolean attachmentSource: type: string enum: - UI_INVOICE - TALLY_INVOICE remarks: type: string deleted: type: boolean createdBy: type: string modifiedBy: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time primary: type: boolean x-apidog-orders: - id - invoiceAttachmentId - invoice - referenceId - originalFilename - fileExt - url - shared - attachmentSource - remarks - deleted - createdBy - modifiedBy - createdOn - modifiedOn - primary x-apidog-ignore-properties: [] x-apidog-folder: '' RefundTransaction: type: object properties: id: type: integer format: int64 refundTransactionId: type: string invoice: *ref_0 gstPayment: &ref_21 $ref: '#/components/schemas/GstPayment' utilityPayment: &ref_22 $ref: '#/components/schemas/UtilityPayment' amount: type: number refundApprovalStatus: type: string enum: - PENDING - REJECTED - APPROVED refundStatus: type: string enum: - PENDING - IN_PROGRESS - SUCCESS - FAILED - ON_HOLD actionedOn: type: string format: date-time makerRemark: type: string checkerRemark: type: string deleted: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time createdBy: type: string modifiedBy: type: string attachments: type: array items: type: string corporateName: type: string paymentType: type: string enum: - INVOICE - GST - UTILITY - RENTAL - CONSENT_TRANSACTION - COLLECTION_INVOICE - ADVANCE_PAYMENT enkashId: type: string refundRecovery: type: boolean recoveredAmount: type: number x-apidog-orders: - id - refundTransactionId - invoice - gstPayment - utilityPayment - amount - refundApprovalStatus - refundStatus - actionedOn - makerRemark - checkerRemark - deleted - createdOn - modifiedOn - createdBy - modifiedBy - attachments - corporateName - paymentType - enkashId - refundRecovery - recoveredAmount x-apidog-ignore-properties: [] x-apidog-folder: '' UtilityPayment: type: object properties: id: type: integer format: int64 utilityEnkashId: type: string companyBiller: &ref_9 $ref: '#/components/schemas/CompanyBiller' billNumber: type: string billerBillNumber: type: string numberOfUnits: type: number amount: type: number surcharge: type: number surchargeGst: type: number mdr: type: number mdrGst: type: number amountPaidByEnterprise: type: number amountToBePaidToBiller: type: number billDate: type: string format: date dueDate: type: string format: date billStartDate: type: string format: date billEndDate: type: string format: date remarks: type: string createdBy: type: integer format: int64 dateApproved: type: string format: date-time createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time lastModifiedBy: type: integer format: int64 approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED approverApprovedCount: type: integer format: int32 paymentStatus: type: string enum: - INIT - PROCESS - SUCCESS - FAILED - PENDING - CANCELLED - EXPIRED - PARTIAL_REFUNDED - REFUNDED - IN_PROCESS - AUTHENTICATION_IN_PROCESS - OTP_RENDERED - CHECKOUT_RENDERED - MPI_PROCESSED - MPI_RENDERED - REFUND_IN_PROGRESS - REFUND_REQUESTED - PENDING_WITH_BANK - SWAPPED - PAID_OFFLINE - PARTIAL_PAID refundDate: type: string format: date-time refundBy: type: integer format: int64 pgId: type: integer format: int64 paymentGatewayTransactions: uniqueItems: true type: array items: *ref_2 deleted: type: boolean paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER payoutData: *ref_3 billpayData: $ref: '#/components/schemas/BillpayData' bankCard: *ref_4 maskedCardNumber: type: string attachment: type: boolean branchCode: type: string branchName: type: string branchCity: type: string branchState: type: string costCentre: type: string branchRemarks: type: string gstBranchStateCode: type: string billExpiryReason: type: string latePaymentFee: type: number penalty: type: number earlyDiscount: type: number earlyPaymentAmount: type: number billAmount: type: number latePaymentAmount: type: number earlyPaymentDate: type: string format: date actualDueDate: type: string format: date version: type: integer format: int32 approvalAuthorizations: uniqueItems: true type: array items: *ref_5 nextApprovalGroups: uniqueItems: true type: array items: *ref_6 previousUserApprovals: uniqueItems: true type: array items: *ref_7 validationId: type: string billId: type: string axisBbpsRefId: type: string billValidateDate: type: string format: date-time internalRemarks: type: array items: $ref: '#/components/schemas/UtilityPaymentInternalRemarks' refundTransactions: uniqueItems: true type: array items: *ref_8 referenceId: type: string billCopyStatus: type: string enum: - FAILED - PENDING - SUCCESS billCopyPdfUrl: type: string utilityBillMetaDataId: type: integer format: int64 x-apidog-orders: - id - utilityEnkashId - companyBiller - billNumber - billerBillNumber - numberOfUnits - amount - surcharge - surchargeGst - mdr - mdrGst - amountPaidByEnterprise - amountToBePaidToBiller - billDate - dueDate - billStartDate - billEndDate - remarks - createdBy - dateApproved - createdDate - lastModifiedDate - lastModifiedBy - approvalStatus - approverApprovedCount - paymentStatus - refundDate - refundBy - pgId - paymentGatewayTransactions - deleted - paymentMode - payoutData - billpayData - bankCard - maskedCardNumber - attachment - branchCode - branchName - branchCity - branchState - costCentre - branchRemarks - gstBranchStateCode - billExpiryReason - latePaymentFee - penalty - earlyDiscount - earlyPaymentAmount - billAmount - latePaymentAmount - earlyPaymentDate - actualDueDate - version - approvalAuthorizations - nextApprovalGroups - previousUserApprovals - validationId - billId - axisBbpsRefId - billValidateDate - internalRemarks - refundTransactions - referenceId - billCopyStatus - billCopyPdfUrl - utilityBillMetaDataId x-apidog-ignore-properties: [] x-apidog-folder: '' UtilityPaymentInternalRemarks: type: object properties: amount: type: number timestamp: type: string format: date-time remarks: type: string x-apidog-orders: - amount - timestamp - remarks x-apidog-ignore-properties: [] x-apidog-folder: '' BillpayData: type: object properties: id: type: integer format: int64 status: type: string enum: - SUCCESS - FAILED - PENDING - IN_PROGRESS - ON_HOLD - REINITIATE - AGENCY_FAILED billpayDate: type: string format: date-time amount: type: number utilityPaymentId: type: integer format: int64 requestId: type: string txnReferenceId: type: string externalTransactionId: type: string balance: type: number failureReason: type: string billpayResponse: type: string txnStatusResponse: type: string initiatedOn: type: string format: date-time reinitiatedBy: type: integer format: int64 reinitiatedOn: type: string format: date-time remark: type: string serviceProvider: type: string enum: - MK - BA - SS - BE - WH - ME - TW - FP - CS - AX - T1 - T2 - T3 - IN assignedServiceProvider: type: string enum: - MK - BA - SS - BE - WH - ME - TW - FP - CS - AX - T1 - T2 - T3 - IN version: type: integer format: int32 createdOn: type: string format: date-time modifiedOn: type: string format: date-time billPayAttemptCount: type: integer format: int32 x-apidog-orders: - id - status - billpayDate - amount - utilityPaymentId - requestId - txnReferenceId - externalTransactionId - balance - failureReason - billpayResponse - txnStatusResponse - initiatedOn - reinitiatedBy - reinitiatedOn - remark - serviceProvider - assignedServiceProvider - version - createdOn - modifiedOn - billPayAttemptCount x-apidog-ignore-properties: [] x-apidog-folder: '' CompanyBiller: type: object properties: id: type: integer format: int64 companyBillerId: type: string companyId: type: integer format: int64 billerId: type: integer format: int32 consumerNumber: type: string consumerName: type: string circle: type: string enum: - AP - ASM - BIH - CHE - DEL - GUJ - HAR - HP - JK - KK - KER - KOL - MAH - MP - MUM - NE - ORI - PUN - RAJ - TN - UPE - UPW - WB - ALL - AGRA - AHM - BHIWANDI - SURAT - SHILMUMBRAKALWA billInputParams: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] lastDueDate: type: string format: date lastBillCreatedOn: type: string format: date-time deleted: type: boolean active: type: boolean companyBillerValidationStatus: type: string enum: - PENDING - FAILED - SUCCESS validatedOn: type: string format: date-time billFetchFailureMessage: type: string attachment: type: boolean companyBranchCodeId: type: integer format: int64 autoDebit: type: boolean recoverableAmount: type: number commencementDate: type: string format: date remarks: type: string bbpsServiceProvider: type: string enum: - MK - BA - SS - BE - WH - ME - TW - FP - CS - AX - T1 - T2 - T3 - IN companyBillerAuditTrails: uniqueItems: true type: array items: $ref: '#/components/schemas/CompanyBillerAuditTrail' bankCard: type: integer format: int64 createdBy: type: integer format: int64 modifiedBy: type: integer format: int64 createdOn: type: string format: date-time modifiedOn: type: string format: date-time lastBillCheckedAt: type: string format: date-time lastBillFetchedAmount: type: number lastBillFetchedMessage: type: string lastBillFetchedReferenceId: type: string lastBillPayDate: type: string format: date-time keyContactEmail: type: string billerCopyInputParamsData: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] billCopyEnabled: type: boolean x-apidog-orders: - id - companyBillerId - companyId - billerId - consumerNumber - consumerName - circle - billInputParams - lastDueDate - lastBillCreatedOn - deleted - active - companyBillerValidationStatus - validatedOn - billFetchFailureMessage - attachment - companyBranchCodeId - autoDebit - recoverableAmount - commencementDate - remarks - bbpsServiceProvider - companyBillerAuditTrails - bankCard - createdBy - modifiedBy - createdOn - modifiedOn - lastBillCheckedAt - lastBillFetchedAmount - lastBillFetchedMessage - lastBillFetchedReferenceId - lastBillPayDate - keyContactEmail - billerCopyInputParamsData - billCopyEnabled x-apidog-ignore-properties: [] x-apidog-folder: '' CompanyBillerAuditTrail: type: object properties: id: type: integer format: int64 companyBiller: *ref_9 action: type: string enum: - CREATION - APPROVAL_STATUS - ACTIVE - DELETE - AUTO_DEBIT - BILL_CREATION - BANK_CARD value: type: string user: &ref_10 $ref: '#/components/schemas/User' timestamp: type: string format: date-time displayAction: type: string x-apidog-orders: - id - companyBiller - action - value - user - timestamp - displayAction x-apidog-ignore-properties: [] x-apidog-folder: '' User: type: object properties: id: type: integer format: int64 ekUserId: type: string password: type: string status: type: string enum: - ACTIVE - INACTIVE - BLOCKED - LOCKED role: type: string enum: - ADMIN - AUDITOR - ENKASH_OPS - ENKASH_SALES - ENKASH_IT - ENKASH_OPS_MANAGER - ENKASH_FINANCE - ENKASH_FINANCE_HEAD - ENKASH_FINANCE_MANAGER - ENKASH_FINANCE_OPS - ENKASH_FINANCE_VIEW - ENKASH_ONBOARDING - ENKASH_OPS_ADMIN - ENKASH_TECH_SUPPORT - ENKASH_CREDIT_MANAGER - ENKASH_CREDIT - ENKASH_IT_ADMIN - CREDIT_PROVIDER - CREDIT_PROVIDER_VIEWER - CREDIT_PROVIDER_SALES - CREDIT_PROVIDER_OPS - CREDIT_PROVIDER_PRODUCT - CREDIT_PROVIDER_IT - CREDIT_PROVIDER_OPS_MAKER - CREDIT_PROVIDER_OPS_CHECKER - ENTERPRISE - ENTERPRISE_MAKER - ENTERPRISE_CHECKER - ENTERPRISE_APPROVER - ENTERPRISE_FINANCE - ENTERPRISE_HR - ENTERPRISE_VIEWER - ENTERPRISE_AUDITOR - VENDOR - VENDOR_MAKER - VENDOR_CHECKER - EXTERNAL_SYSTEM - EMPLOYEE - CHANNEL_PARTNER - AGENCY - NON_FINANCE_CHECKER - ENKASH_PRODUCT mobile: type: string mobileVerified: type: boolean deleted: type: boolean email: type: string authMedium: type: string enum: - MOBILE - EMAIL emailVerified: type: boolean emailVerifiedOn: type: string format: date-time title: type: string enum: - Mr - Mrs - Ms name: type: string firstName: type: string middleName: type: string lastName: type: string parsedNameValues: type: boolean lastAccessTime: type: string format: date-time logo: type: string dateLastPasswordSet: type: string format: date-time mobileOtp: type: string mobileOtpExpiryDate: type: string format: date-time emailOtp: type: string emailOtpExpiryDate: type: string format: date-time companyId: type: integer format: int64 cardApplicationPending: type: boolean cardIssued: type: boolean cardActivated: type: boolean pan: type: string dateOfBirth: type: string format: date dateOfJoining: type: string format: date addressOne: type: string addressTwo: type: string city: type: string state: type: string pinCode: type: string authorities: type: array items: type: string branchCodes: type: array items: $ref: '#/components/schemas/BranchCodeDTO' agreeAccountTnC: type: boolean upgradeCard: type: boolean managerId: type: integer format: int64 group: type: string remarks: type: string createdBy: type: integer format: int64 modifiedBy: type: integer format: int64 favorites: type: array items: type: string enum: - VENDOR_PAYMENTS - UTILITY_PAYMENTS - GST_PAYMENTS - RENTAL_PAYMENTS - EXPENSE_MANAGEMENT - ADD_EXPENSE - ADD_REPORT - VIEW_ACCOUNT_DETAILS - VIEW_CARDS - VIEW_TRANSACTIONS - VIEW_STATEMENTS - REWARDS_AND_OFFERS - SEAMLESS_BANKING - BANK_CARDS - COLLECT_PAYMENTS - CARD_PERFORMANCE - OLYMPUS_COLLECT - BANK_RECONCILIATION - PROGRAM_STATS - VIEW_RELATIONSHIPS - EMPLOYEE_REWARD_ACCOUNT - EMPLOYEE_REWARD_TRANSACTION - EMPLOYEE_REWARD - CHANNEL_INCENTIVE_ACCOUNT - CHANNEL_INCENTIVE_TRANSACTION - CHANNEL_INCENTIVE - FREEDOM_REWARDS - FREEDOM_REWARDS_ACCOUNT - PETTY_CASH - COLLECT_VIEW_TRANSACTION - COLLECT_VIEW_SETTLEMENT - COLLECT_PAYMENT_LINK - COLLECT_MANAGE_CUSTOMER - COLLECT_MANAGE_INVOICE - COLLECT_REMINDER_CONFIGURATION - ENKASH_PAYOUTS - PAPG_ORDERS - PAPG_REFUNDS - PLATFORM_DEBIT_CARD - TALLY_INTEGRATION - COLLECT_RECEIPT - PAYOUT_TRANSFERS - EXPENSE_ANALYTICS - ALL_VOUCHERS - VOUCHER_ORDERS - VOUCHER_CART - CHANNEL_INCENTIVE_ORDERS - EMPLOYEE_REWARD_ORDERS - GIFT - MEAL - E_RUPI - PAYOUT_MANAGE_BENEFICIARY - PAYOUT_ACCOUNT aadhaar: type: integer format: int64 passport: type: integer format: int64 whatsappConsent: type: boolean whatsappConsentShownOn: type: string format: date-time userNameAndEmailNudgeShownOn: type: string format: date-time applyForCardNudgeShownOn: type: string format: date-time submitKycDetailNudgeShownOn: type: string format: date-time remainingLoginAttempts: type: integer format: int32 lastLoginAttemptAt: type: string format: date-time userGroups: uniqueItems: true type: array items: &ref_11 $ref: '#/components/schemas/UserGroup' userGroupIds: type: array items: type: string userGroupRowIds: type: array items: type: integer format: int64 assignedAllUserGroup: type: boolean mfaToken: type: string mfaEnabled: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time token: type: string queryParams: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] utmSource: type: string homepageVisited: type: boolean leadId: type: string contactId: type: string tenants: uniqueItems: true type: array items: type: string enum: - ENKASH - SBM - TRANSCORP - AU_BANK - FINCARE - INDUSIND - ENKASH_PPI useDefaultLogin: type: boolean allowAllApiClient: type: boolean departmentId: type: string subDepartmentId: type: integer format: int64 designationId: type: string lastUsedPasswords: type: array items: $ref: '#/components/schemas/PasswordDetail' roles: type: array items: type: string enum: - ADMIN - AUDITOR - ENKASH_OPS - ENKASH_SALES - ENKASH_IT - ENKASH_OPS_MANAGER - ENKASH_FINANCE - ENKASH_FINANCE_HEAD - ENKASH_FINANCE_MANAGER - ENKASH_FINANCE_OPS - ENKASH_FINANCE_VIEW - ENKASH_ONBOARDING - ENKASH_OPS_ADMIN - ENKASH_TECH_SUPPORT - ENKASH_CREDIT_MANAGER - ENKASH_CREDIT - ENKASH_IT_ADMIN - CREDIT_PROVIDER - CREDIT_PROVIDER_VIEWER - CREDIT_PROVIDER_SALES - CREDIT_PROVIDER_OPS - CREDIT_PROVIDER_PRODUCT - CREDIT_PROVIDER_IT - CREDIT_PROVIDER_OPS_MAKER - CREDIT_PROVIDER_OPS_CHECKER - ENTERPRISE - ENTERPRISE_MAKER - ENTERPRISE_CHECKER - ENTERPRISE_APPROVER - ENTERPRISE_FINANCE - ENTERPRISE_HR - ENTERPRISE_VIEWER - ENTERPRISE_AUDITOR - VENDOR - VENDOR_MAKER - VENDOR_CHECKER - EXTERNAL_SYSTEM - EMPLOYEE - CHANNEL_PARTNER - AGENCY - NON_FINANCE_CHECKER - ENKASH_PRODUCT designation: type: string enum: - TEAM_MEMBER - MANAGER - FINANCE_ADMIN - SALES_MANAGER - CEO_OR_OWNER - SALES_EXECUTIVE - ADMIN - DIRECTOR - CFO expenseUseCase: type: array items: type: string enum: - TRACKING_EXPENSE - SUBMITTING_EXPENSES - COLLECTING_RECEIPTS - EXPENSE_INSIGHTS - STREAMLINE - OTHERS invitorUser: type: string expenseAccountTypes: type: array items: type: string externalEmployeeId: type: string expenseApprover: type: string delegateUserId: type: string userSync: type: boolean referralCode: type: string x-apidog-orders: - id - ekUserId - password - status - role - mobile - mobileVerified - deleted - email - authMedium - emailVerified - emailVerifiedOn - title - name - firstName - middleName - lastName - parsedNameValues - lastAccessTime - logo - dateLastPasswordSet - mobileOtp - mobileOtpExpiryDate - emailOtp - emailOtpExpiryDate - companyId - cardApplicationPending - cardIssued - cardActivated - pan - dateOfBirth - dateOfJoining - addressOne - addressTwo - city - state - pinCode - authorities - branchCodes - agreeAccountTnC - upgradeCard - managerId - group - remarks - createdBy - modifiedBy - favorites - aadhaar - passport - whatsappConsent - whatsappConsentShownOn - userNameAndEmailNudgeShownOn - applyForCardNudgeShownOn - submitKycDetailNudgeShownOn - remainingLoginAttempts - lastLoginAttemptAt - userGroups - userGroupIds - userGroupRowIds - assignedAllUserGroup - mfaToken - mfaEnabled - createdOn - modifiedOn - token - queryParams - utmSource - homepageVisited - leadId - contactId - tenants - useDefaultLogin - allowAllApiClient - departmentId - subDepartmentId - designationId - lastUsedPasswords - roles - designation - expenseUseCase - invitorUser - expenseAccountTypes - externalEmployeeId - expenseApprover - delegateUserId - userSync - referralCode x-apidog-ignore-properties: [] x-apidog-folder: '' PasswordDetail: type: object properties: password: type: string changedOn: type: string format: date-time x-apidog-orders: - password - changedOn x-apidog-ignore-properties: [] x-apidog-folder: '' UserGroup: type: object properties: id: type: integer format: int64 userGroupId: type: string userGroupName: type: string companyId: type: integer format: int64 users: uniqueItems: true type: array items: *ref_10 companies: uniqueItems: true type: array items: &ref_12 $ref: '#/components/schemas/Company' cardApplications: uniqueItems: true type: array items: &ref_13 $ref: '#/components/schemas/CardApplication' utmBasedConfigs: uniqueItems: true type: array items: $ref: '#/components/schemas/UtmBasedConfig' createdBy: type: integer format: int64 modifiedBy: type: integer format: int64 createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - userGroupId - userGroupName - companyId - users - companies - cardApplications - utmBasedConfigs - createdBy - modifiedBy - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' UtmBasedConfig: type: object properties: id: type: integer format: int64 utmSource: type: string utmName: type: string cpId: type: integer format: int64 pgPaymentModePricings: type: array items: $ref: '#/components/schemas/PgPaymentModePricing' features: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] landingPage: type: string enum: - SEAMLESS_BANKING - APPLY_FREEDOM_CARD - GIFT_VOUCHER - EMPLOYEE_REWARDS - BILL_PAYMENT - VENDOR_PAYMENT - GST_PAYMENT - EXPENSE_MANAGEMENT postSignupRedirectUrl: type: string planMasterId: type: string parentId: type: integer format: int64 pricingPlanId: type: integer format: int64 directorEditAllowed: type: boolean createdBy: type: integer format: int64 modifiedBy: type: integer format: int64 disableCommunications: type: boolean disableAutoIssueZeroLimitCard: type: boolean skipBureauCheck: type: boolean anchor: type: string enum: - FLIPKART - AMAZON - VELOCITI - SPRINGBOARD_91 - BIGMOUTHSOCIAL - LEGAL_DOCS - SHIPROCKET - EZO_BANKS - MMT - ENKASH_VENDORS - DIGITAL_LEADS - DIRECT_SALES - COWRKS - SBM - OTHERS - PROFIT_BOOKS - START_UP_LANES - HERMONEY_TALKS - TRADE_INDIA - KLUBWORKS - AXILOR - MINTIFI - GPS_TRAVEL - GIFT_CARD - UGRO - STARTUP_CARDS - GOOD_DEAL_SECURITIES - CANOPI - WISHFIN - STOREKING - TALLYPARTNER - CARDPARTNERS - CREDIT_ENABLE - TEMP_ANCHOR_1 - TEMP_ANCHOR_2 - TEMP_ANCHOR_3 - TEMP_ANCHOR_4 - TEMP_ANCHOR_5 - TEMP_ANCHOR_6 - TEMP_ANCHOR_7 - TEMP_ANCHOR_8 - AXIS_BBPS - OLYMPUS_DIRECT - OLYMPUS_DIGITAL - BANK active: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time logo: type: string bankStatementRequired: type: boolean enableWhatsapp: type: boolean fdDetailRequired: type: boolean allowedKycTypes: type: array items: type: string enum: - AADHAAR_XML - OFFLINE_DOCUMENTS bulkUploadFileUrl: type: string bulkUploadType: type: string enum: - HDFC_PAYOUT_UPLOAD - BILLER_UPLOAD - UTILITY_PAYMENT_UPDATE - CARD_APPLICATION_UGRO - CARD_APPLICATION - BANK_NEFT_IFSC - BANK_IFSC_RAZORPAY - ICICI_VIRTUAL_BULK_UPLOAD - BILL_PAY_DETAILS_UPDATE - VENDOR_UPDATE - RISK_CHECK_BULK_UPLOAD - BULK_FILE_DETAIL - AU_VIRTUAL_BULK_UPLOAD - AXIS_NBSPL_NTSPL_VIRTUAL_BULK_UPLOAD downloadReportType: type: string enum: - ADMIN_COMPANY_REPORT - COMPANY_REPORT - BRANCH_CODE_REPORT - CP_COMPANY_REPORT - INVOICE_REPORT - UTILITY_REPORT - GST_REPORT - CARD_APPLICATION - SINGLE_SIGNUP - ANCHOR_DATA - ANCHOR_DATA_UPLOAD - BILLER - ENKASH_LOAN_FILES - CRIF_ASSESSMENT - FLIPKART_APP_STATUS - FLIPKART_FINAL_OFFER - FLIPKART_LOAN_OUTSTANDING - FINANCE_REPORT - DAILY_SBM_FINANCE_REPORT - NEW_BILL_NOT_GENERATED - USER_REPORT - DAILY_PAYOUT_AMOUNT_REPORT - UTILITY_PAYMENT_DAILY_SUCCESS_FAILURE_FILE - COMPANY_BRANCH_CODE_SUCCESS_REPORT - COMPANY_BRANCH_CODE_FAILURE_REPORT - COMPANY_BRANCH_CODE - USER_UPLOAD_REPORT - HDFC_PAYOUT_REPORT - HDFC_BENEFICIARY_UPLOAD_REPORT - HDFC_PAYOUT_UPLOAD_REPORT - BILLER_UPLOAD_REPORT - UTILITY_PAYMENT_UPDATE_FILE - VENDOR_UPDATE - UTILITY_PAYMENT_PENDING_REPORT - UTILITY_PAYMENT_BILLPAY_PENDING_REPORT - PAYOUT_DATA - BILLPAY_REINITIATED - BILLER_DEACTIVATED_REPORT - NEW_BILLER_ADDITION_VALIDATION_SUCCESS - NEW_BILLER_ADDITION_VALIDATION_FAILURE - INVOICE_PAYMENT_PENDING_REPORT - FD_PAYMENT_HISTORY - APP_STATUS_FILE - DEFAULT_APP_STATUS_FILE - CARD_APPLICATION_UGRO_REPORT - ANCHOR_DATA_PURGED_PERFORMANCE_REPORT - FD_CREATION_REPORT - VIRTUAL_ACCOUNT_DATA_REPORT - ICICI_VIRTUAL_ACCOUNT_ADD_BALANCE_REPORT - KOTAK_VIRTUAL_ACCOUNT_ADD_BALANCE_REPORT - UTILITY_PAYMENT_UPDATE_SUCCESS_FILE_REPORT - UTILITY_PAYMENT_UPDATE_FAILURE_FILE_REPORT - RISK_CHECK_SUCCESS_FILE_REPORT - RISK_CHECK_FAILURE_FILE_REPORT - VENDOR_UPDATE_SUCCESS_FILE_REPORT - VENDOR_UPDATE_FAILURE_FILE_REPORT - BENEFICIARY_BANK_DETAILS_EXPIRED - AU_CARD_APPLICATION - BUREAU_REPORT - UTILITY_PAYMENT_APPROVAL_HISTORY - UTILITY_PAYMENT_BILL_PAY_DETAILS_UPDATE_FILE - BULK_FILE_DETAIL_REPORT - REFUND_TRANSACTION_REPORT - AXIS_NBSPL_NTSPL_VIRTUAL_ACCOUNT_ADD_BALANCE_REPORT - PAYOUT_TRANSACTION_REPORT - BILL_INFORMATION_DATA prepaidCardProductMasterId: type: integer format: int64 creditAcceptThankYouMessage: type: string enum: - AMAZON_ESCROW_CONFIRMATION - CARD_APPLICATION_BANK_DETAIL_PENDING - CARD_APPLICATION_BANK_DETAIL_VALIDATION_PENDING - CARD_APPLICATION_DIRECTOR_DETAIL_PENDING - CARD_APPLICATION_CARD_TNC_PENDING - CARD_LIMIT_ASSIGNED - ZERO_LIMIT_CARD_ISSUED - ONBOARDING_WELCOME - ONBOARDING_REMINDER - ONBOARDING_COMPLETE - GSTIN_WITH_OTP_TINY_URL_NOTIFICATION - ACCOUNT_AGGREGATION_TINY_URL_NOTIFICATION - KYC_REJECT_NOTIFICATION - THANK_YOU_FOR_ACCEPTING_CREDIT_AMAZON - THANK_YOU_FOR_ACCEPTING_CREDIT_FLIPKART - LOGIN_OTP averageMonthlyPayoutRangeAndCardProductMasterMappings: type: array items: $ref: >- #/components/schemas/AverageMonthlyPayoutRangeAndCardProductMasterMapping gstinWithOtpAllowed: type: boolean accountAggregationAllowed: type: boolean createCardApplication: type: boolean creditPolicy: type: string enum: - FLIPKART - AMAZON - STARTUP - ENKASH_VENDOR userGroup: *ref_11 prepaidCardConfigs: type: array items: $ref: '#/components/schemas/PrepaidCardConfig' creditCardConfigs: type: array items: $ref: '#/components/schemas/CreditCardConfig' createPrimaryCard: type: boolean signupPageBannerImage: type: string webCreditFlowImage: type: string autoPaperBasedKyc: type: boolean primaryProduct: type: string defaultCardProvider: type: string defaultProgram: type: string defaultChannel: type: string enum: - PARTNERSHIP - OTHERS - WALK_IN - DIGITAL_LEADS - MARKETING defaultEnterpriseType: type: string bureauConsentRequired: type: boolean partnerProgram: type: string createLead: type: boolean zohoLeadLayout: type: string emailDomain: type: string emailVerificationOnSignUp: type: boolean productCategory: type: string leadSource: type: string offerCodeValidation: type: boolean userRole: type: string enum: - ADMIN - AUDITOR - ENKASH_OPS - ENKASH_SALES - ENKASH_IT - ENKASH_OPS_MANAGER - ENKASH_FINANCE - ENKASH_FINANCE_HEAD - ENKASH_FINANCE_MANAGER - ENKASH_FINANCE_OPS - ENKASH_FINANCE_VIEW - ENKASH_ONBOARDING - ENKASH_OPS_ADMIN - ENKASH_TECH_SUPPORT - ENKASH_CREDIT_MANAGER - ENKASH_CREDIT - ENKASH_IT_ADMIN - CREDIT_PROVIDER - CREDIT_PROVIDER_VIEWER - CREDIT_PROVIDER_SALES - CREDIT_PROVIDER_OPS - CREDIT_PROVIDER_PRODUCT - CREDIT_PROVIDER_IT - CREDIT_PROVIDER_OPS_MAKER - CREDIT_PROVIDER_OPS_CHECKER - ENTERPRISE - ENTERPRISE_MAKER - ENTERPRISE_CHECKER - ENTERPRISE_APPROVER - ENTERPRISE_FINANCE - ENTERPRISE_HR - ENTERPRISE_VIEWER - ENTERPRISE_AUDITOR - VENDOR - VENDOR_MAKER - VENDOR_CHECKER - EXTERNAL_SYSTEM - EMPLOYEE - CHANNEL_PARTNER - AGENCY - NON_FINANCE_CHECKER - ENKASH_PRODUCT roleUpdateAllowed: type: boolean companyBasedUtm: type: boolean x-apidog-orders: - id - utmSource - utmName - cpId - pgPaymentModePricings - features - landingPage - postSignupRedirectUrl - planMasterId - parentId - pricingPlanId - directorEditAllowed - createdBy - modifiedBy - disableCommunications - disableAutoIssueZeroLimitCard - skipBureauCheck - anchor - active - createdOn - modifiedOn - logo - bankStatementRequired - enableWhatsapp - fdDetailRequired - allowedKycTypes - bulkUploadFileUrl - bulkUploadType - downloadReportType - prepaidCardProductMasterId - creditAcceptThankYouMessage - averageMonthlyPayoutRangeAndCardProductMasterMappings - gstinWithOtpAllowed - accountAggregationAllowed - createCardApplication - creditPolicy - userGroup - prepaidCardConfigs - creditCardConfigs - createPrimaryCard - signupPageBannerImage - webCreditFlowImage - autoPaperBasedKyc - primaryProduct - defaultCardProvider - defaultProgram - defaultChannel - defaultEnterpriseType - bureauConsentRequired - partnerProgram - createLead - zohoLeadLayout - emailDomain - emailVerificationOnSignUp - productCategory - leadSource - offerCodeValidation - userRole - roleUpdateAllowed - companyBasedUtm x-apidog-ignore-properties: [] x-apidog-folder: '' CreditCardConfig: type: object properties: name: type: string logo: type: string accountType: type: string comingSoon: type: boolean cardTitle: type: string cardInfo: type: string onboardingSteps: type: array items: type: string enum: - GST_WITH_OTP - BANK_STATEMENT - CREDIT_UW_DOCUMENTS - DIRECTOR - DIRECTOR_DOCUMENTS - COMPANY_DOCUMENTS - DIRECTOR_ADDRESS_VERIFICATION x-apidog-orders: - name - logo - accountType - comingSoon - cardTitle - cardInfo - onboardingSteps x-apidog-ignore-properties: [] x-apidog-folder: '' PrepaidCardConfig: type: object properties: name: type: string logo: type: string accountType: type: string comingSoon: type: boolean cardTitle: type: string cardInfo: type: string description: type: string cardSchemes: type: array items: type: string cardSchemePlanMasterMapping: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] x-apidog-orders: - name - logo - accountType - comingSoon - cardTitle - cardInfo - description - cardSchemes - cardSchemePlanMasterMapping x-apidog-ignore-properties: [] x-apidog-folder: '' AverageMonthlyPayoutRangeAndCardProductMasterMapping: type: object properties: averageMonthlyPayoutFrom: type: number averageMonthlyPayoutTo: type: number eligibilityCategories: uniqueItems: true type: array items: type: string enum: - PLATINUM - GOLD - SILVER - BRONZE bureauScoreCategories: uniqueItems: true type: array items: type: string enum: - A - B - C - D - E - F - G cardProductMasterId: type: integer format: int64 x-apidog-orders: - averageMonthlyPayoutFrom - averageMonthlyPayoutTo - eligibilityCategories - bureauScoreCategories - cardProductMasterId x-apidog-ignore-properties: [] x-apidog-folder: '' PgPaymentModePricing: required: - enkashPgCode - paymentMode type: object properties: enkashPgCode: type: string paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER productCode: type: string enum: - DEFAULT - INVOICE - GST - UTILITY - RENTAL - ADVANCE_PAYMENT - KASHFLO - VOUCHER - COLLECTION_INVOICE - QUICK_COLLECT - QUICK_COLLECT_COLLECTION - REWARD_VOUCHER - INCENTIVE_VOUCHER - FREEDOM_VOUCHER - PETTY_CASH - DIRECT_PAYOUT - OFFER_VOUCHER - OFFER_REWARD - OFFER_INCENTIVE surcharge: type: number flatSurcharge: type: number mdr: type: number flatMdr: type: number x-apidog-orders: - enkashPgCode - paymentMode - productCode - surcharge - flatSurcharge - mdr - flatMdr x-apidog-ignore-properties: [] x-apidog-folder: '' CardApplication: type: object properties: id: type: integer format: int64 cardApplicationCrmData: $ref: '#/components/schemas/CardApplicationCrmData' applicationId: type: string leadId: type: string accountId: type: string dealId: type: string contactId: type: string applicationStage: type: string enum: - USER_DETAIL_SUBMITTED - MOBILE_VERIFIED - EMAIL_VERIFIED - PASSWORD_UPDATED - DIRECTOR_DETAIL_SUBMITTED - GSTIN_DETAIL_SUBMITTED - GSTIN_VERIFIED - PAN_SUBMITTED - PAN_VERIFIED - BANK_DETAIL_SUBMITTED - BANK_DETAIL_VALIDATED - DIRECTOR_MOBILE_VERIFIED - TNC_AGREED - GSTIN_DATA_VERIFIED - KYC_DOCUMENTS_UPLOADED - CREDIT_UW_DOCUMENTS_UPLOADED - COMPANY_INFORMATION_SUBMITTED - AGREE_CARD_TNC - ACCOUNT_AGGREGATION_VERIFIED - ONBOARDING_DIRECTOR_ADDRESS_VERIFICATION - ONBOARDING_DIRECTOR_DOCUMENTS - ONBOARDING_COMPANY_DOCUMENTS - INIT title: type: string enum: - Mr - Mrs - Ms firstName: type: string lastName: type: string promoCode: type: string source: type: string utmSource: type: string utmMedium: type: string utmCampaign: type: string queryParams: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] mobile: type: string mobileOtp: type: string mobileOtpSentDate: type: string format: date-time mobileOtpVerificationAttemptLeft: type: integer format: int32 mobileOtpResendLeft: type: integer format: int32 mobileVerified: type: boolean email: type: string emailOtp: type: string emailOtpSentDate: type: string format: date-time emailOtpVerificationAttemptLeft: type: integer format: int32 emailOtpResendLeft: type: integer format: int32 emailVerified: type: boolean userId: type: integer format: int64 applyEnKashCard: type: boolean typeOfCompany: type: string enum: - STARTUP - SME - OTHERS cin: type: string howBusinessFinanced: type: string enum: - LLC - CC - VCPE - OTHERS - NONE howWillEnKashCardUse: type: string enum: - PIA - TRAVEL - EOS - IINPBL - OTHERS expectedMonthlySpendLimit: type: number isLoggedInUserDirector: type: boolean directorInfos: type: array items: $ref: '#/components/schemas/DirectorInfo' director: $ref: '#/components/schemas/Director' directorMobileOtp: type: string directorMobileOtpSentDate: type: string format: date-time directorMobileVerified: type: boolean legalName: type: string companyType: type: string enum: - INDIVIDUAL - PROPRIETOR - PARTNERSHIP - COMPANY program: type: string product: type: string enterpriseType: type: string enterpriseSubType: type: string gstin: type: string pan: type: string panOrGstinVerificationMethod: type: string enum: - GSTIN_WITH_OTP - GSTIN_WITH_PASSWORD - PAN_VERIFICATION - GSTIN_VERIFICATION panEntity: &ref_18 $ref: '#/components/schemas/Pan' gstinEntity: $ref: '#/components/schemas/Gstin' cinEntity: $ref: '#/components/schemas/Cin' bank: type: string accountNumber: type: string ifsc: type: string bankAccountName: type: string bankAccountChangeAttemptLeft: type: integer format: int32 pennyAmountVerified: type: boolean pennyAmountVerifyAttemptLeft: type: integer format: int32 pennyDrop: &ref_20 $ref: '#/components/schemas/PennyDrop' companyCreateStatus: type: string enum: - PENDING - IN_PROCESS - NEW_CREATED - OLD_MAPPED company: *ref_12 agreeTnC: type: boolean agreeCardTnC: type: boolean cardIssued: type: boolean failureReason: type: string approvalStatus: type: string enum: - CREATED - RECEIVED - DATA_VERIFIED - APPROVED - REJECTED - ABANDONED - DROPPED - CONFIRMED - INCOMPLETE_APPLICATION approvalStatusRemarks: type: string dataVerificationRemarks: type: string approvalSubStatus: type: string enum: - AWAITING_DOCUMENTS - DOCUMENT_ANALYSIS - USER_CONFIRMATION_PENDING - KYC_PENDING - LOAN_DISBURSEMENT_PENDING - LOAN_DISBURSED - USER_REJECTED - LENDER_REJECTED - DUPLICATE - INCOMPLETE - DROPPED rejectionCategory: type: string enum: - KYC - COMPLIANCE - POLICY - SELLER_REJECT - BUREAU statusReasonCode: type: string enum: - CREDIT_SCORE_BELOW_LENDER_THRESHOLD - DIRECTOR_BUREAU_BELOW_LENDER_THRESHOLD - TOO_MANY_RECENT_INQUIRIES - DEFAULT_OR_OVERDUE_HISTORY - PROCESSING_FEE - LOCKING_ACCOUNT - INTEREST_RATE - LOAN_PRODUCT_TYPE - LOAN_TENURE - NEW_ACCOUNT_OPENING - NO_RESPONSE_FROM_SELLER - CUSTOMER_NOT_RESPONDING - CUSTOMER_DENIED_LOW_LIMIT - CUSTOMER_DENIED_DOCUMENTS - NO_OWNERSHIP_PROOF - DECLINE_IN_PAYMENTS - SELLER_OVERLEVERAGED - SELLER_HAS_LOANS_WITH_OTHER_BANKS - OUTSIDE_SERVICE_OR_LOCATION - NO_ELIGIBLE_PERSONAL_GUARANTOR - IRREGULAR_OPERATING_METRICS - APPLICANT_AGE - EXISTING_CUSTOMER - LOAN_LIKELY_USED_FOR_NON_COMMERCIAL - INTELLECTUAL_PROPERTY_VIOLATION - OTHERS - RELATED_PARTY_TRANSACTIONS_BELOW_LENDER_THRESHOLD - CLIENT_FROM_NEGATIVE_AREA_AND_PROFILE - EXISTING_ACCOUNT_DELIQUENT - GST_NOT_FILED - VAT_RETURNS_NOT_FILED - LOSS_MAKING_COMPANY - CONSTITUTION_RESTRICTION - COMPANY_PROFILE_RESTRICTION - RELATED_PARTY_SALES_ABOVE_LENDER_THRESHOLD - RELATED_PARTY_PURCHASE_ABOVE_LENDER_THRESHOLD - IDENTITY_PROOF_NOT_VERIFIABLE - ADDRESS_PROOF_NOT_VERIFIABLE - CRIME_LITIGATION_GOVERNMENT_POLICY_VIOLATION_HISTORY - COMPANY_IDENTITY_PROOF_NOT_VERIFIABLE - SANCTION_AND_POLITICAL_PERSON_CHECK_FAILED - NEGATIVE_NEWS_CHECK_FAILED - FINANCIAL_CRIME_RISK_CHECK_FAILED - LENDER_BLACKLISTED - FRAUD - NOT_REACHABLE - DOCUMENTS_NOT_PROVIDED - UNFINISHED_APPLICATION - OTHER_APPLICATION_CONFIRMED - OTHER_APPLICATION_REJECTED accountLockStatus: type: string enum: - UNLOCKED - LOCKED - PARTNER_CONFIRMED - PARTNER_DENIED accountLockTime: type: string format: date-time accountLockStatusRemarks: type: string remarks: type: string kycStatus: type: string enum: - PENDING - DOCUMENT_UPLOADED - OSV_VERIFIED - UPLOADED_TO_NBFC - REJECTED kycStatusRemarks: type: string proofOfIdentity: type: string enum: - PAN - DRIVING_LICENSE - PASSPORT proofOfAddress: type: string enum: - PASSPORT - DRIVING_LICENSE - UTILITY_BILLS - BANK_STATEMENT - VOTER_ID - AADHAAR cardIssueApprovalStatus: type: string enum: - PENDING - APPROVED - REJECTED - CLOSED - LIMIT_REJECTED creditLimit: type: number anchor: type: string enum: - FLIPKART - AMAZON - VELOCITI - SPRINGBOARD_91 - BIGMOUTHSOCIAL - LEGAL_DOCS - SHIPROCKET - EZO_BANKS - MMT - ENKASH_VENDORS - DIGITAL_LEADS - DIRECT_SALES - COWRKS - SBM - OTHERS - PROFIT_BOOKS - START_UP_LANES - HERMONEY_TALKS - TRADE_INDIA - KLUBWORKS - AXILOR - MINTIFI - GPS_TRAVEL - GIFT_CARD - UGRO - STARTUP_CARDS - GOOD_DEAL_SECURITIES - CANOPI - WISHFIN - STOREKING - TALLYPARTNER - CARDPARTNERS - CREDIT_ENABLE - TEMP_ANCHOR_1 - TEMP_ANCHOR_2 - TEMP_ANCHOR_3 - TEMP_ANCHOR_4 - TEMP_ANCHOR_5 - TEMP_ANCHOR_6 - TEMP_ANCHOR_7 - TEMP_ANCHOR_8 - AXIS_BBPS - OLYMPUS_DIRECT - OLYMPUS_DIGITAL - BANK channel: type: string enum: - PARTNERSHIP - OTHERS - WALK_IN - DIGITAL_LEADS - MARKETING anchorProductCode: type: string anchorKey: type: string anchorApplicationId: type: string anchorCreditApprovalId: type: string anchorLoanId: type: string anchorDataId: type: integer format: int64 approvedOn: type: string format: date-time sanctionedLimitExpiryOn: type: string format: date-time rejectedOn: type: string format: date-time cardIssuedOn: type: string format: date-time createdOn: type: string format: date-time modifiedOn: type: string format: date-time eligibleLimit: type: number unsubscribe: type: boolean directorEditAllowed: type: boolean discrepanciesMailSent: type: boolean disableCommunications: type: boolean offerValidUpto: type: string format: date skipBureauCheck: type: boolean eligibilityCategory: type: string enum: - PLATINUM - GOLD - SILVER - BRONZE eligibilityIndex: type: number creditProviderId: type: string productCode: type: string cpBureauScore: type: integer format: int32 creditAssessment: $ref: '#/components/schemas/CreditAssessment' preVerificationRecommendedLimit: type: number postVerificationRecommendedLimit: type: number planMasterId: type: string memoDetailsList: uniqueItems: true type: array items: $ref: '#/components/schemas/MemoDetails' lastMemoScheduledDate: type: string format: date-time lastMemoAssignedAgent: type: string bankStatementRequired: type: boolean onBoardingStep: type: string nextReminderDate: type: string format: date-time previousReminderDate: type: string format: date-time facebookEmail: type: string linkedInEmail: type: string instagramEmail: type: string companyWeb: type: string creditGuarantor: $ref: '#/components/schemas/CreditGuarantor' alternateMobileFamily: type: string alternateMobileFriend: type: string bureauCheckConsent: type: boolean cardSignUpWhatsappFlow: type: boolean companyName: type: string companyCode: type: string whatsAppOnBoardingCondition: type: string nextOnBoardingStep: type: string bankVerificationMethod: type: string enum: - BANK_STATEMENT_UPLOADED - NET_BANKING - PENNY_DROP fdDetail: &ref_17 $ref: '#/components/schemas/FdDetail' gstinData: $ref: '#/components/schemas/GstinData' gstinDataExcelDownloadUrl: type: string gstinDataPdfDownloadUrl: type: string allowedKycTypes: type: array items: type: string enum: - AADHAAR_XML - OFFLINE_DOCUMENTS userGroups: uniqueItems: true type: array items: *ref_11 accountAggregationUrl: type: string linkGstWithOtpUrl: type: string digitalLockerConsentUrl: type: string originatedBy: type: string averageSixMonthBalance: type: number averageMonthlyBalance: type: number currentFilingPeriod: type: string averageFifteenMonthTurnOver: type: number previousFilingPeriod: type: string averageFifteenMonthTurnOverPreviousYear: type: number accountAggregations: type: array items: $ref: '#/components/schemas/AccountAggregation' manualCreditProviderAssignedBy: type: integer format: int64 autoAssignedCreditProvider: type: boolean creditCardType: type: string creditUnderWritingStepsDone: type: boolean creditUnderWritingStepsDoneDate: type: string format: date-time onboardingDocumentsSubmitted: type: boolean closedOn: type: string format: date-time applicationStages: type: array items: type: string enum: - USER_DETAIL_SUBMITTED - MOBILE_VERIFIED - EMAIL_VERIFIED - PASSWORD_UPDATED - DIRECTOR_DETAIL_SUBMITTED - GSTIN_DETAIL_SUBMITTED - GSTIN_VERIFIED - PAN_SUBMITTED - PAN_VERIFIED - BANK_DETAIL_SUBMITTED - BANK_DETAIL_VALIDATED - DIRECTOR_MOBILE_VERIFIED - TNC_AGREED - GSTIN_DATA_VERIFIED - KYC_DOCUMENTS_UPLOADED - CREDIT_UW_DOCUMENTS_UPLOADED - COMPANY_INFORMATION_SUBMITTED - AGREE_CARD_TNC - ACCOUNT_AGGREGATION_VERIFIED - ONBOARDING_DIRECTOR_ADDRESS_VERIFICATION - ONBOARDING_DIRECTOR_DOCUMENTS - ONBOARDING_COMPANY_DOCUMENTS - INIT cardAccountId: type: string cardDashboardVisited: type: boolean onboardingSteps: uniqueItems: true type: array items: type: string enum: - GST_WITH_OTP - BANK_STATEMENT - CREDIT_UW_DOCUMENTS - DIRECTOR - DIRECTOR_DOCUMENTS - COMPANY_DOCUMENTS - DIRECTOR_ADDRESS_VERIFICATION udyamNumber: type: string udyamNumberMatchingStatus: type: string enum: - OPS_VERIFIED - MATCHED - NOT_MATCHED - PENDING cifId: type: string authorisedSignatories: type: array items: $ref: '#/components/schemas/AuthorisedSignatoryModel' cardIssueApprovalRemarks: type: string userGroupIds: type: array items: type: string cardRelationShipId: type: string leadOwner: type: string tenant: type: string enum: - ENKASH - SBM - TRANSCORP - AU_BANK - FINCARE - INDUSIND - ENKASH_PPI fdAmount: type: number advanceGstinVerificationFailureReason: type: string processingFeePercentage: type: number processingFeeCharged: type: boolean processingFeeChargedAmount: type: number processingFeeChargedOn: type: string format: date-time processingFeeRequestId: type: string companyAddressFromZoho: type: string companyPincodeFromZoho: type: string companyCityFromZoho: type: string companyStateFromZoho: type: string finalSignedContract: type: string finalDscSignedContractUrl: type: string auditCertificateUrl: type: string onboardingType: type: string approvedMerchantPricing: $ref: '#/components/schemas/ApprovedMerchantPricing' x-apidog-orders: - id - cardApplicationCrmData - applicationId - leadId - accountId - dealId - contactId - applicationStage - title - firstName - lastName - promoCode - source - utmSource - utmMedium - utmCampaign - queryParams - mobile - mobileOtp - mobileOtpSentDate - mobileOtpVerificationAttemptLeft - mobileOtpResendLeft - mobileVerified - email - emailOtp - emailOtpSentDate - emailOtpVerificationAttemptLeft - emailOtpResendLeft - emailVerified - userId - applyEnKashCard - typeOfCompany - cin - howBusinessFinanced - howWillEnKashCardUse - expectedMonthlySpendLimit - isLoggedInUserDirector - directorInfos - director - directorMobileOtp - directorMobileOtpSentDate - directorMobileVerified - legalName - companyType - program - product - enterpriseType - enterpriseSubType - gstin - pan - panOrGstinVerificationMethod - panEntity - gstinEntity - cinEntity - bank - accountNumber - ifsc - bankAccountName - bankAccountChangeAttemptLeft - pennyAmountVerified - pennyAmountVerifyAttemptLeft - pennyDrop - companyCreateStatus - company - agreeTnC - agreeCardTnC - cardIssued - failureReason - approvalStatus - approvalStatusRemarks - dataVerificationRemarks - approvalSubStatus - rejectionCategory - statusReasonCode - accountLockStatus - accountLockTime - accountLockStatusRemarks - remarks - kycStatus - kycStatusRemarks - proofOfIdentity - proofOfAddress - cardIssueApprovalStatus - creditLimit - anchor - channel - anchorProductCode - anchorKey - anchorApplicationId - anchorCreditApprovalId - anchorLoanId - anchorDataId - approvedOn - sanctionedLimitExpiryOn - rejectedOn - cardIssuedOn - createdOn - modifiedOn - eligibleLimit - unsubscribe - directorEditAllowed - discrepanciesMailSent - disableCommunications - offerValidUpto - skipBureauCheck - eligibilityCategory - eligibilityIndex - creditProviderId - productCode - cpBureauScore - creditAssessment - preVerificationRecommendedLimit - postVerificationRecommendedLimit - planMasterId - memoDetailsList - lastMemoScheduledDate - lastMemoAssignedAgent - bankStatementRequired - onBoardingStep - nextReminderDate - previousReminderDate - facebookEmail - linkedInEmail - instagramEmail - companyWeb - creditGuarantor - alternateMobileFamily - alternateMobileFriend - bureauCheckConsent - cardSignUpWhatsappFlow - companyName - companyCode - whatsAppOnBoardingCondition - nextOnBoardingStep - bankVerificationMethod - fdDetail - gstinData - gstinDataExcelDownloadUrl - gstinDataPdfDownloadUrl - allowedKycTypes - userGroups - accountAggregationUrl - linkGstWithOtpUrl - digitalLockerConsentUrl - originatedBy - averageSixMonthBalance - averageMonthlyBalance - currentFilingPeriod - averageFifteenMonthTurnOver - previousFilingPeriod - averageFifteenMonthTurnOverPreviousYear - accountAggregations - manualCreditProviderAssignedBy - autoAssignedCreditProvider - creditCardType - creditUnderWritingStepsDone - creditUnderWritingStepsDoneDate - onboardingDocumentsSubmitted - closedOn - applicationStages - cardAccountId - cardDashboardVisited - onboardingSteps - udyamNumber - udyamNumberMatchingStatus - cifId - authorisedSignatories - cardIssueApprovalRemarks - userGroupIds - cardRelationShipId - leadOwner - tenant - fdAmount - advanceGstinVerificationFailureReason - processingFeePercentage - processingFeeCharged - processingFeeChargedAmount - processingFeeChargedOn - processingFeeRequestId - companyAddressFromZoho - companyPincodeFromZoho - companyCityFromZoho - companyStateFromZoho - finalSignedContract - finalDscSignedContractUrl - auditCertificateUrl - onboardingType - approvedMerchantPricing x-apidog-ignore-properties: [] x-apidog-folder: '' ApprovedMerchantPricing: type: object properties: setupCost: type: string upi: type: string debitCardVisaLessThen2k: type: string debitCardVisaGreaterThen2k: type: string debitCardRupayLessThen2k: type: string debitCardRupayGreaterThan2k: type: string debitCardMastercardLessThan2k: type: string debitCardMastercardGreaterThan2k: type: string creditCardVisa: type: string creditCardRupay: type: string creditCardMaster: type: string corporateCardVisa: type: string corporateCardRupay: type: string corporateCardMastercard: type: string netBankingHdfc: type: string netBankingIcici: type: string netBankingKotak: type: string netBankingAxis: type: string netBankingSbi: type: string netBankingOtherBanks: type: string walletPaytm: type: string walletOthers: type: string prepaidCards: type: string internationalCards: type: string emandatePerTransactionFees: type: string emandateRegistrationFees: type: string setupChargesPayout: type: string amazonPayPayoutCharges: type: string neftCharges: type: string rtgsCharges: type: string impsLessThen1kCharges: type: string impsBetween1kAnd25kCharges: type: string impsGreaterThen25kCharges: type: string upiLessThen1kCharges: type: string upiBetween1kAnd25kCharges: type: string upiGreaterThen25kCharges: type: string x-apidog-orders: - setupCost - upi - debitCardVisaLessThen2k - debitCardVisaGreaterThen2k - debitCardRupayLessThen2k - debitCardRupayGreaterThan2k - debitCardMastercardLessThan2k - debitCardMastercardGreaterThan2k - creditCardVisa - creditCardRupay - creditCardMaster - corporateCardVisa - corporateCardRupay - corporateCardMastercard - netBankingHdfc - netBankingIcici - netBankingKotak - netBankingAxis - netBankingSbi - netBankingOtherBanks - walletPaytm - walletOthers - prepaidCards - internationalCards - emandatePerTransactionFees - emandateRegistrationFees - setupChargesPayout - amazonPayPayoutCharges - neftCharges - rtgsCharges - impsLessThen1kCharges - impsBetween1kAnd25kCharges - impsGreaterThen25kCharges - upiLessThen1kCharges - upiBetween1kAnd25kCharges - upiGreaterThen25kCharges x-apidog-ignore-properties: [] x-apidog-folder: '' AuthorisedSignatoryModel: type: object properties: name: type: string cifNumber: pattern: ^R[0-9]{9}$ type: string x-apidog-orders: - name - cifNumber x-apidog-ignore-properties: [] x-apidog-folder: '' AccountAggregation: type: object properties: id: type: integer format: int64 accountAggregationId: type: string cardApplication: *ref_13 status: type: string additionalStatus: type: string aggregationChannel: type: string netBankingAggregationError: $ref: '#/components/schemas/NetBankingAggregationError' statementUploadErrors: type: array items: $ref: '#/components/schemas/StatementUploadError' statementUploadDetails: type: array items: $ref: '#/components/schemas/StatementUploadDetail' netBankingAggregationDetails: type: array items: $ref: '#/components/schemas/NetBankingAggregationDetail' accountUID: type: string accountAggregationStatus: type: string enum: - INIT - FAILED - VERIFIED finBitSummaryResponseString: type: string finBitSummaryResponse: $ref: '#/components/schemas/FinBitSummaryResponse' bankStatementUrl: type: string companyId: type: string accountName: type: string accountNumber: type: string bankName: type: string accountType: type: string statementUpload: type: string mobile: type: string email: type: string pan: type: string currentBalance: type: number relationshipWithBank: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - accountAggregationId - cardApplication - status - additionalStatus - aggregationChannel - netBankingAggregationError - statementUploadErrors - statementUploadDetails - netBankingAggregationDetails - accountUID - accountAggregationStatus - finBitSummaryResponseString - finBitSummaryResponse - bankStatementUrl - companyId - accountName - accountNumber - bankName - accountType - statementUpload - mobile - email - pan - currentBalance - relationshipWithBank - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' FinBitSummaryResponse: type: object properties: bank_account: $ref: '#/components/schemas/BankAccount' sanctionedAmount: type: number missingMonths: type: array items: type: string monthWiseAnalysis: $ref: '#/components/schemas/MonthWiseAnalysis' openingAndClosingBalance: type: array items: $ref: '#/components/schemas/MonthlyBalanceDetail' incomePerMonth: type: array items: $ref: '#/components/schemas/MonthlyIncomeDetail' incomes: type: array items: $ref: '#/components/schemas/IncomeDetail' expensePerMonth: type: array items: $ref: '#/components/schemas/ExpenseDetail' message: type: string eodBalancePerMonth: type: array items: $ref: '#/components/schemas/BalanceDetail' loanRepaymentInstances: type: array items: $ref: '#/components/schemas/LoanRepaymentDetail' bounceTransactions: $ref: '#/components/schemas/BounceTransactions' dailyEODBalance: type: object additionalProperties: type: object additionalProperties: type: array items: $ref: '#/components/schemas/DailyBalanceDetail' x-apidog-orders: [] x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] topFiveFundsTransfer: type: object additionalProperties: type: array items: &ref_14 $ref: '#/components/schemas/FundDetail' x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] topFiveFundsReceived: type: object additionalProperties: type: array items: *ref_14 x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] transactions: type: array items: $ref: '#/components/schemas/TransactionDetail' fraudAnalytics: $ref: '#/components/schemas/FraudAnalytic' error: type: string x-apidog-orders: - bank_account - sanctionedAmount - missingMonths - monthWiseAnalysis - openingAndClosingBalance - incomePerMonth - incomes - expensePerMonth - message - eodBalancePerMonth - loanRepaymentInstances - bounceTransactions - dailyEODBalance - topFiveFundsTransfer - topFiveFundsReceived - transactions - fraudAnalytics - error x-apidog-ignore-properties: [] x-apidog-folder: '' FraudAnalytic: type: object properties: result: type: array items: $ref: '#/components/schemas/FraudAnalyticResult' summary: type: array items: $ref: '#/components/schemas/FraudAnalyticSummary' status: type: string fraudAnalyticStatus: $ref: '#/components/schemas/FraudAnalyticStatus' x-apidog-orders: - result - summary - status - fraudAnalyticStatus x-apidog-ignore-properties: [] x-apidog-folder: '' FraudAnalyticStatus: type: object properties: status: type: string reason: type: string x-apidog-orders: - status - reason x-apidog-ignore-properties: [] x-apidog-folder: '' FraudAnalyticSummary: type: object properties: ruleId: type: string rule: type: string detail: type: array items: $ref: '#/components/schemas/FraudAnalyticSummaryDetail' x-apidog-orders: - ruleId - rule - detail x-apidog-ignore-properties: [] x-apidog-folder: '' FraudAnalyticSummaryDetail: type: object properties: amount: type: number balanceAfterTransaction: type: number dateTime: type: string format: date description: type: string firstLevelCategory: type: string remark: type: string secondLevelCategory: type: string transactionNumber: type: string type: type: string valueDate: type: string format: date x-apidog-orders: - amount - balanceAfterTransaction - dateTime - description - firstLevelCategory - remark - secondLevelCategory - transactionNumber - type - valueDate x-apidog-ignore-properties: [] x-apidog-folder: '' FraudAnalyticResult: type: object properties: category: type: string rule: type: string ruleId: type: string ruleName: type: string status: type: string x-apidog-orders: - category - rule - ruleId - ruleName - status x-apidog-ignore-properties: [] x-apidog-folder: '' TransactionDetail: type: object properties: amount: type: number balanceAfterTransaction: type: number bank: type: string category: type: string dateTime: type: string format: date description: type: string merchantType: type: string partyName: type: string remark: type: string transactionNumber: type: string transactionSubCategory: type: string type: type: string valueDate: type: string format: date x-apidog-orders: - amount - balanceAfterTransaction - bank - category - dateTime - description - merchantType - partyName - remark - transactionNumber - transactionSubCategory - type - valueDate x-apidog-ignore-properties: [] x-apidog-folder: '' FundDetail: type: object properties: amount: type: number description: type: string category: type: string x-apidog-orders: - amount - description - category x-apidog-ignore-properties: [] x-apidog-folder: '' DailyBalanceDetail: type: object properties: openingBalance: type: number closingBalance: type: number x-apidog-orders: - openingBalance - closingBalance x-apidog-ignore-properties: [] x-apidog-folder: '' BounceTransactions: type: object properties: inwardChequeOrEcsBounceMonthwise: type: object additionalProperties: type: array items: &ref_15 $ref: '#/components/schemas/ChequeBounceDetail' x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] outwardChequeBounceMonthwise: type: object additionalProperties: type: array items: *ref_15 x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] x-apidog-orders: - inwardChequeOrEcsBounceMonthwise - outwardChequeBounceMonthwise x-apidog-ignore-properties: [] x-apidog-folder: '' ChequeBounceDetail: type: object properties: date: type: string amount: type: number description: type: string balance: type: number category: type: string transactionSubCategory: type: string remark: type: string transactionType: type: string bank: type: string x-apidog-orders: - date - amount - description - balance - category - transactionSubCategory - remark - transactionType - bank x-apidog-ignore-properties: [] x-apidog-folder: '' LoanRepaymentDetail: type: object properties: amount: type: string balanceAfterTransaction: type: number bank: type: string category: type: string dateTime: type: string format: date-time description: type: string merchantType: type: string partyName: type: string transactionSubCategory: type: string transactionType: type: string x-apidog-orders: - amount - balanceAfterTransaction - bank - category - dateTime - description - merchantType - partyName - transactionSubCategory - transactionType x-apidog-ignore-properties: [] x-apidog-folder: '' BalanceDetail: type: object properties: monthAndYear: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] minBalance: type: number maxBalance: type: number averageBalance: type: number bank: type: string x-apidog-orders: - monthAndYear - minBalance - maxBalance - averageBalance - bank x-apidog-ignore-properties: [] x-apidog-folder: '' ExpenseDetail: type: object properties: amount: type: number bank: type: string category: type: string date: type: string format: date-time description: type: string merchantType: type: string mode: type: string monthAndYear: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] partyName: type: string purpose: type: string total: type: number x-apidog-orders: - amount - bank - category - date - description - merchantType - mode - monthAndYear - partyName - purpose - total x-apidog-ignore-properties: [] x-apidog-folder: '' IncomeDetail: type: object properties: amount: type: number balanceAfterTransaction: type: number bank: type: string category: type: string date: type: string format: date-time description: type: string salary: type: boolean salaryCheck: type: boolean mode: type: string monthAndYear: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] partyName: type: string purpose: type: string total: type: number transactionType: type: string x-apidog-orders: - amount - balanceAfterTransaction - bank - category - date - description - salary - salaryCheck - mode - monthAndYear - partyName - purpose - total - transactionType x-apidog-ignore-properties: [] x-apidog-folder: '' MonthlyIncomeDetail: type: object properties: date: type: string format: date-time amount: type: number description: type: string salary: type: boolean bank: type: string x-apidog-orders: - date - amount - description - salary - bank x-apidog-ignore-properties: [] x-apidog-folder: '' MonthlyBalanceDetail: type: object properties: monthAndYear: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] openingBalance: type: number closingBalance: type: number x-apidog-orders: - monthAndYear - openingBalance - closingBalance x-apidog-ignore-properties: [] x-apidog-folder: '' MonthWiseAnalysis: type: object properties: monthlyAvgBal: &ref_16 $ref: '#/components/schemas/AverageBalance' maxBalance: *ref_16 minBalance: *ref_16 cashDeposit: *ref_16 cashWithdrawals: *ref_16 chqDeposit: *ref_16 chqIssues: *ref_16 nonCashCredit: *ref_16 credits: *ref_16 debits: *ref_16 inwBounce: *ref_16 outwBounce: *ref_16 penaltyCharges: *ref_16 interestPaid: *ref_16 overdrawnPeriod: *ref_16 ecsOrNach: *ref_16 peakUtilization: *ref_16 averageUtilizationOD_CC: *ref_16 totalNetDebit: *ref_16 totalNetCredit: *ref_16 interestReceived: *ref_16 selfWithdraw: *ref_16 selfDeposit: *ref_16 neftReturn: *ref_16 interestServiceDelay: *ref_16 loanRepayment: *ref_16 emiMoratorium: *ref_16 inwardChequeBouncePercentage: *ref_16 inwardBouncePercentage: *ref_16 maxCreditGap: *ref_16 loanCredit: *ref_16 creditCardPayment: *ref_16 debitInternalTransaction: *ref_16 creditInternalTransaction: *ref_16 minCredits: *ref_16 maxCredits: *ref_16 salary: *ref_16 nonSalaryCredit: *ref_16 expense: *ref_16 bankCharges: *ref_16 digitalTransfer: $ref: '#/components/schemas/DigitalTransfer' x-apidog-orders: - monthlyAvgBal - maxBalance - minBalance - cashDeposit - cashWithdrawals - chqDeposit - chqIssues - nonCashCredit - credits - debits - inwBounce - outwBounce - penaltyCharges - interestPaid - overdrawnPeriod - ecsOrNach - peakUtilization - averageUtilizationOD_CC - totalNetDebit - totalNetCredit - interestReceived - selfWithdraw - selfDeposit - neftReturn - interestServiceDelay - loanRepayment - emiMoratorium - inwardChequeBouncePercentage - inwardBouncePercentage - maxCreditGap - loanCredit - creditCardPayment - debitInternalTransaction - creditInternalTransaction - minCredits - maxCredits - salary - nonSalaryCredit - expense - bankCharges - digitalTransfer x-apidog-ignore-properties: [] x-apidog-folder: '' DigitalTransfer: type: object properties: digitalTransferDebit: *ref_16 digitalTransferCredit: *ref_16 x-apidog-orders: - digitalTransferDebit - digitalTransferCredit x-apidog-ignore-properties: [] x-apidog-folder: '' AverageBalance: type: object properties: average: type: number monthlyDetails: type: array items: $ref: '#/components/schemas/MonthlyDetail' total: type: number totalValue: type: number x-apidog-orders: - average - monthlyDetails - total - totalValue x-apidog-ignore-properties: [] x-apidog-folder: '' MonthlyDetail: type: object properties: monthYear: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] total: type: number value: type: number x-apidog-orders: - monthYear - total - value x-apidog-ignore-properties: [] x-apidog-folder: '' BankAccount: type: object properties: accountName: type: string jointHolderName: type: array items: type: string accountNumber: type: string bankName: type: string accountType: type: string statementUpload: type: string mobile: type: string email: type: string pan: type: string currentBalance: type: number address: type: string relationshipWithBank: type: string ifsc: type: string x-apidog-orders: - accountName - jointHolderName - accountNumber - bankName - accountType - statementUpload - mobile - email - pan - currentBalance - address - relationshipWithBank - ifsc x-apidog-ignore-properties: [] x-apidog-folder: '' NetBankingAggregationDetail: type: object properties: bank: type: string accountUID: type: string accountHolderName: type: string x-apidog-orders: - bank - accountUID - accountHolderName x-apidog-ignore-properties: [] x-apidog-folder: '' StatementUploadDetail: type: object properties: bank: type: string accountUID: type: string accountHolderName: type: string accountNumber: type: string accountValidation: type: string errorInfo: type: array items: $ref: '#/components/schemas/ErrorInfo' x-apidog-orders: - bank - accountUID - accountHolderName - accountNumber - accountValidation - errorInfo x-apidog-ignore-properties: [] x-apidog-folder: '' ErrorInfo: type: object properties: errorCode: type: string errorMessage: type: string x-apidog-orders: - errorCode - errorMessage x-apidog-ignore-properties: [] x-apidog-folder: '' StatementUploadError: type: object properties: fileName: type: string failureReason: type: string message: type: string x-apidog-orders: - fileName - failureReason - message x-apidog-ignore-properties: [] x-apidog-folder: '' NetBankingAggregationError: type: object properties: failureReason: type: string bank: type: string x-apidog-orders: - failureReason - bank x-apidog-ignore-properties: [] x-apidog-folder: '' GstinData: type: object properties: id: type: integer format: int64 gstinDataId: type: string gstinDataJson: type: string companyId: type: string uniqueId: type: string sendOtpResponseRequestId: type: string submitOtpResponseRequestId: type: string customerAndVendorCreatedFromGstinData: type: boolean gstin: type: string gstinUploadedFileUrl: type: array items: type: string excelDownloadUrl: type: string pdfDownloadUrl: type: string failureReason: type: string reportType: type: string address: type: string gstinCancellation: type: string complianceRating: type: string categoryOfBusiness: type: string defaulter: type: boolean legalName: type: string additionalPlaceOfBusiness: type: string email: type: string natureOfBusinessAtPermanentAddress: type: string completeAddress: type: string mobileNumber: type: string addressLastUpdated: type: string format: date pinCode: type: string district: type: string state: type: string active: type: boolean contactedName: type: string contactedMobile: type: string contactedEmail: type: string dateOfRegistration: type: string format: date ageOfBusiness: type: integer format: int32 documentDetails: type: string natureOfBusiness: type: string grossTurnoverLastYear: type: number netTurnoverLastYear: type: number totalInvoiceLastYear: type: integer format: int32 totalCustomerLastYear: type: integer format: int32 grossTurnoverCurrentYear: type: number filingStatus: type: boolean monthWiseSummary: type: array items: $ref: '#/components/schemas/MonthWiseSummary' partyWisePurchaseDetails: type: array items: $ref: '#/components/schemas/PartyWisePurchaseDetails' topTenCustomers: type: array items: $ref: '#/components/schemas/TopTenCustomer' businessSummary: $ref: '#/components/schemas/BusinessSummary' createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - gstinDataId - gstinDataJson - companyId - uniqueId - sendOtpResponseRequestId - submitOtpResponseRequestId - customerAndVendorCreatedFromGstinData - gstin - gstinUploadedFileUrl - excelDownloadUrl - pdfDownloadUrl - failureReason - reportType - address - gstinCancellation - complianceRating - categoryOfBusiness - defaulter - legalName - additionalPlaceOfBusiness - email - natureOfBusinessAtPermanentAddress - completeAddress - mobileNumber - addressLastUpdated - pinCode - district - state - active - contactedName - contactedMobile - contactedEmail - dateOfRegistration - ageOfBusiness - documentDetails - natureOfBusiness - grossTurnoverLastYear - netTurnoverLastYear - totalInvoiceLastYear - totalCustomerLastYear - grossTurnoverCurrentYear - filingStatus - monthWiseSummary - partyWisePurchaseDetails - topTenCustomers - businessSummary - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' BusinessSummary: type: object properties: netTurnoverPreviousYear: type: number format: double grossTurnoverCurrentYear: type: number format: double balancePayableCurrentYear: type: number format: double totalInvoicesCurrentYear: type: number format: double netTurnoverCurrentYear: type: number format: double liabilityPaidCurrentYear: type: number format: double liabilityPayableCurrentYear: type: number format: double x-apidog-orders: - netTurnoverPreviousYear - grossTurnoverCurrentYear - balancePayableCurrentYear - totalInvoicesCurrentYear - netTurnoverCurrentYear - liabilityPaidCurrentYear - liabilityPayableCurrentYear x-apidog-ignore-properties: [] x-apidog-folder: '' TopTenCustomer: type: object properties: name: type: string pan: type: string share: type: string totalRecords: type: string totalTax: type: string totalValue: type: string x-apidog-orders: - name - pan - share - totalRecords - totalTax - totalValue x-apidog-ignore-properties: [] x-apidog-folder: '' PartyWisePurchaseDetails: type: object properties: intraOrganisationTransaction: type: boolean minimumTransaction: type: number pan: type: string recurringParty: type: boolean relatedParty: type: boolean thirdParty: type: boolean x-apidog-orders: - intraOrganisationTransaction - minimumTransaction - pan - recurringParty - relatedParty - thirdParty x-apidog-ignore-properties: [] x-apidog-folder: '' MonthWiseSummary: type: object properties: returnPeriod: type: string customerTurnover: type: number supplierTurnover: type: number salesTotalInvoice: type: number salesTotalCustomer: type: number x-apidog-orders: - returnPeriod - customerTurnover - supplierTurnover - salesTotalInvoice - salesTotalCustomer x-apidog-ignore-properties: [] x-apidog-folder: '' FdDetail: type: object properties: id: type: integer format: int64 fdDetailId: type: string maritalStatus: type: string enum: - SINGLE - MARRIED - OTHERS employmentIndustry: type: string enum: - AGRICULTURE_FOOD_NATURAL_RESOURCES - ARCHITECTURE_AND_CONSTRUCTION - ARTS_AUDIO_OR_VIDEO_TECHNOLOGY_AND_COMMUNICATIONS - BUSINESS_MANAGEMENT_AND_ADMINISTRATION - EDUCATION_AND_TRAINING - FINANCE - GOVERNMENT_AND_PUBLIC_ADMINISTRATION - HEALTH_SCIENCE - HOSPITALITY_AND_TOURISM - HUMAN_SERVICES - INFORMATION_TECHNOLOGY - LAW_PUBLIC_SAFETY_CORRECTIONS_AND_SECURITY - MANUFACTURING - MARKETING_SALES_AND_SERVICE - SCIENCE_TECHNOLOGY_ENGINEERING_AND_MATHEMATICS - TRANSPORTATION_DISTRIBUTION_AND_LOGISTICS employmentType: type: string enum: - EMPLOYED - UNEMPLOYED - ENTREPRENEUR - PUBLIC_SECTOR_EMPLOYEE - FREELANCER - HOUSEWORK - APPRENTICE - RETIRED - STUDENT - SELF_EMPLOYED - MILITARY_OR_COMMUNITY_SERVICE requiredCreditLimit: type: number virtualAccountNumber: type: string panValidated: type: boolean kycUploaded: type: boolean cardApplication: *ref_13 fdPaymentHistories: uniqueItems: true type: array items: $ref: '#/components/schemas/FdPaymentHistory' fdStatus: type: string enum: - PENDING - SUCCESS fdCreationVerifiedDate: type: string format: date-time accountNo: type: string schemeCode: type: string schemeType: type: string accountCurrency: type: string accountOpenDate: type: string format: date modeOfOperation: type: string bankAccountStatus: type: string customerId: type: string customerName: type: string netInterestRate: type: number totalInterestAmount: type: number initialDepositAmount: type: number maturityAmount: type: number depositTerm: type: integer format: int32 maturityDate: type: string format: date repaymentAccountId: type: string fdCreatedOnFromZoho: type: string format: date createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - fdDetailId - maritalStatus - employmentIndustry - employmentType - requiredCreditLimit - virtualAccountNumber - panValidated - kycUploaded - cardApplication - fdPaymentHistories - fdStatus - fdCreationVerifiedDate - accountNo - schemeCode - schemeType - accountCurrency - accountOpenDate - modeOfOperation - bankAccountStatus - customerId - customerName - netInterestRate - totalInterestAmount - initialDepositAmount - maturityAmount - depositTerm - maturityDate - repaymentAccountId - fdCreatedOnFromZoho - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' FdPaymentHistory: type: object properties: id: type: integer format: int64 fdPaymentHistoryId: type: string txnDate: type: string format: date amount: type: number senderAccountName: type: string senderAccountNumber: type: string transactionReferenceNumber: type: string fdDetail: *ref_17 fdStatus: type: string enum: - PENDING - SUCCESS createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - fdPaymentHistoryId - txnDate - amount - senderAccountName - senderAccountNumber - transactionReferenceNumber - fdDetail - fdStatus - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' CreditGuarantor: type: object properties: id: type: integer format: int64 name: type: string pan: type: string dateOfBirth: type: string format: date aadhaar: &ref_19 $ref: '#/components/schemas/Aadhaar' deleted: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - name - pan - dateOfBirth - aadhaar - deleted - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' Aadhaar: type: object properties: id: type: integer format: int64 shareCode: type: string aadhaarXml: type: string aadhaarFrontUrl: type: string aadhaarBackUrl: type: string status: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK failureReason: type: string nameOnAadhaar: type: string dobOnAadhaar: type: string format: date addressOnAadhaar: type: string gender: type: string maskedAadhaarNumber: type: string generatedDateTime: type: string format: date-time imageFromAadhaar: type: string remarks: type: string aadhaarValidity: type: boolean aadhaarData: type: string aadhaarFrontData: type: string aadhaarBackData: type: string serviceProvider: type: string enum: - AB - KZ - MP createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - shareCode - aadhaarXml - aadhaarFrontUrl - aadhaarBackUrl - status - failureReason - nameOnAadhaar - dobOnAadhaar - addressOnAadhaar - gender - maskedAadhaarNumber - generatedDateTime - imageFromAadhaar - remarks - aadhaarValidity - aadhaarData - aadhaarFrontData - aadhaarBackData - serviceProvider - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' MemoDetails: type: object properties: id: type: integer format: int64 cardApplication: *ref_13 title: type: string description: type: string scheduledDate: type: string format: date-time attachmentUrl: type: string createdOn: type: string format: date-time createdBy: type: integer format: int64 assignedAgent: type: string x-apidog-orders: - id - cardApplication - title - description - scheduledDate - attachmentUrl - createdOn - createdBy - assignedAgent x-apidog-ignore-properties: [] x-apidog-folder: '' CreditAssessment: type: object properties: id: type: integer format: int64 businessVintageEnKashScore: type: integer format: int32 businessVintageAmazonScore: type: integer format: int32 customerAgeScore: type: integer format: int32 bureauScore: type: integer format: int32 salesStabilityScore: type: integer format: int32 longTermPayoutsScore: type: number shortTermPayoutsScore: type: number payoutScore: type: number salesReturnScore: type: integer format: int32 cancellationScore: type: integer format: int32 overallScore: type: number averagePayout: type: number recommendedLimit: type: number constitutionTypeScore: type: integer format: int32 sixMonthIncomeScore: type: integer format: int32 chequeBounceScore: type: integer format: int32 burnRateScore: type: integer format: int32 gstinRegistrationScore: type: integer format: int32 totalSalesScore: type: integer format: int32 salesGrowthScore: type: integer format: int32 numberOfSalesStateScore: type: integer format: int32 numberOfCustomerScore: type: integer format: int32 businessVintageInMonths: type: integer format: int64 constitutionType: type: string sixMonthIncome: type: number totalChequeBounced: type: integer format: int32 averageExpensePerMonth: type: number closingBalance: type: number burnRate: type: number averageLast2MonthBalance: type: number gstinRegistrationDate: type: string format: date numberOfStateWiseSales: type: integer format: int32 totalCustomers: type: integer format: int32 previousYearTurnOver: type: number currentYearTurnOver: type: number salesGrowthRate: type: number bureauCreditScore: type: integer format: int32 customerDateOfBirth: type: string format: date lastTransactionScore: type: integer format: int32 numberOfTransactionScore: type: integer format: int32 totalTransactionAmountScore: type: integer format: int32 averageTransactionAmountScore: type: integer format: int32 averageSaleTurnOver: type: number monthsFromLastPayment: type: integer format: int64 numberOfTransaction: type: integer format: int64 totalTransactionAmount: type: number averageTransactionAmount: type: number eligibility: type: number failureReasons: type: array items: type: string createdBy: type: string modifiedBy: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - businessVintageEnKashScore - businessVintageAmazonScore - customerAgeScore - bureauScore - salesStabilityScore - longTermPayoutsScore - shortTermPayoutsScore - payoutScore - salesReturnScore - cancellationScore - overallScore - averagePayout - recommendedLimit - constitutionTypeScore - sixMonthIncomeScore - chequeBounceScore - burnRateScore - gstinRegistrationScore - totalSalesScore - salesGrowthScore - numberOfSalesStateScore - numberOfCustomerScore - businessVintageInMonths - constitutionType - sixMonthIncome - totalChequeBounced - averageExpensePerMonth - closingBalance - burnRate - averageLast2MonthBalance - gstinRegistrationDate - numberOfStateWiseSales - totalCustomers - previousYearTurnOver - currentYearTurnOver - salesGrowthRate - bureauCreditScore - customerDateOfBirth - lastTransactionScore - numberOfTransactionScore - totalTransactionAmountScore - averageTransactionAmountScore - averageSaleTurnOver - monthsFromLastPayment - numberOfTransaction - totalTransactionAmount - averageTransactionAmount - eligibility - failureReasons - createdBy - modifiedBy - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' PennyDrop: type: object properties: id: type: integer format: int64 companyId: type: integer format: int64 parentCompanyId: type: integer format: int64 transactionId: type: string requestType: type: string beneficiaryAccountNumber: type: string beneficiaryIfsc: type: string amount: type: number remarks: type: string tranInitChannel: type: string checksum: type: string rrn: type: string beneficiaryName: type: string responseCode: type: string responseReason: type: string status: type: string messageId: type: string retryLeft: type: integer format: int32 payoutMode: type: string enum: - IMPS - NEFT - RTGS - UPI runCheck: type: boolean pennyDropProvider: type: string enum: - KOTAK - KARZA createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - companyId - parentCompanyId - transactionId - requestType - beneficiaryAccountNumber - beneficiaryIfsc - amount - remarks - tranInitChannel - checksum - rrn - beneficiaryName - responseCode - responseReason - status - messageId - retryLeft - payoutMode - runCheck - pennyDropProvider - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' Cin: type: object properties: id: type: integer format: int64 cin: type: string parentCompanyId: type: integer format: int64 status: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK retryLeft: type: integer format: int32 failureReason: type: string cinFromCompanyNameStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK cinFromCompanyNameRetryLeft: type: integer format: int32 failureReasonCinFromCompanyName: type: string mcaSignatoriesStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK mcaSignatoriesRetryLeft: type: integer format: int32 failureReasonMcaSignatories: type: string companyName: type: string listed: type: string companyStatus: type: string rocId: type: string rocCode: type: string registrationNumber: type: string companyCategory: type: string companySubCategory: type: string classOfCompany: type: string authorisedCapital: type: number paidUpCapital: type: number numberOfMembers: type: string dateOfIncorporation: type: string format: date registeredAddress: type: string registeredAddressPincode: type: string registeredAddressCity: type: string registeredAddressState: type: string email: type: string suspendedAtStockExchange: type: string dateOfBalanceSheet: type: string format: date dateOfLastAgm: type: string format: date directors: type: array items: $ref: '#/components/schemas/Din' cinData: type: string cinFromCompanyNameData: type: string mcaSignatoriesData: type: string kycServiceProvider: type: string enum: - AB - KZ - MP createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - cin - parentCompanyId - status - retryLeft - failureReason - cinFromCompanyNameStatus - cinFromCompanyNameRetryLeft - failureReasonCinFromCompanyName - mcaSignatoriesStatus - mcaSignatoriesRetryLeft - failureReasonMcaSignatories - companyName - listed - companyStatus - rocId - rocCode - registrationNumber - companyCategory - companySubCategory - classOfCompany - authorisedCapital - paidUpCapital - numberOfMembers - dateOfIncorporation - registeredAddress - registeredAddressPincode - registeredAddressCity - registeredAddressState - email - suspendedAtStockExchange - dateOfBalanceSheet - dateOfLastAgm - directors - cinData - cinFromCompanyNameData - mcaSignatoriesData - kycServiceProvider - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' Din: type: object properties: din: type: string name: type: string designation: type: string dateOfAppointment: type: string format: date-time dscRegistered: type: string dscExpiryDate: type: string address: type: string dateOfBirth: type: string format: date-time fatherName: type: string x-apidog-orders: - din - name - designation - dateOfAppointment - dscRegistered - dscExpiryDate - address - dateOfBirth - fatherName x-apidog-ignore-properties: [] x-apidog-folder: '' Gstin: type: object properties: id: type: integer format: int64 gstin: type: string parentCompanyId: type: integer format: int64 status: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK retryLeft: type: integer format: int32 failureReason: type: string gstinFromPanStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK gstinFromPanRetryLeft: type: integer format: int32 failureReasonGstinFromPan: type: string legalNameOfBusiness: type: string tradeName: type: string companyName: type: string centreJurisdiction: type: string stateJurisdiction: type: string dateOfRegistration: type: string format: date constitutionOfBusiness: type: string taxPayerType: type: string gstinStatus: type: string dateOfCancellation: type: string format: date dateOfLastUpdated: type: string format: date natureOfBusinessActivities: type: array items: type: string natureOfBusiness: type: string proprietors: type: array items: type: string division: type: string segment: type: string subSegment: type: string fieldVisitConducted: type: string address: type: string email: type: string mobile: type: string runCheck: type: boolean gstinData: type: string gstinFromPanData: type: string kycServiceProvider: type: string enum: - AB - KZ - MP aggregateTurnovers: type: array items: $ref: '#/components/schemas/AggregateTurnoverModel' aggregateTurnover: type: string aggregateTurnoverFinancialYear: type: string aadhaarAuthenticated: type: boolean transactionDelays: type: array items: $ref: '#/components/schemas/TransactionDelayModel' api: type: string enum: - AUTH_BRIDGE - KARZA - PAN_AUTHENTICATION - PAN_PROFILE - GSTIN_AUTHENTICATION - GSTIN_DETAIL - GSTIN_AUTHENTICATION_ADDITIONAL_DATA - MOBILE_AUTHENTICATION - MOBILE_AUTHENTICATION_STATUS - MOBILE_AUTHENTICATION_FETCH_DETAILS - GSTIN_FROM_PAN - CIN_FROM_COMPANY_NAME - CIN_SERACH - MAC_SIGNATORIES - BANK_DETAIL_VERIFICATION - AADHAAR_XML_AUTHENTICATION - KYC_OCR - LIVENESS_DETECTION - FACE_MATCH - KARZA_ITR_BUSINESS - UDYAM_FETCH - KARZA_FUNDS_RAISED - KARZA_MCA_DOC - KARZA_OTP_SEND - KARZA_OTP_SUBMIT - KARZA_OTP_WEBHOOK - SIGNZY_CREATE_CONTRACT - SIGNZY_CONTRACT_STATUS - SIGNZY_DIGITAL_LOCKER_ACCESS_URL - SIGNZY_DIGITAL_LOCKER_FETCH_FILE - SANCTION_SCREENING companyType: type: string filingFinancialYear: type: string defaulter: type: boolean topTenClients: type: string numberOfStates: type: integer format: int32 relatedPartySalesPercentage: type: number relatedPartyPurchasePercentage: type: number vintage: type: integer format: int32 numberOfCustomers: type: integer format: int32 percentTaxInCashFY: type: string pan: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time ekycVerified: type: string x-apidog-orders: - id - gstin - parentCompanyId - status - retryLeft - failureReason - gstinFromPanStatus - gstinFromPanRetryLeft - failureReasonGstinFromPan - legalNameOfBusiness - tradeName - companyName - centreJurisdiction - stateJurisdiction - dateOfRegistration - constitutionOfBusiness - taxPayerType - gstinStatus - dateOfCancellation - dateOfLastUpdated - natureOfBusinessActivities - natureOfBusiness - proprietors - division - segment - subSegment - fieldVisitConducted - address - email - mobile - runCheck - gstinData - gstinFromPanData - kycServiceProvider - aggregateTurnovers - aggregateTurnover - aggregateTurnoverFinancialYear - aadhaarAuthenticated - transactionDelays - api - companyType - filingFinancialYear - defaulter - topTenClients - numberOfStates - relatedPartySalesPercentage - relatedPartyPurchasePercentage - vintage - numberOfCustomers - percentTaxInCashFY - pan - createdOn - modifiedOn - ekycVerified x-apidog-ignore-properties: [] x-apidog-folder: '' TransactionDelayModel: type: object properties: returnYearMonth: type: string revisedDueDateOfFiling: type: string dateOfFiling: type: string noOfDaysOfDelay: type: integer format: int32 returnType: type: string arn: type: string x-apidog-orders: - returnYearMonth - revisedDueDateOfFiling - dateOfFiling - noOfDaysOfDelay - returnType - arn x-apidog-ignore-properties: [] x-apidog-folder: '' AggregateTurnoverModel: type: object properties: turnover: type: string financialYear: type: string x-apidog-orders: - turnover - financialYear x-apidog-ignore-properties: [] x-apidog-folder: '' Pan: type: object properties: id: type: integer format: int64 pan: type: string parentCompanyId: type: integer format: int64 status: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK retryLeft: type: integer format: int32 name: type: string firstName: type: string middleName: type: string lastName: type: string panData: type: string failureReason: type: string kycServiceProvider: type: string enum: - AB - KZ - MP runCheck: type: boolean api: type: string enum: - AUTH_BRIDGE - KARZA - PAN_AUTHENTICATION - PAN_PROFILE - GSTIN_AUTHENTICATION - GSTIN_DETAIL - GSTIN_AUTHENTICATION_ADDITIONAL_DATA - MOBILE_AUTHENTICATION - MOBILE_AUTHENTICATION_STATUS - MOBILE_AUTHENTICATION_FETCH_DETAILS - GSTIN_FROM_PAN - CIN_FROM_COMPANY_NAME - CIN_SERACH - MAC_SIGNATORIES - BANK_DETAIL_VERIFICATION - AADHAAR_XML_AUTHENTICATION - KYC_OCR - LIVENESS_DETECTION - FACE_MATCH - KARZA_ITR_BUSINESS - UDYAM_FETCH - KARZA_FUNDS_RAISED - KARZA_MCA_DOC - KARZA_OTP_SEND - KARZA_OTP_SUBMIT - KARZA_OTP_WEBHOOK - SIGNZY_CREATE_CONTRACT - SIGNZY_CONTRACT_STATUS - SIGNZY_DIGITAL_LOCKER_ACCESS_URL - SIGNZY_DIGITAL_LOCKER_FETCH_FILE - SANCTION_SCREENING issueDate: type: string dob: type: string mobile: type: string email: type: string address: type: string city: type: string state: type: string pinCode: type: string gender: type: string country: type: string profileMatch: type: array items: type: string director: type: boolean soleProp: type: boolean salaried: type: boolean aadhaarLinked: type: boolean aadhaarMatch: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time panUrl: type: string x-apidog-orders: - id - pan - parentCompanyId - status - retryLeft - name - firstName - middleName - lastName - panData - failureReason - kycServiceProvider - runCheck - api - issueDate - dob - mobile - email - address - city - state - pinCode - gender - country - profileMatch - director - soleProp - salaried - aadhaarLinked - aadhaarMatch - createdOn - modifiedOn - panUrl x-apidog-ignore-properties: [] x-apidog-folder: '' Director: type: object properties: id: type: integer format: int64 title: type: string enum: - Mr - Mrs - Ms name: type: string firstName: type: string middleName: type: string lastName: type: string pan: type: string dateOfBirth: type: string format: date email: type: string mobile: type: string addressOne: type: string addressTwo: type: string city: type: string state: type: string pinCode: type: string status: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK retryLeft: type: integer format: int32 requestId: type: string inquiryNumber: type: string userId: type: integer format: int64 category: type: string statusCode: type: string panEntity: *ref_18 passport: $ref: '#/components/schemas/Passport' aadhaar: *ref_19 bureauProvider: type: string enum: - CRIF - EQUIFAX bureauReason: type: string bureauScore: type: string mothersName: type: string fatherOrSpouseName: type: string citizenshipStatus: type: string enum: - RESIDENT_INDIAN - OTHERS bureauConsentMailSentOn: type: string format: date-time bureauConsentReceivedOn: type: string format: date-time bureauConsentDetails: $ref: '#/components/schemas/ClientDetail' runCheck: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - title - name - firstName - middleName - lastName - pan - dateOfBirth - email - mobile - addressOne - addressTwo - city - state - pinCode - status - retryLeft - requestId - inquiryNumber - userId - category - statusCode - panEntity - passport - aadhaar - bureauProvider - bureauReason - bureauScore - mothersName - fatherOrSpouseName - citizenshipStatus - bureauConsentMailSentOn - bureauConsentReceivedOn - bureauConsentDetails - runCheck - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' ClientDetail: type: object properties: referer: type: string fullURL: type: string clientIpAddr: type: string clientOS: type: string clientBrowser: type: string userAgent: type: string x-apidog-orders: - referer - fullURL - clientIpAddr - clientOS - clientBrowser - userAgent x-apidog-ignore-properties: [] x-apidog-folder: '' Passport: type: object properties: id: type: integer format: int64 dobOnPassport: type: string format: date givenName: type: string surname: type: string passportNumber: type: string placeOfBirth: type: string address: type: string fileNum: type: string father: type: string mother: type: string addressLine1: type: string addressLine2: type: string city: type: string pin: type: string state: type: string passportUrl: type: string passportFrontUrl: type: string passportBackUrl: type: string gender: type: string passportData: type: string passportFrontData: type: string passportBackData: type: string serviceProvider: type: string enum: - AB - KZ - MP createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - dobOnPassport - givenName - surname - passportNumber - placeOfBirth - address - fileNum - father - mother - addressLine1 - addressLine2 - city - pin - state - passportUrl - passportFrontUrl - passportBackUrl - gender - passportData - passportFrontData - passportBackData - serviceProvider - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' DirectorInfo: type: object properties: id: type: integer format: int64 cardApplication: *ref_13 title: type: string enum: - Mr - Mrs - Ms designation: type: string name: type: string mobile: type: string dateOfBirth: type: string format: date pan: type: string address: type: string city: type: string state: type: string pinCode: type: string aus: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - cardApplication - title - designation - name - mobile - dateOfBirth - pan - address - city - state - pinCode - aus - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' CardApplicationCrmData: type: object properties: id: type: integer format: int64 cardApplication: *ref_13 pointOfContactName: type: string pointOfContactAddress: type: string proposedCashback: type: number zohoApplicationStage: type: string purchaseCreditCardType: type: string appliedCreditLimit: type: number businessPremiseOwnership: type: string durationOfStay: type: object properties: year: type: integer format: int32 month: type: string enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER monthValue: type: integer format: int32 leapYear: type: boolean x-apidog-orders: - year - month - monthValue - leapYear x-apidog-ignore-properties: [] industry: type: string currentAddressLine: type: string currentPinCode: type: string currentCity: type: string currentState: type: string currentBusinessPremiseOwnership: type: string classOfActivity: type: string businessCode: type: string directorCurrentResidenceAddress: type: string directorCurrentResidencePinCode: type: string directorDesignation: type: string isDirectorAusOrPm: type: boolean secondaryDirectorPanCard: type: string secondaryDirectorMobileNumber: type: string secondaryDirectorName: type: string secondaryDirectorTitle: type: string enum: - Mr - Mrs - Ms secondaryDirectorDOB: type: string format: date secondaryDirectorGender: type: string secondaryDirectorCurrentResidenceAddress: type: string secondaryDirectorCurrentResidencePinCode: type: string secondaryDirectorCurrentResidenceCity: type: string secondaryDirectorCurrentResidenceState: type: string secondaryDirectorDesignation: type: string secondaryDirectorPermanentResidenceAddress: type: string secondaryDirectorPermanentResidenceAddressPinCode: type: string companyEmbosserName: type: string embosserMobileNumber: type: string embosserEmail: type: string embosserTelephoneNumber: type: string embosserCommunicationAddress: type: string financialYear: type: string dscr: type: number financialTurnover: type: number gstTurnover: type: number grossProfit: type: number profitBeforeTax: type: number tax: type: number depreciation: type: number shareCapital: type: number reserveAndSurplus: type: number natureOfBusinessFromZoho: type: string loanAmountApplied: type: number profitability: type: string netWorth: type: string constitutionTypeFromZoho: type: string eligibilityFromZoho: type: number rateOfInterest: type: number acceptanceLetterDetailsUpdated: type: boolean filingPeriodFromZoho: type: string businessCategory: type: string businessSubCategory: type: string lineOfBusiness: type: string mcc: type: string purposeOfService: type: string completeCompanyAddressFromZoho: type: string businessEntityType: type: string enkashSignerName: type: string enkashSignerDesignation: type: string enkashSignerEmail: type: string enkashSignerMobile: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - cardApplication - pointOfContactName - pointOfContactAddress - proposedCashback - zohoApplicationStage - purchaseCreditCardType - appliedCreditLimit - businessPremiseOwnership - durationOfStay - industry - currentAddressLine - currentPinCode - currentCity - currentState - currentBusinessPremiseOwnership - classOfActivity - businessCode - directorCurrentResidenceAddress - directorCurrentResidencePinCode - directorDesignation - isDirectorAusOrPm - secondaryDirectorPanCard - secondaryDirectorMobileNumber - secondaryDirectorName - secondaryDirectorTitle - secondaryDirectorDOB - secondaryDirectorGender - secondaryDirectorCurrentResidenceAddress - secondaryDirectorCurrentResidencePinCode - secondaryDirectorCurrentResidenceCity - secondaryDirectorCurrentResidenceState - secondaryDirectorDesignation - secondaryDirectorPermanentResidenceAddress - secondaryDirectorPermanentResidenceAddressPinCode - companyEmbosserName - embosserMobileNumber - embosserEmail - embosserTelephoneNumber - embosserCommunicationAddress - financialYear - dscr - financialTurnover - gstTurnover - grossProfit - profitBeforeTax - tax - depreciation - shareCapital - reserveAndSurplus - natureOfBusinessFromZoho - loanAmountApplied - profitability - netWorth - constitutionTypeFromZoho - eligibilityFromZoho - rateOfInterest - acceptanceLetterDetailsUpdated - filingPeriodFromZoho - businessCategory - businessSubCategory - lineOfBusiness - mcc - purposeOfService - completeCompanyAddressFromZoho - businessEntityType - enkashSignerName - enkashSignerDesignation - enkashSignerEmail - enkashSignerMobile - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' Company: type: object properties: id: type: integer format: int64 companyId: type: string legalName: type: string businessType: type: string enum: - ENTERPRISE - CREDIT_PROVIDER - VENDOR - SOCIETY - AGENCY companyType: type: string taxId1: type: string taxId2: type: string website: type: string cin: type: string externalRefNo: type: string sourceRegion: type: string sourceCity: type: string sourcePerson: type: string riskApprovalStatus: type: string enum: - APPROVED - PENDING - IN_PROGRESS - BULK_UPLOAD - NEW createdBy: *ref_10 dateApproved: type: string format: date-time approvedBy: *ref_10 modifiedBy: *ref_10 addressLine1: type: string addressLine2: type: string city: type: string state: type: string country: type: string pin: type: string email: type: string phone: type: string status: type: string enum: - ACTIVE - INACTIVE - BLOCKED - LOCKED payoutCycle: type: string enum: - T0 - T1 - T2 - T3 beneficiaryBankAccountNumber: type: string beneficiaryIfsc: type: string beneficiaryBankName: type: string beneficiaryBranchName: type: string category: type: string enum: - A - B - C - D - TA - UTILITY - FUEL - IATA - OTHERS - RENTAL - KASHFLO - QUICK_RENT_PAY logo: type: string programAdminName: type: string ccLimit: type: number billingCycle: type: integer format: int32 nodalAddition: type: boolean outstandingAmount: type: number cardOutstandingAmount: type: number gstinAndBankNameMatchingScore: type: number proprietorNameMatchingType: type: string enum: - NONE - SURNAME - EXACT proprietorNameMatchCount: type: integer format: int32 autoApproved: type: boolean insufficientPrepaidBalance: type: boolean panId: type: integer format: int64 gstinId: type: integer format: int64 cinId: type: integer format: int64 pricingPlanId: type: integer format: int64 groupFunctionalityEnabled: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time migrated: type: boolean userGroups: uniqueItems: true type: array items: *ref_11 userGroupIds: type: array items: type: string billPayAgency: type: string enum: - MK - BA - SS - BE - WH - ME - TW - FP - CS - AX - T1 - T2 - T3 - IN industry: type: string pennyAccountChangeAttemptLeft: type: integer format: int32 pennyAmountVerified: type: boolean disableAllCompanyBillers: type: boolean pennyAmountVerifyAttemptLeft: type: integer format: int32 utmSource: type: string accountId: type: string enterpriseType: type: string enterpriseSubType: type: string partnerId: type: string pennyDrop: *ref_20 loginProvider: type: string enableLoginProvider: type: boolean latestFinancialYear: type: string slab: type: string leadOwner: type: string acquiringBank: type: string enum: - AXIS_BANK - CITI_BANK - HSBC_BANK - HDFC_BANK - SBI - INDUSIND_BANK - KOTAK_MAHINDRA_BANK - RBL_BANK - RAZORPAY - ICICI_BANK - YES_BANK - ENKASH - SBM_BANK - POS_MACHINE acquiredBy: type: string typeOfCustomer: type: string enum: - ON_US - OFF_US - CA - POS_MACHINE vendorPaymentEntries: type: array items: $ref: '#/components/schemas/VendorPaymentEntry' gstPayments: type: array items: *ref_21 utilityReferenceId: type: string onboardedBy: type: integer format: int64 dealId: type: string primaryChannel: type: string primaryProductCategory: type: string primaryProduct: type: string companySize: type: string enum: - TEN_PLUS - TWENTY_FIVE_PLUS - FIFTY_PLUS - HUNDRED_PLUS - TWO_HUNDRED_PLUS - FIVE_HUNDRED_PLUS - ONE_THOUSAND_PLUS extRefCompanyId: type: string whatsappOtp: type: boolean nbblB2bId: type: string nbblRequestId: type: string x-apidog-orders: - id - companyId - legalName - businessType - companyType - taxId1 - taxId2 - website - cin - externalRefNo - sourceRegion - sourceCity - sourcePerson - riskApprovalStatus - createdBy - dateApproved - approvedBy - modifiedBy - addressLine1 - addressLine2 - city - state - country - pin - email - phone - status - payoutCycle - beneficiaryBankAccountNumber - beneficiaryIfsc - beneficiaryBankName - beneficiaryBranchName - category - logo - programAdminName - ccLimit - billingCycle - nodalAddition - outstandingAmount - cardOutstandingAmount - gstinAndBankNameMatchingScore - proprietorNameMatchingType - proprietorNameMatchCount - autoApproved - insufficientPrepaidBalance - panId - gstinId - cinId - pricingPlanId - groupFunctionalityEnabled - createdOn - modifiedOn - migrated - userGroups - userGroupIds - billPayAgency - industry - pennyAccountChangeAttemptLeft - pennyAmountVerified - disableAllCompanyBillers - pennyAmountVerifyAttemptLeft - utmSource - accountId - enterpriseType - enterpriseSubType - partnerId - pennyDrop - loginProvider - enableLoginProvider - latestFinancialYear - slab - leadOwner - acquiringBank - acquiredBy - typeOfCustomer - vendorPaymentEntries - gstPayments - utilityReferenceId - onboardedBy - dealId - primaryChannel - primaryProductCategory - primaryProduct - companySize - extRefCompanyId - whatsappOtp - nbblB2bId - nbblRequestId x-apidog-ignore-properties: [] x-apidog-folder: '' VendorPaymentEntry: type: object properties: id: type: integer format: int64 vendorPaymentEntryId: type: string invoice: *ref_0 company: *ref_12 vendor: *ref_12 pgTransaction: *ref_2 amount: type: number paymentStatus: type: string enum: - INIT - PROCESS - SUCCESS - FAILED - PENDING - CANCELLED - EXPIRED - PARTIAL_REFUNDED - REFUNDED - IN_PROCESS - AUTHENTICATION_IN_PROCESS - OTP_RENDERED - CHECKOUT_RENDERED - MPI_PROCESSED - MPI_RENDERED - REFUND_IN_PROGRESS - REFUND_REQUESTED - PENDING_WITH_BANK - SWAPPED - PAID_OFFLINE - PARTIAL_PAID externalId: type: string paymentRefNum: type: string paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER transactionMessage: type: string paymentDate: type: string format: date-time deleted: type: boolean createdBy: *ref_10 modifiedBy: *ref_10 createdOn: type: string format: date-time modifiedOn: type: string format: date-time cpcr: $ref: '#/components/schemas/CompanyParentChildRelation' x-apidog-orders: - id - vendorPaymentEntryId - invoice - company - vendor - pgTransaction - amount - paymentStatus - externalId - paymentRefNum - paymentMode - transactionMessage - paymentDate - deleted - createdBy - modifiedBy - createdOn - modifiedOn - cpcr x-apidog-ignore-properties: [] x-apidog-folder: '' CompanyParentChildRelation: type: object properties: id: type: integer format: int64 parent: *ref_12 child: *ref_12 childAliasName: type: string childCategory: type: string enum: - A - B - C - D - TA - UTILITY - FUEL - IATA - OTHERS - RENTAL - KASHFLO - QUICK_RENT_PAY childUniqueReferenceNumber: type: string parentUniqueReferenceNumber: type: string externalUniqueId: type: string active: type: boolean emails: type: array items: type: string mobile: type: string bankDetail: $ref: '#/components/schemas/BankDetail' riskApprovalStatus: type: string enum: - APPROVED - PENDING - IN_PROGRESS - BULK_UPLOAD - NEW approvedOn: type: string format: date-time approvedBy: *ref_10 proprietorNameMatchingType: type: string enum: - NONE - SURNAME - EXACT proprietorNameMatchCount: type: integer format: int32 autoApproved: type: boolean bankApprovalDetails: type: array items: $ref: '#/components/schemas/BankApprovalDetail' reminderMailFrequency: type: integer format: int32 payableVirtualAccount: type: string panDocument: type: string gstinDocument: type: string bankAccountDocument: type: string companyBranchCodes: type: array items: $ref: '#/components/schemas/CompanyBranchCode' createdOn: type: string format: date-time modifiedOn: type: string format: date-time bankApprovals: type: string preferredPayoutMode: type: string enum: - IMPS - NEFT - RTGS - UPI recurringInvoiceDate: type: integer format: int32 recurringInvoice: type: boolean recurringInvoiceAmount: type: number recurringInvoiceNextDate: type: string format: date msmeRegistrationDate: type: string format: date sendPaymentAdvice: type: boolean approvalFailureReason: type: string enum: - PARENT_PROP_NAME_MISSING - CHILD_PROP_NAME_MISSING - PARENT_CHILD_PROP_NAME_MATCH - VALIDATION_FAILED_VENDOR_DATA - PARENT_CHILD_PROP_NAME_MISSING - VENDOR_BANK_DETAIL_MISSING - PARENT_CHILD_PAN_GSTIN_FAILED - INVALID_PAN_CATEGORY - INVALID_GSTIN - OTHER cpcrColumnWrapper: $ref: '#/components/schemas/CpcrColumnWrapper' selfApproved: type: boolean selfApprovedBy: type: string selfApprovedAt: type: string format: date-time companyParentChildRelationId: type: string additionalDataMapping: type: object additionalProperties: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] msme: type: boolean x-apidog-orders: - id - parent - child - childAliasName - childCategory - childUniqueReferenceNumber - parentUniqueReferenceNumber - externalUniqueId - active - emails - mobile - bankDetail - riskApprovalStatus - approvedOn - approvedBy - proprietorNameMatchingType - proprietorNameMatchCount - autoApproved - bankApprovalDetails - reminderMailFrequency - payableVirtualAccount - panDocument - gstinDocument - bankAccountDocument - companyBranchCodes - createdOn - modifiedOn - bankApprovals - preferredPayoutMode - recurringInvoiceDate - recurringInvoice - recurringInvoiceAmount - recurringInvoiceNextDate - msmeRegistrationDate - sendPaymentAdvice - approvalFailureReason - cpcrColumnWrapper - selfApproved - selfApprovedBy - selfApprovedAt - companyParentChildRelationId - additionalDataMapping - msme x-apidog-ignore-properties: [] x-apidog-folder: '' CpcrColumnWrapper: type: object properties: parentId: type: integer format: int64 childId: type: integer format: int64 x-apidog-orders: - parentId - childId x-apidog-ignore-properties: [] x-apidog-folder: '' CompanyBranchCode: type: object properties: id: type: integer format: int64 companyBranchCodeId: type: string companyId: type: integer format: int64 branchCode: type: string branchName: type: string costCentre: type: string branchCity: type: string branchState: type: string address: type: string remarks: type: string createdBy: type: integer format: int64 modifiedBy: type: integer format: int64 active: type: boolean gstStateCode: type: string gstStateAlphaCode: type: string createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - companyBranchCodeId - companyId - branchCode - branchName - costCentre - branchCity - branchState - address - remarks - createdBy - modifiedBy - active - gstStateCode - gstStateAlphaCode - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' BankApprovalDetail: type: object properties: bankApproval: type: string enum: - KOTAK_APPROVED - ICICI_BANK_APPROVED - ENKASH_D2I_APPROVED - AMEX_D2I_APPROVED - KOTAK_REJECTED - ICICI_BANK_REJECTED - ENKASH_D2I_REJECTED - AMEX_D2I_REJECTED approvedOn: type: string format: date-time approvedBy: type: string x-apidog-orders: - bankApproval - approvedOn - approvedBy x-apidog-ignore-properties: [] x-apidog-folder: '' BankDetail: type: object properties: id: type: integer format: int64 bankDetailId: type: string companyId: type: integer format: int64 parentCompanyId: type: integer format: int64 beneficiaryCode: type: string accountNumber: type: string ifsc: type: string bankName: type: string beneficiaryName: type: string pennyDropId: type: integer format: int64 nodalAddition: type: boolean iciciNodalAddition: type: string axisNodalAddition: type: string axisNtsplAddition: type: string axisNbsplAddition: type: string primaryBankDetail: type: boolean hdfcNodalAddition: type: boolean gstinAndBankNameMatchingScore: type: number approved: type: boolean invalidIfsc: type: boolean runCheck: type: boolean whitelisted: type: boolean whitelistDeleted: type: boolean createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - bankDetailId - companyId - parentCompanyId - beneficiaryCode - accountNumber - ifsc - bankName - beneficiaryName - pennyDropId - nodalAddition - iciciNodalAddition - axisNodalAddition - axisNtsplAddition - axisNbsplAddition - primaryBankDetail - hdfcNodalAddition - gstinAndBankNameMatchingScore - approved - invalidIfsc - runCheck - whitelisted - whitelistDeleted - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' BranchCodeDTO: type: object properties: companyId: type: integer format: int64 userId: type: integer format: int64 companyBranchCodeId: type: string branchCode: type: string x-apidog-orders: - companyId - userId - companyBranchCodeId - branchCode x-apidog-ignore-properties: [] x-apidog-folder: '' GstPayment: type: object properties: id: type: integer format: int64 gstEnkashId: type: string companyId: type: integer format: int64 partnerCompany: *ref_12 gstin: type: string cpin: type: string ifsc: type: string amount: type: number remittingBankName: type: string surcharge: type: number surchargeGst: type: number amountPaidByEnterprise: type: number description: type: string createdBy: type: integer format: int64 createdDate: type: string format: date-time expiryDate: type: string format: date-time lastModifiedDate: type: string format: date-time lastModifiedBy: type: integer format: int64 paymentStatus: type: string enum: - INIT - PROCESS - SUCCESS - FAILED - PENDING - CANCELLED - EXPIRED - PARTIAL_REFUNDED - REFUNDED - IN_PROCESS - AUTHENTICATION_IN_PROCESS - OTP_RENDERED - CHECKOUT_RENDERED - MPI_PROCESSED - MPI_RENDERED - REFUND_IN_PROGRESS - REFUND_REQUESTED - PENDING_WITH_BANK - SWAPPED - PAID_OFFLINE - PARTIAL_PAID paymentGatewayTransactions: uniqueItems: true type: array items: *ref_2 deleted: type: boolean dateApproved: type: string format: date-time approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED makerId: type: integer format: int64 checkerId: type: integer format: int64 maskedCardNumber: type: string paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER pgId: type: integer format: int64 payoutData: *ref_3 documentReferenceId: type: string nodalAddition: type: boolean approverApprovedCount: type: integer format: int32 iciciNodalAddition: type: string enum: - NOT_ADDED - ADDED - VERIFIED - APPROVAL_PENDING axisNodalAddition: type: string enum: - NOT_ADDED - ADDED - VERIFIED - APPROVAL_PENDING refundDate: type: string format: date-time companyBranchCodeId: type: integer format: int64 refundBy: type: integer format: int64 bankCard: *ref_4 approvalAuthorizations: uniqueItems: true type: array items: *ref_5 nextApprovalGroups: uniqueItems: true type: array items: *ref_6 previousUserApprovals: uniqueItems: true type: array items: *ref_7 refundTransactions: uniqueItems: true type: array items: *ref_8 x-apidog-orders: - id - gstEnkashId - companyId - partnerCompany - gstin - cpin - ifsc - amount - remittingBankName - surcharge - surchargeGst - amountPaidByEnterprise - description - createdBy - createdDate - expiryDate - lastModifiedDate - lastModifiedBy - paymentStatus - paymentGatewayTransactions - deleted - dateApproved - approvalStatus - makerId - checkerId - maskedCardNumber - paymentMode - pgId - payoutData - documentReferenceId - nodalAddition - approverApprovedCount - iciciNodalAddition - axisNodalAddition - refundDate - companyBranchCodeId - refundBy - bankCard - approvalAuthorizations - nextApprovalGroups - previousUserApprovals - refundTransactions x-apidog-ignore-properties: [] x-apidog-folder: '' ApprovalGroupUser: type: object properties: id: type: integer format: int64 groupId: type: string levelId: type: string priority: type: integer format: int32 approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED approved: type: boolean user: *ref_10 invoice: *ref_0 gstPayment: *ref_21 utilityPayment: *ref_22 createdOn: type: string format: date-time x-apidog-orders: - id - groupId - levelId - priority - approvalStatus - approved - user - invoice - gstPayment - utilityPayment - createdOn x-apidog-ignore-properties: [] x-apidog-folder: '' EarlyPaymentDetail: type: object properties: id: type: integer format: int64 earlyPaymentId: type: string invoice: *ref_0 earlyPaymentDueDate: type: string format: date earlyPaymentSource: type: string enum: - BUYER - SUPPLIER earlyPaymentPercentage: maximum: 100 minimum: 0 type: number earlyPaymentAcceptanceFlag: type: boolean earlyPaymentStatus: type: string enum: - PENDING - APPROVED - REJECTED - EXPIRED createdOn: type: string format: date-time modifiedOn: type: string format: date-time createdBy: type: string updatedBy: type: string x-apidog-orders: - id - earlyPaymentId - invoice - earlyPaymentDueDate - earlyPaymentSource - earlyPaymentPercentage - earlyPaymentAcceptanceFlag - earlyPaymentStatus - createdOn - modifiedOn - createdBy - updatedBy x-apidog-ignore-properties: [] x-apidog-folder: '' ApprovalGroup: type: object properties: id: type: integer format: int64 approvalMatrixId: type: string groupId: type: string groupName: type: string levelId: type: string levelName: type: string priority: type: integer format: int32 invoice: *ref_0 gstPayment: *ref_21 utilityPayment: *ref_22 createdOn: type: string format: date-time x-apidog-orders: - id - approvalMatrixId - groupId - groupName - levelId - levelName - priority - invoice - gstPayment - utilityPayment - createdOn x-apidog-ignore-properties: [] x-apidog-folder: '' ApprovalAuthorization: type: object properties: id: type: integer format: int64 approvedBy: type: integer format: int64 approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED groupId: type: string groupName: type: string levelId: type: string levelName: type: string priority: type: integer format: int32 approvedOn: type: string format: date-time invoice: *ref_0 gstPayment: *ref_21 utilityPayment: *ref_22 remarks: type: string x-apidog-orders: - id - approvedBy - approvalStatus - groupId - groupName - levelId - levelName - priority - approvedOn - invoice - gstPayment - utilityPayment - remarks x-apidog-ignore-properties: [] x-apidog-folder: '' BankCard: type: object properties: id: type: integer format: int64 bankCardId: type: string company: *ref_12 maskCardNumber: type: string nameOnCard: type: string aliasName: type: string creditLimit: type: number billingCycle: type: integer format: int32 dueDate: type: integer format: int32 billingDate: type: integer format: int32 token: type: string bank: type: string logo: type: string labels: uniqueItems: true type: array items: type: string enum: - INVOICE - GST - UTILITY - RENTAL - CONSENT_TRANSACTION - COLLECTION_INVOICE - ADVANCE_PAYMENT active: type: boolean tokenised: type: boolean cardHash: type: string lastTokenisedOn: type: string format: date-time tokenExpiry: type: integer format: int64 bankCardApprovalStatus: type: string enum: - PENDING - APPROVED - REJECTED deleted: type: boolean version: type: integer format: int32 bankCardAuditTrails: uniqueItems: true type: array items: $ref: '#/components/schemas/BankCardAuditTrail' createdBy: *ref_10 modifiedBy: *ref_10 createdOn: type: string format: date-time modifiedOn: type: string format: date-time x-apidog-orders: - id - bankCardId - company - maskCardNumber - nameOnCard - aliasName - creditLimit - billingCycle - dueDate - billingDate - token - bank - logo - labels - active - tokenised - cardHash - lastTokenisedOn - tokenExpiry - bankCardApprovalStatus - deleted - version - bankCardAuditTrails - createdBy - modifiedBy - createdOn - modifiedOn x-apidog-ignore-properties: [] x-apidog-folder: '' BankCardAuditTrail: type: object properties: id: type: integer format: int64 bankCard: *ref_4 action: type: string enum: - CREATION - APPROVAL_STATUS - ACTIVE - DELETE - AUTO_DEBIT - BILL_CREATION - BANK_CARD value: type: string user: *ref_10 timestamp: type: string format: date-time x-apidog-orders: - id - bankCard - action - value - user - timestamp x-apidog-ignore-properties: [] x-apidog-folder: '' PurchaseOrder: type: object properties: id: type: integer format: int64 purchaseOrderId: type: string maxInvoicesAllowed: type: integer format: int64 invoiceRaisedTillDate: type: integer format: int64 invoicePaidTillDate: type: integer format: int64 maxAmount: type: number maxAmountPerInvoice: type: number minimumAmountPerInvoice: type: number amountRaisedTillDate: type: number amountPaidTillDate: type: number tds: type: number createdBy: type: integer format: int64 createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time lastModifiedBy: type: integer format: int64 startDate: type: string format: date-time expiryDate: type: string format: date-time dueDate: type: string format: date-time description: type: string makerId: type: integer format: int64 checkerId: type: integer format: int64 approvalStatus: type: string enum: - MAKER_APPROVAL_PENDING - MAKER_APPROVED - MAKER_REJECTED - CHECKER_APPROVAL_PENDING - CHECKER_APPROVED - CHECKER_REJECTED - APPROVER_APPROVAL_PENDING - APPROVER_APPROVED - APPROVER_REJECTED - BANK_APPROVED - BANK_REJECTED sourceCompany: type: integer format: int64 targetCompany: type: integer format: int64 dateApproved: type: string format: date-time deleted: type: boolean invoices: type: array items: *ref_0 type: type: string enum: - PAYMENT_REQUEST referenceNumber: type: string companyBranchCodeId: type: integer format: int64 purchaseOrderStatus: type: string enum: - OPEN - CLOSE nextRemainderMailDate: type: string format: date-time x-apidog-orders: - id - purchaseOrderId - maxInvoicesAllowed - invoiceRaisedTillDate - invoicePaidTillDate - maxAmount - maxAmountPerInvoice - minimumAmountPerInvoice - amountRaisedTillDate - amountPaidTillDate - tds - createdBy - createdDate - lastModifiedDate - lastModifiedBy - startDate - expiryDate - dueDate - description - makerId - checkerId - approvalStatus - sourceCompany - targetCompany - dateApproved - deleted - invoices - type - referenceNumber - companyBranchCodeId - purchaseOrderStatus - nextRemainderMailDate x-apidog-ignore-properties: [] x-apidog-folder: '' PayoutData: type: object properties: id: type: integer format: int64 beneficiaryAccount: type: string beneficiaryName: type: string beneficiaryCode: type: string beneficiaryIfsc: type: string payerName: type: string payerPhone: type: string payerEmail: type: string amount: type: number paymentDate: type: string format: date-time payoutSource: type: string enum: - INVOICE - GSTPAYMENT - UTILITY_PAYMENT - RENTAL_PAYMENT - KASHFLO_COLLECTION - SETTLEMENT - SETTLEMENT_PROFIT_PAYOUT - VOUCHER - COLLECTION_INVOICE - QUICK_COLLECT - QUICK_COLLECT_COLLECTION - REFUND_SOURCE - DIRECT_PAYOUT payoutCycle: type: string enum: - T0 - T1 - T2 - T3 payoutStatus: type: string enum: - SUCCESS - FAILED - PENDING - IN_PROGRESS - PAID - ON_HOLD - NEFT_CALL_MADE - IMPS_CALL_MADE - REINITIATE - AGENCY_PENDING - AX_BBPS_SUCCESS - PG_SETTLEMENT_PENDING - UPI_CALL_MADE - REVERSED - REJECTED - PROCESSING payoutMode: type: string enum: - IMPS - NEFT - RTGS - UPI payoutDate: type: string format: date-time initiatedOn: type: string format: date-time utr: type: string transferId: type: string transferResponseCode: type: string transferResponseReason: type: string pgId: type: integer format: int64 payerCompanyId: type: string payeeCompanyId: type: string sourceEnkashId: type: string impsPaymentRetryLeft: type: integer format: int32 beneficiaryEmails: type: string createdBy: type: integer format: int64 remarks: type: string createdDate: type: string format: date-time lastModifiedDate: type: string format: date-time lastModifiedBy: type: integer format: int64 nodalBank: type: string enum: - KOTAK - HDFC - AXIS - ICICI - AU_BANK - AXIS_NBSPL - AXIS_NTSPL - TEST_BANK - KOTAK_PPI - IDFC transferIds: type: array items: type: string fundMatchStatus: type: string enum: - MATCHED - MISMATCH - UNMATCHED webhookResponse: type: string batchNo: type: string version: type: integer format: int32 mergePayout: type: boolean webhookUrl: type: string x-apidog-orders: - id - beneficiaryAccount - beneficiaryName - beneficiaryCode - beneficiaryIfsc - payerName - payerPhone - payerEmail - amount - paymentDate - payoutSource - payoutCycle - payoutStatus - payoutMode - payoutDate - initiatedOn - utr - transferId - transferResponseCode - transferResponseReason - pgId - payerCompanyId - payeeCompanyId - sourceEnkashId - impsPaymentRetryLeft - beneficiaryEmails - createdBy - remarks - createdDate - lastModifiedDate - lastModifiedBy - nodalBank - transferIds - fundMatchStatus - webhookResponse - batchNo - version - mergePayout - webhookUrl x-apidog-ignore-properties: [] x-apidog-folder: '' PaymentGatewayTransaction: type: object properties: id: type: integer format: int64 amount: type: number surcharge: type: number mdr: type: number gst: type: number pgTxnDate: type: string format: date-time pgTxnStatus: type: string enum: - INIT - CREATED - SUCCESS - FAILED - PENDING - CANCELLED - REFUNDED - REFUND_IN_PROGRESS - PENDING_WITH_BANK - EXPIRED - AUTHENTICATION_IN_PROCESS - OTP_RENDERED - CHECKOUT_RENDERED - MPI_PROCESSED - PENDING_FOR_PROCESSING - SUSPECT - REJECTED - FAILURE - RECALLED pgTxnRefNum: type: string pgReferenceId: type: string invoices: uniqueItems: true type: array items: *ref_0 pgId: type: integer format: int64 gstPayments: uniqueItems: true type: array items: *ref_21 utilityPayments: uniqueItems: true type: array items: *ref_22 authLogs: uniqueItems: true type: array items: $ref: '#/components/schemas/Authlog' paymentType: type: string enum: - INVOICE - GST - UTILITY - RENTAL - CONSENT_TRANSACTION - COLLECTION_INVOICE - ADVANCE_PAYMENT txnMessage: type: string initiatedBy: type: string payeeName: type: string payeeEmail: type: string payeePhone: type: string bankReferenceId: type: string companyId: type: integer format: int64 paymentMode: type: string enum: - CREDIT_CARD - DEBIT_CARD - NET_BANKING - UPI - PREPAID_CARD - INVALID_PAYMENT_MODE - SEAMLESS_BANKING - VIRTUAL_ACCOUNT - TALLY_PAYMENT - ENKASH_COIN - CASH - CHEQUE - ACCOUNT_TRANSFER beneficiaryName: type: string paymentToken: type: string cardNumber: type: string pgMid: type: string pgPayId: type: string bankTransactionId: type: string paymentRemarks: type: string x-apidog-orders: - id - amount - surcharge - mdr - gst - pgTxnDate - pgTxnStatus - pgTxnRefNum - pgReferenceId - invoices - pgId - gstPayments - utilityPayments - authLogs - paymentType - txnMessage - initiatedBy - payeeName - payeeEmail - payeePhone - bankReferenceId - companyId - paymentMode - beneficiaryName - paymentToken - cardNumber - pgMid - pgPayId - bankTransactionId - paymentRemarks x-apidog-ignore-properties: [] x-apidog-folder: '' Authlog: type: object properties: id: type: integer format: int64 companyId: type: string enterpriseCategory: type: string enum: - A - B - C - D - TA - UTILITY - FUEL - IATA - OTHERS - RENTAL - KASHFLO - QUICK_RENT_PAY limitAmount: type: number paymentGatewayTransaction: *ref_2 status: type: string dateCreated: type: string format: date-time role: type: string x-apidog-orders: - id - companyId - enterpriseCategory - limitAmount - paymentGatewayTransaction - status - dateCreated - role x-apidog-ignore-properties: [] x-apidog-folder: '' NbblB2BIdsModel: required: - buyerB2BId - supplierB2BId type: object properties: buyerB2BId: type: string pattern: '^([^\\\"]){1,100}$ ' supplierB2BId: type: string pattern: '^([^\\\"]){1,100}$ ' x-apidog-orders: - buyerB2BId - supplierB2BId x-apidog-ignore-properties: [] x-apidog-folder: '' Device: type: object properties: tag: $ref: '#/components/schemas/Tag' x-apidog-orders: - tag required: - tag x-apidog-ignore-properties: [] x-apidog-folder: '' Tag: type: object properties: name: type: string enum: - GEOCODE - IP - AGENTID value: type: string pattern: ^([^\\\"]){1,100}$ x-apidog-orders: - name - value required: - name - value x-apidog-ignore-properties: [] x-apidog-folder: '' ApplicationResponseCreateInvoiceResponse: type: object properties: response_code: type: integer response_message: type: string payload: $ref: '#/components/schemas/CreateInvoiceResponse' x-apidog-orders: - response_code - response_message - payload required: - response_code - response_message - payload x-apidog-ignore-properties: [] x-apidog-folder: '' CreateInvoiceResponse: type: object properties: b2bIds: type: object properties: buyerB2BId: type: string supplierB2BId: type: string required: - buyerB2BId - supplierB2BId x-apidog-orders: - buyerB2BId - supplierB2BId x-apidog-ignore-properties: [] resp: type: object properties: reqMsgId: type: string result: type: string errorCd: type: string errorDtl: type: string errorField: type: string required: - reqMsgId - result - errorCd - errorDtl - errorField x-apidog-orders: - reqMsgId - result - errorCd - errorDtl - errorField x-apidog-ignore-properties: [] invoice: type: object properties: objectId: type: string supplierInvoiceNumber: type: string objectVersion: type: object properties: currentVersion: type: integer newVersion: type: integer required: - currentVersion - newVersion x-apidog-orders: - currentVersion - newVersion x-apidog-ignore-properties: [] ts: type: string statusTransition: type: object properties: currentStatus: type: string newStatus: type: string required: - currentStatus - newStatus x-apidog-orders: - currentStatus - newStatus x-apidog-ignore-properties: [] transactionDetails: type: object properties: taxScheme: type: string supplyType: type: string reverseChargeTax: type: string igstChargable: type: string ecommerceGstin: type: string required: - taxScheme - supplyType - reverseChargeTax - igstChargable - ecommerceGstin x-apidog-orders: - taxScheme - supplyType - reverseChargeTax - igstChargable - ecommerceGstin x-apidog-ignore-properties: [] supplierDetails: type: object properties: b2bId: type: string gstin: type: string legalName: type: string tradeName: type: string stateCode: type: string address: type: object properties: type: type: string addressLine1: type: string addressLine2: type: string city: type: string state: type: string country: type: string pincode: type: string required: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-orders: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-ignore-properties: [] contactNumber: type: object properties: type: type: string countryCode: type: string phoneNumber: type: string required: - type - countryCode - phoneNumber x-apidog-orders: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] email: type: string required: - b2bId - gstin - legalName - tradeName - stateCode - address - contactNumber - email x-apidog-orders: - b2bId - gstin - legalName - tradeName - stateCode - address - contactNumber - email x-apidog-ignore-properties: [] buyerDetails: type: object properties: b2bId: type: string gstin: type: string legalName: type: string tradeName: type: string stateCode: type: string placeOfSupply: type: string address: type: object properties: type: type: string addressLine1: type: string addressLine2: type: string city: type: string state: type: string country: type: string pincode: type: string required: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-orders: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-ignore-properties: [] contactNumber: type: object properties: type: type: string countryCode: type: string phoneNumber: type: string required: - type - countryCode - phoneNumber x-apidog-orders: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] email: type: string required: - b2bId - gstin - legalName - tradeName - stateCode - placeOfSupply - address - contactNumber - email x-apidog-orders: - b2bId - gstin - legalName - tradeName - stateCode - placeOfSupply - address - contactNumber - email x-apidog-ignore-properties: [] dispatchDetails: type: object properties: gstin: type: string legalName: type: string tradeName: type: string stateCode: type: string address: type: object properties: type: type: string addressLine1: type: string addressLine2: type: string city: type: string state: type: string country: type: string pincode: type: string required: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-orders: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-ignore-properties: [] contactNumber: type: object properties: type: type: string countryCode: type: string phoneNumber: type: string required: - type - countryCode - phoneNumber x-apidog-orders: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] email: type: string required: - gstin - legalName - tradeName - stateCode - address - contactNumber - email x-apidog-orders: - gstin - legalName - tradeName - stateCode - address - contactNumber - email x-apidog-ignore-properties: [] shippingDetails: type: object properties: gstin: type: string lglNm: type: string trdNm: type: string stateCode: type: string address: type: object properties: type: type: string addressLine1: type: string addressLine2: type: string city: type: string state: type: string country: type: string pincode: type: string required: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-orders: - type - addressLine1 - addressLine2 - city - state - country - pincode x-apidog-ignore-properties: [] contactNumber: type: object properties: type: type: string countryCode: type: string phoneNumber: type: string required: - type - countryCode - phoneNumber x-apidog-orders: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] email: type: string required: - gstin - lglNm - trdNm - stateCode - address - contactNumber - email x-apidog-orders: - gstin - lglNm - trdNm - stateCode - address - contactNumber - email x-apidog-ignore-properties: [] itemLists: type: array items: type: object properties: serialno: type: string productDescription: type: string isService: type: string hsnCode: type: string barCode: type: string quantity: type: integer freeQuantity: type: integer unit: type: string unitPrice: type: integer totalAmt: type: integer assessmentAmount: type: integer gstRate: type: integer totalItemValue: type: integer orderLineReference: type: string originCountry: type: string productSerialNumber: type: string itemValueDetails: type: array items: type: object properties: type: type: string value: type: integer x-apidog-orders: - type - value x-apidog-ignore-properties: [] rates: type: array items: type: object properties: type: type: string value: type: integer x-apidog-orders: - type - value x-apidog-ignore-properties: [] batchDetails: type: object properties: batchNumber: type: string expiryDate: type: string batchWarrantyDate: type: string required: - batchNumber - expiryDate - batchWarrantyDate x-apidog-orders: - batchNumber - expiryDate - batchWarrantyDate x-apidog-ignore-properties: [] attributeDetails: type: array items: type: object properties: name: type: string value: type: string x-apidog-orders: - name - value x-apidog-ignore-properties: [] otherTaxes: type: array items: type: object properties: name: type: string rate: type: integer amount: type: integer x-apidog-orders: - name - rate - amount x-apidog-ignore-properties: [] x-apidog-orders: - serialno - productDescription - isService - hsnCode - barCode - quantity - freeQuantity - unit - unitPrice - totalAmt - assessmentAmount - gstRate - totalItemValue - orderLineReference - originCountry - productSerialNumber - itemValueDetails - rates - batchDetails - attributeDetails - otherTaxes x-apidog-ignore-properties: [] valueDetails: type: object properties: assessmentValue: type: integer totalInvoiceValue: type: integer otherValues: type: array items: type: object properties: type: type: string value: type: integer x-apidog-orders: - type - value x-apidog-ignore-properties: [] required: - assessmentValue - totalInvoiceValue - otherValues x-apidog-orders: - assessmentValue - totalInvoiceValue - otherValues x-apidog-ignore-properties: [] supplierBankAccountDetails: type: object properties: maskedAccountNumber: type: string ifsc: type: string beneficiaryName: type: string businessVPA: type: string required: - maskedAccountNumber - ifsc - beneficiaryName - businessVPA x-apidog-orders: - maskedAccountNumber - ifsc - beneficiaryName - businessVPA x-apidog-ignore-properties: [] advancePaymentDetails: type: object properties: payeeName: type: string mode: type: string paymentTerms: type: string paymentInstruction: type: string creditTransfer: type: string directDebit: type: string creditDays: type: integer paidAmount: type: integer pendingDueAmount: type: integer required: - payeeName - mode - paymentTerms - paymentInstruction - creditTransfer - directDebit - creditDays - paidAmount - pendingDueAmount x-apidog-orders: - payeeName - mode - paymentTerms - paymentInstruction - creditTransfer - directDebit - creditDays - paidAmount - pendingDueAmount x-apidog-ignore-properties: [] invoiceReferenceDetails: type: object properties: invoiceRemarks: type: string invoiceStartDate: type: string invoiceEndDate: type: string required: - invoiceRemarks - invoiceStartDate - invoiceEndDate x-apidog-orders: - invoiceRemarks - invoiceStartDate - invoiceEndDate x-apidog-ignore-properties: [] precedingInvoiceDetails: type: array items: type: object properties: invoiceNumber: type: string date: type: string otherReferenceNo: type: string x-apidog-orders: - invoiceNumber - date - otherReferenceNo x-apidog-ignore-properties: [] poDetails: type: array items: type: object properties: poObjId: type: string buyerPoId: type: string poDate: type: string x-apidog-orders: - poObjId - buyerPoId - poDate x-apidog-ignore-properties: [] contractReferenceDetails: type: array items: type: object properties: receiptAdviceNo: type: string receiptAdviceDate: type: string batchReferenceNo: type: string contractReferenceNo: type: string extraReferenceNo: type: string projectReferenceNo: type: string x-apidog-orders: - receiptAdviceNo - receiptAdviceDate - batchReferenceNo - contractReferenceNo - extraReferenceNo - projectReferenceNo x-apidog-ignore-properties: [] additionalDocumentDetails: type: array items: type: object properties: url: type: string document: type: string info: type: string x-apidog-orders: - url - document - info x-apidog-ignore-properties: [] exportDetails: type: object properties: shipBillNo: type: string shipBillDate: type: string port: type: string refundClaim: type: string foreignCurrency: type: string countryCode: type: string exportDuty: type: integer required: - shipBillNo - shipBillDate - port - refundClaim - foreignCurrency - countryCode - exportDuty x-apidog-orders: - shipBillNo - shipBillDate - port - refundClaim - foreignCurrency - countryCode - exportDuty x-apidog-ignore-properties: [] ewayBillDetail: type: object properties: transporterId: type: string transporterName: type: string transportMode: type: string distance: type: integer transportDocumentNo: type: string transportDocumentDate: type: string vehicleNo: type: string vehicleType: type: string required: - transporterId - transporterName - transportMode - distance - transportDocumentNo - transportDocumentDate - vehicleNo - vehicleType x-apidog-orders: - transporterId - transporterName - transportMode - distance - transportDocumentNo - transportDocumentDate - vehicleNo - vehicleType x-apidog-ignore-properties: [] recurringPayments: type: object properties: originalInvoiceId: type: string frequency: type: string startDate: type: string endDate: type: string mandateDetails: type: string mandateExecutionDate: type: string mandateAmount: type: integer required: - originalInvoiceId - frequency - startDate - endDate - mandateDetails - mandateExecutionDate - mandateAmount x-apidog-orders: - originalInvoiceId - frequency - startDate - endDate - mandateDetails - mandateExecutionDate - mandateAmount x-apidog-ignore-properties: [] paymentMilestones: type: array items: type: object properties: milestoneDate: type: string dueAmount: type: integer x-apidog-orders: - milestoneDate - dueAmount x-apidog-ignore-properties: [] shippingTermsDetails: type: object properties: terms: type: string bearingParty: type: string charges: type: integer required: - terms - bearingParty - charges x-apidog-orders: - terms - bearingParty - charges x-apidog-ignore-properties: [] invoiceFinancingDetails: type: object properties: dueAmount: type: integer financingRequestAmount: type: integer required: - dueAmount - financingRequestAmount x-apidog-orders: - dueAmount - financingRequestAmount x-apidog-ignore-properties: [] einvoiceResponse: type: string eInvoiceInfo: type: object properties: schemaVersion: type: string irnNumber: type: string irnTs: type: string required: - schemaVersion - irnNumber - irnTs x-apidog-orders: - schemaVersion - irnNumber - irnTs x-apidog-ignore-properties: [] required: - objectId - supplierInvoiceNumber - objectVersion - ts - statusTransition - transactionDetails - supplierDetails - buyerDetails - dispatchDetails - shippingDetails - itemLists - valueDetails - supplierBankAccountDetails - advancePaymentDetails - invoiceReferenceDetails - precedingInvoiceDetails - poDetails - contractReferenceDetails - additionalDocumentDetails - exportDetails - ewayBillDetail - recurringPayments - paymentMilestones - shippingTermsDetails - invoiceFinancingDetails - einvoiceResponse - eInvoiceInfo x-apidog-orders: - objectId - supplierInvoiceNumber - objectVersion - ts - statusTransition - transactionDetails - supplierDetails - buyerDetails - dispatchDetails - shippingDetails - itemLists - valueDetails - supplierBankAccountDetails - advancePaymentDetails - invoiceReferenceDetails - precedingInvoiceDetails - poDetails - contractReferenceDetails - additionalDocumentDetails - exportDetails - ewayBillDetail - recurringPayments - paymentMilestones - shippingTermsDetails - invoiceFinancingDetails - einvoiceResponse - eInvoiceInfo x-apidog-ignore-properties: [] additionalInfo: type: array items: type: object properties: name: type: string value: type: string x-apidog-orders: - name - value x-apidog-ignore-properties: [] required: - b2bIds - resp - invoice - additionalInfo x-apidog-orders: - b2bIds - resp - invoice - additionalInfo x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```