--- updatedAt: 2026-05-20T14:38:42.000Z agentTools: projectIndex: https://docs.duemint.com/llms.txt --- # /api/v1/collection-clients # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Duemint API", "version": "1.0.0" }, "servers": [ { "url": "https://api.duemint.com", "description": "Production" }, { "url": "https://api.sandbox.duemint.com", "description": "Sandbox" } ], "security": [ { "JWT": [], "CompanyId": [] } ], "x-code-samples": [ { "lang": "curl", "source": "# Both JWT and CompanyId headers are REQUIRED (AND logic)" } ], "tags": [ { "name": "collection-clients" }, { "name": "treasury-webhooks" }, { "name": "collections-webhooks" } ], "x-tagGroups": [ { "name": "collections", "tags": [ "collection-contacts", "collection-clients", "collection-documents", "collection-events", "collection-notes", "collection-payments", "collection-payment-methods", "collection-tags", "collections-webhooks" ] }, { "name": "treasury", "tags": [ "charges", "transactions", "payments-in", "payments-out", "wallets", "payment-methods", "recipients", "treasury-webhooks" ] }, { "name": "payables", "tags": [ "document-types", "documents", "assignables", "purchase-orders" ] } ], "components": { "schemas": { "CollectionClient": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "taxId": { "type": "string" }, "country": { "type": "string" }, "region": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipcode": { "type": "string" }, "phone": { "type": "string" }, "fax": { "type": "string" }, "paymentTerm": { "type": "number" }, "externalId": { "type": "number" }, "sendReminders": { "type": "object", "properties": { "newDocument": { "type": "boolean" }, "soonToExpire": { "type": "boolean" }, "expired": { "type": "boolean" }, "newPayment": { "type": "boolean" }, "debtSummary": { "type": "boolean" } } }, "url": { "type": "string" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" } } } }, "owners": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "userId": { "type": "string" } } } } } }, "CollectionDocument": { "type": "object", "properties": { "id": { "type": "string" }, "clientTaxId": { "type": "string" }, "number": { "type": "string" }, "createdAt": { "type": "string" }, "issueDate": { "type": "string" }, "dueDate": { "type": "string" }, "status": { "type": "number" }, "statusName": { "type": "string" }, "currency": { "type": "string" }, "net": { "type": "string" }, "taxes": { "type": "string" }, "total": { "type": "string" }, "paidAmount": { "type": "string" }, "paidDate": { "type": "string" }, "amountDue": { "type": "string" }, "amountCredit": { "type": "string" }, "amountDebit": { "type": "string" }, "purchaseOrder": { "type": "string" }, "gloss": { "type": "string" }, "notes": { "type": "string" }, "code": { "type": "number" }, "url": { "type": "string" }, "xml": { "type": "string" }, "pdf": { "type": "string" }, "client": { "type": "object", "properties": { "id": { "type": "string" } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" } } } }, "files": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" } } } }, "owners": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "userId": { "type": "number" } } } } } }, "CollectionPayment": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "date": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "description": { "type": "string" }, "bankCode": { "type": "string" }, "accountNumber": { "type": "string" }, "paymentMethod": { "type": "string" }, "transactionCode": { "type": "string" }, "documentNumber": { "type": "string" }, "comments": { "type": "string" }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "taxId": { "type": "string" } } } }, "client": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "taxId": { "type": "string" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "string" }, "document": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "code": { "type": "string" }, "client": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "taxId": { "type": "string" } } } } } } } }, "files": { "type": "array", "items": {} } } }, "Provider": { "type": "string", "enum": [ "amh", "duemint", "etpay", "flow", "fintoc", "mercado-pago", "prepago-los-heroes", "servipag", "security-hub", "shinkansen", "transbank", "virtualpos", "bci", "scotiabank", "getnet", "psp-demo", "banco-estado", "santander" ] }, "ProviderType": { "type": "string", "enum": [ "external-system", "internal-system", "external-user", "user", "admin" ] }, "Currency": { "type": "string", "enum": [ "CLP", "CLF", "USD", "EUR" ] }, "BankCode": { "type": "string", "enum": [ "028", "055", "001", "012", "051", "009", "039", "053", "037", "049", "016", "672", "777", "031", "041", "729", "014", "504", "730", "875", "017", "043", "000", "732", "738" ] }, "CountryCode": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KP", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "PaymentMethodFeature": { "type": "string", "enum": [ "pay-in-charges", "pay-in-bank", "pay-in-incomes", "pay-in-reversal", "pay-out-reversal", "pay-in-duemint", "pay-in-transfers-duemint-inter-company", "pay-in-transfers-duemint-intra-company", "pay-in-validation", "pay-out-chargeback", "pay-out-charges", "pay-out-bank", "pay-out-refund-by-duemint", "pay-out-refund-by-user", "pay-out-refund-validation", "pay-out-duemint", "pay-out-transfers-bank", "pay-out-auto-withdrawal-transfers-bank", "pay-out-transfers-duemint-inter-company", "pay-out-transfers-duemint-intra-company", "pay-out-payroll", "pay-out-payroll-batch", "pay-in-pos-terminal" ] }, "AuthorizationStatus": { "type": "string", "enum": [ "not-required", "required", "approved", "rejected" ] }, "PaymentType": { "type": "string", "enum": [ "payroll", "payroll-item", "single" ] }, "PaymentBankFeature": { "type": "string", "enum": [ "income", "income-transfer", "atm", "purchase", "transfer-bank-draft", "bank-draft", "income-transfer-p2p", "transfer-bank-draft-p2p", "reversal-income-transfer", "income-main-account-to-saving-account", "bank-draft-saving-account-to-main-account", "massive-transfer", "Reversal" ] }, "PaymentPayrollDetailModel": { "type": "object", "properties": { "name": { "type": "string" }, "approvalFlowName": { "type": "string" }, "description": { "type": "string" }, "totalPayments": { "type": "number" }, "pendingPayments": { "type": "number" }, "donePayments": { "type": "number" }, "failedPayments": { "type": "number" }, "paidAmount": { "type": "number" }, "originalAmount": { "type": "number" }, "failedAmount": { "type": "number" } }, "required": [ "name" ] }, "IdentificationType": { "type": "string", "enum": [ "RUT" ] }, "Subject": { "type": "object", "properties": { "identificationNumber": { "type": "string", "nullable": false }, "identificationType": { "nullable": false, "$ref": "#/components/schemas/IdentificationType" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "recipientId": { "type": "string" }, "recipientAccountId": { "type": "string" }, "walletId": { "type": "string" } } }, "Issuer": { "type": "string", "enum": [ "visa", "master-card", "discovery", "american-express", "diners", "magna", "presto", "redcompra", "elo", "hipercard" ] }, "Method": { "type": "object", "properties": { "cardId": { "type": "string" }, "cardLastDigits": { "type": "string" }, "cardExpirationDate": { "format": "date-time", "type": "string" }, "cardMethod": { "type": "string", "enum": [ "debit-card", "credit-card", "prepaid-card", "international-card" ] }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "accountNumber": { "type": "string" }, "bankCode": { "type": "string" }, "bankAccountType": { "type": "string" }, "posTerminalId": { "type": "string" } } }, "PaymentSpot": { "type": "object", "properties": { "subject": { "$ref": "#/components/schemas/Subject" }, "method": { "$ref": "#/components/schemas/Method" } } }, "PaymentMethodType": { "type": "string", "enum": [ "credit-card", "debit-card", "credit-and-debit-card", "transfer", "prepaid-card", "international-card" ] }, "PSP": { "type": "string", "enum": [ "flow", "mercado-pago", "etpay", "duemint", "servipag", "amh", "virtualpos-web-checkout", "virtualpos-quick-checkout", "duemint-verified-transfer", "getnet", "banco-estado", "bci", "santander", "demo", "getnet-pos" ] }, "ReleaseType": { "type": "string", "enum": [ "accounting-day", "business-day", "calendar-day" ] }, "TransferLimit": { "type": "object", "properties": { "maxAmountFirstTransfer": { "type": "number", "nullable": false }, "waitingHoursSecondTransfer": { "type": "number", "nullable": false }, "maxDailyTransferAmount": { "type": "number", "nullable": false }, "maxMonthlyTransferAmount": { "type": "number", "nullable": false } } }, "PaymentMethodCondition": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PaymentMethodType" }, "minAmount": { "type": "number" }, "maxAmount": { "type": "number" }, "releaseType": { "$ref": "#/components/schemas/ReleaseType" }, "releaseDay": { "type": "number", "minimum": 0, "default": 0, "nullable": false }, "releaseHours": { "type": "number", "minimum": 0, "nullable": true }, "feeVariablePercentage": { "type": "number" }, "feeFixedAmount": { "type": "number" }, "feeFixedCurrency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "minAmount", "maxAmount", "releaseType", "releaseDay", "releaseHours", "feeVariablePercentage", "feeFixedAmount", "feeFixedCurrency" ] }, "BankTransactionLimitAmount": { "type": "object", "properties": { "bankCode": { "$ref": "#/components/schemas/BankCode" }, "minAmount": { "type": "number", "nullable": false }, "maxAmount": { "type": "number", "nullable": false } }, "required": [ "bankCode", "minAmount", "maxAmount" ] }, "PaymentMethodSnapshot": { "type": "object", "properties": { "name": { "type": "string" }, "namePayer": { "type": "string" }, "description": { "type": "string" }, "descriptionPayer": { "type": "string" }, "feeVariablePercentage": { "type": "number" }, "feeFixedAmount": { "type": "number" }, "feeFixedCurrency": { "$ref": "#/components/schemas/Currency" }, "feature": { "$ref": "#/components/schemas/PaymentMethodFeature" }, "type": { "$ref": "#/components/schemas/PaymentMethodType" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "currency": { "$ref": "#/components/schemas/Currency" }, "psp": { "$ref": "#/components/schemas/PSP" }, "provider": { "$ref": "#/components/schemas/Provider" }, "releaseType": { "$ref": "#/components/schemas/ReleaseType" }, "releaseDay": { "type": "number", "minimum": 0, "default": 0, "nullable": false }, "releaseHours": { "type": "number", "minimum": 0, "nullable": true }, "minAmount": { "type": "number", "minimum": 1, "nullable": false }, "maxAmount": { "type": "number", "minimum": 1, "nullable": false }, "minAmountRestriction": { "type": "number", "minimum": 0, "nullable": false }, "maxAmountRestriction": { "type": "number", "minimum": 0, "nullable": false }, "maxInstallments": { "type": "number", "minimum": 1, "maximum": 12, "default": 1, "nullable": false }, "transferLimit": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TransferLimit" } ] }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodCondition" } }, "bankTransactionLimitAmounts": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransactionLimitAmount" } } }, "required": [ "name", "feeVariablePercentage", "feeFixedAmount", "feeFixedCurrency", "feature", "type", "country", "currency", "releaseType", "releaseDay", "minAmount", "maxAmount", "minAmountRestriction", "maxAmountRestriction", "maxInstallments" ] }, "PaymentOriginalCurrency": { "type": "object", "properties": { "totalAmount": { "type": "number" }, "currency": { "nullable": false, "$ref": "#/components/schemas/Currency" }, "conversionRate": { "type": "number" } }, "required": [ "totalAmount", "currency", "conversionRate" ] }, "PaymentStatus": { "type": "string", "enum": [ "creating", "pending-authorization", "programmed", "expired", "pending", "processing", "in-transit", "confirmed", "cancelled", "failed", "paid", "rejected", "refunded", "refunding", "refund-failed" ] }, "PaymentSchedule": { "type": "string", "enum": [ "instant", "programmed" ] }, "PaymentAction": { "type": "string", "enum": [ "send", "receive" ] }, "PaymentDetailEntityType": { "type": "string", "enum": [ "collection_document", "payable_document" ] }, "PaymentDetailItem": { "type": "object", "properties": { "id": { "type": "string" }, "item": { "type": "string" }, "qty": { "type": "number" }, "amount": { "type": "number" }, "description": { "type": "string" }, "url": { "type": "string" }, "entity": { "$ref": "#/components/schemas/PaymentDetailEntityType" } } }, "PaymentDetail": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDetailItem" } } } }, "RefundOriginType": { "type": "string", "enum": [ "card-valdation", "bank", "duemint", "psp", "user" ] }, "Refund": { "type": "object", "properties": { "refundPaymentId": { "type": "string" }, "originalPaymentId": { "type": "string" }, "origin": { "$ref": "#/components/schemas/RefundOriginType" }, "notes": { "type": "string" } }, "required": [ "refundPaymentId", "originalPaymentId", "origin" ] }, "PaymentStatementInfo": { "type": "object", "properties": { "isLastPayment": { "type": "boolean" }, "date": { "format": "date-time", "type": "string" }, "walletBalance": { "type": "number" }, "movementsCountAtStatement": { "type": "number" }, "statementId": { "type": "string" }, "indexAtStatement": { "type": "number" } } }, "Attachment": { "type": "object", "properties": { "_id": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false }, "mimeType": { "type": "string", "nullable": false }, "size": { "type": "number", "nullable": false } }, "required": [ "_id", "name", "mimeType", "size" ] }, "EventType": { "type": "string", "enum": [ "addressee-approved", "addressee-rejected", "alarm", "ai-task-created", "ai-task-updated", "approval-flow-created", "approval-flow-updated", "approval-flow-removed", "approval-operation-created", "approval-operation-updated", "approval-operation-removed", "approval-user-created", "approval-user-updated", "approval-user-removed", "automation", "auth-required-transaction", "auto-withdrawal-created", "auto-withdrawal-updated", "auto-withdrawal-successful", "auto-withdrawal-rejected", "auto-withdrawal-payment-successful", "auto-withdrawal-summary", "balance-checking-status", "bank-transfer-created", "bank-transfer-updated", "bank-payment-created", "bank-payment-updated", "bank-account-created", "bank-account-updated", "bank-account-removed", "bank-account-balance-checking-status", "bank-card-created", "bank-card-updated", "bank-card-removed", "bank-ticket-created", "bank-ticket-updated", "bank-ticket-removed", "billing-payment-error", "billing-payment-update", "block-contact", "card-created", "card-creation-request", "card-updated", "charge-created", "charge-updated", "client-division-enable", "client-division-disable", "clients-without-contacts", "collections-conciliation-created", "cobranza-online-agreement", "company-account-added", "company-account-created", "company-account-updated", "company-closed", "company-created", "company-updated", "company-user-disable", "company-user-remove", "company-wallet-module-updated", "company-payables-module-updated", "company-collection-module-updated", "config-brand", "config-payment-instructions", "credential-invalid", "credential-valid", "credential-updated", "credential-released", "deposit-approved", "deposit-created", "deposit-error", "duematch-conciliation-massive", "export-failed", "export-successful", "export-finished", "extra-judicial-alert-send", "forget-password", "fintoc-valid-credentials", "income-created", "income-updated", "integration-valid-credentials", "invoice-expire-executive-title", "invoices-assigned", "invoice-compromised-date-due", "invoices-nulled", "invoices-rejected", "judicial-invoice", "judicial-alert-send", "kyc-verification-level-success", "mail-verification", "new-addressee", "new-login", "new-subscriptor", "new-subscriptor-notice", "new-user-signer", "notification-request", "psp-payment-created", "psp-payment-updated", "psp-demo-payment-process", "password-changed", "payment-approved", "payment-created", "payment-failed", "payment-canceled", "payment-in-transit", "payment-receipt", "payment-received", "payment-rejected", "payment-request", "payment-request-from-match", "payment-succesfull-notice", "payment-successfull", "payment-unapproved", "payment-updated", "payment-wallet-to-wallet", "payment-link-received", "payment-link-received-collections", "payment-link-receipt", "pos-voucher-email", "pos-terminal-request-received", "pos-terminal-request-approved", "pos-terminal-request-rejected", "payment-register-commitment", "phone-verification", "phone-verified", "recipient-account-created", "recipient-account-updated", "recipient-account-removed", "recipient-created", "recipient-updated", "reimbursement-created", "reimbursement-failed", "refund-approved", "refund-failed", "refund-requested", "refund-status-update", "refund-successful", "role-permission-modified", "wallet-created", "wallet-updated", "wallet-removed", "wallet-request-created", "wallet-request-updated", "wallet-request-removed", "schedule-transfer-notice", "schedule-transfer-notice-rejected", "schedule-transfer-notice-succesful", "signature-expired", "signature-required", "signature-to-expire", "subscription-payment-error", "subscription-payment-error-notice", "subscription-payment-succesful", "subscription-payment-succesful-notice", "subscription-payment-upcoming-notice", "subscription-plan-cancelled-notice", "subscription-plan-modified-notice", "subscription-plan-paused-notice", "subscription-plan-renewed-notice", "subscriptor-tnc-agreed", "subscriptor-tnc-agreed-notice", "subscriptor-tnc-rejection", "subscriptor-tnc-rejection-notice", "support-access-requested", "task", "task-created", "task-updated", "transaction-created", "transaction-updated", "thread-message", "unsubscription-plan", "unsubscription-plan-notice", "user-created", "user-updated", "user-updated-kyc", "user-invitation", "user-invitation-success", "user-role-assigned-modified", "update-company-kyc2", "update-company-kyc3", "pending-credit-notes-notification", "credit-note-created", "payroll-rejected", "payroll-successful", "payroll-partially-excecuted", "payroll-failed", "payroll-canceled", "payroll-signature-required", "payroll-payable-rejected", "payroll-payable-rejected-summary", "payroll-export-failed", "payroll-export-successful", "conciliation-created", "conciliation-updated", "conciliation-deleted", "conciliation-group-created", "cron-job-triggered", "bank-link-source-creation-pending", "bank-link-error-verification", "integration-update", "kyc-record-updated", "payable-document-assignation-changed", "payable-document-purchase-order-linked", "rejection-failed", "rejection-successful", "rejection-successful-summary", "verified-transfer-created", "voucher-verification-approved", "voucher-verification-escalated", "voucher-verification-rejected", "voucher-verification-uploaded", "voucher-verification-required", "bank-account-sync-finished", "payin-conciliation-created" ] }, "EventLog": { "type": "object", "properties": { "operationToken": { "type": "string", "nullable": false, "readOnly": true }, "userId": { "type": "string", "readOnly": true }, "provider": { "type": "string", "enum": [ "amh", "duemint", "etpay", "flow", "fintoc", "mercado-pago", "prepago-los-heroes", "servipag", "security-hub", "shinkansen", "transbank", "virtualpos", "bci", "scotiabank", "getnet", "psp-demo", "banco-estado", "santander" ], "nullable": false, "readOnly": true }, "providerType": { "type": "string", "enum": [ "external-system", "internal-system", "external-user", "user", "admin" ], "nullable": false, "readOnly": true }, "date": { "format": "date-time", "type": "string", "nullable": false, "readOnly": true }, "type": { "nullable": false, "readOnly": true, "$ref": "#/components/schemas/EventType" }, "description": { "type": "string", "readOnly": true }, "attachment": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Attachment" } ] }, "metadata": { "type": "object" } }, "required": [ "operationToken", "providerType", "date", "type" ] }, "Signature": { "type": "object", "properties": { "securityExternalTokenId": { "type": "string", "nullable": true }, "approvalOperationId": { "type": "string" }, "approvalSignatureId": { "type": "string" }, "lastSignatureUserId": { "type": "string" } } }, "PaymentVerificationAttemptStatus": { "type": "string", "enum": [ "pending", "verified", "failed", "in-progress" ] }, "PaymentVerificationAttemptSourceSnapshot": { "type": "object", "properties": { "identificationType": { "$ref": "#/components/schemas/IdentificationType" }, "identificationNumber": { "type": "string" }, "bankCode": { "$ref": "#/components/schemas/BankCode" }, "accountNumber": { "type": "string" } }, "required": [ "identificationType", "identificationNumber", "bankCode", "accountNumber" ] }, "PaymentVerificationAttemptSnapshot": { "type": "object", "properties": { "chargeId": { "type": "string" }, "chargeIntentId": { "type": "string" }, "paymentId": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "amount": { "type": "number", "minimum": 0 }, "status": { "$ref": "#/components/schemas/PaymentVerificationAttemptStatus" }, "source": { "$ref": "#/components/schemas/PaymentVerificationAttemptSourceSnapshot" }, "walletId": { "type": "string" }, "paymentMethodId": { "type": "string" }, "provider": { "$ref": "#/components/schemas/Provider" }, "email": { "type": "string" } }, "required": [ "chargeId", "date", "amount", "status", "source", "walletId", "paymentMethodId", "provider" ] }, "VoucherVerificationAttemptStatus": { "type": "string", "enum": [ "awaiting-ai-review", "awaiting-manual-review", "approved-by-ai", "approved-manually", "rejected-manually", "rejected-by-ai" ] }, "VoucherVerificationAttempt": { "type": "object", "properties": { "_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/VoucherVerificationAttemptStatus" }, "file": { "$ref": "#/components/schemas/Attachment" }, "uploadedByUserId": { "type": "string" }, "reviewedByUserId": { "type": "string" }, "externalId": { "type": "string", "description": "External reference (e.g. tars task id) — reserved for AI flow" }, "reason": { "type": "string", "description": "Required on rejection; optional note on approval" }, "internalReason": { "type": "string", "description": "Technical internal reason (gate failures or AI hard reason) — admin-only" } }, "required": [ "_id", "status", "file", "uploadedByUserId" ] }, "Payment": { "type": "object", "properties": { "_id": { "type": "string" }, "companyId": { "type": "string", "nullable": false, "readOnly": true }, "operationToken": { "type": "string", "nullable": false, "readOnly": true }, "createdByProvider": { "nullable": true, "readOnly": true, "$ref": "#/components/schemas/Provider" }, "createdByProviderType": { "nullable": false, "readOnly": true, "$ref": "#/components/schemas/ProviderType" }, "createdByUserId": { "type": "string", "nullable": true, "readOnly": true }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "isDefault": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/PaymentType" }, "bankFeature": { "$ref": "#/components/schemas/PaymentBankFeature" }, "payrollIdentifier": { "type": "string" }, "maxAmountSplitIdentifier": { "type": "string" }, "payrollDetails": { "$ref": "#/components/schemas/PaymentPayrollDetailModel" }, "payrollId": { "type": "string" }, "executedAt": { "format": "date-time", "type": "string" }, "moneyReleaseAt": { "format": "date-time", "type": "string" }, "confirmedAt": { "format": "date-time", "type": "string", "description": "Date when the payment is confirmed" }, "refundedAt": { "format": "date-time", "type": "string", "description": "Date when the payment is refunded" }, "authorizationStatus": { "$ref": "#/components/schemas/AuthorizationStatus" }, "isAuthorizedRecipientAccount": { "type": "boolean" }, "isLastAuthorizationSignatureInExecution": { "type": "boolean" }, "authorizedAt": { "format": "date-time", "type": "string" }, "source": { "nullable": false, "allOf": [ { "$ref": "#/components/schemas/PaymentSpot" } ] }, "destination": { "$ref": "#/components/schemas/PaymentSpot" }, "chargeId": { "type": "string" }, "chargeIntentId": { "type": "string" }, "chargeIntentExternalId": { "type": "string" }, "autoWithdrawalId": { "type": "string" }, "autoWithdrawalRegisterId": { "type": "string" }, "paymentMethodId": { "type": "string" }, "methodSnapshot": { "$ref": "#/components/schemas/PaymentMethodSnapshot" }, "originalCurrency": { "$ref": "#/components/schemas/PaymentOriginalCurrency" }, "feeTotal": { "type": "number" }, "feeNet": { "type": "number" }, "feeTaxes": { "type": "number" }, "netAmount": { "type": "number" }, "totalAmount": { "type": "number" }, "currency": { "$ref": "#/components/schemas/Currency" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusDetail": { "type": "string", "description": "Status details in case of error" }, "schedule": { "$ref": "#/components/schemas/PaymentSchedule" }, "action": { "$ref": "#/components/schemas/PaymentAction" }, "detail": { "$ref": "#/components/schemas/PaymentDetail" }, "refund": { "$ref": "#/components/schemas/Refund" }, "incomeId": { "type": "string" }, "accountingDate": { "format": "date-time", "type": "string", "description": "Accounting date of the payment" }, "statementInfo": { "$ref": "#/components/schemas/PaymentStatementInfo" }, "pspMetadata": { "type": "object" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "transactionCode": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventLog" } }, "scheduledAt": { "format": "date-time", "type": "string" }, "isFirstDestinationTransfer": { "type": "boolean" }, "signature": { "$ref": "#/components/schemas/Signature" }, "externalId": { "type": "string" }, "isVerified": { "type": "boolean" }, "paymentVerificationAttemptId": { "type": "string" }, "paymentVerificationAttemptSnapshot": { "$ref": "#/components/schemas/PaymentVerificationAttemptSnapshot" }, "skipWalletUpdate": { "type": "boolean" }, "isAutomatic": { "type": "boolean" }, "requiresUserVoucher": { "type": "boolean" }, "branchOfficeId": { "type": "string" }, "voucherVerificationAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/VoucherVerificationAttempt" } } }, "required": [ "_id", "companyId", "operationToken", "createdByProvider", "createdByProviderType", "createdByUserId", "createdAt", "updatedAt", "paymentMethodId", "methodSnapshot", "feeTotal", "feeNet", "feeTaxes", "netAmount", "totalAmount", "currency", "status", "schedule", "action", "transactionCode", "events" ] } }, "parameters": { "companyId": { "name": "companyId", "required": true, "in": "header", "schema": { "type": "string" } } }, "securitySchemes": { "JWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT Bearer token." }, "CompanyId": { "type": "apiKey", "in": "header", "name": "X-DUEMINT-COMPANY-ID", "description": "Company ID header." } } }, "webhooks": { "webhook-payment-updated": { "post": { "tags": [ "treasury-webhooks" ], "summary": "Payment Updated", "description": "This webhook is called when a payment is updated.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string" }, "data": { "$ref": "#/components/schemas/Payment" } } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" } } } }, "webhook-collections-payment-reconciled": { "post": { "tags": [ "collections-webhooks" ], "summary": "Collections Payment Reconciled", "description": "This webhook is called when a payment is reconciled in collections.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string" }, "data": { "type": "object", "properties": { "conciliationUuid": { "type": "string" }, "conciliationDate": { "type": "string", "format": "date" }, "conciliationCurrency": { "type": "string" }, "conciliatedByUserId": { "type": "string", "nullable": true }, "conciliatedByExternalId": { "type": "string", "nullable": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionPayment" } }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionDocument" } }, "conciliatedDetails": { "type": "array", "items": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "paymentId": { "type": "string" }, "amount": { "type": "number" } } } } } } } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" } } } } }, "paths": { "/api/v1/collection-clients": { "patch": { "operationId": "CollectionClientsController_update", "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "DuemintAPIRequestCollectionClient", "type": "object", "properties": { "id": { "type": "string", "description": "Id único del cliente" }, "name": { "type": "string", "description": "Nombre o razón social del cliente" }, "taxId": { "type": "string", "description": "Código tributario del cliente. En el caso de ser un cliente chileno el RUT debe ser en formato es sin puntos y con guión (ej: 99999999-9)" }, "country": { "type": "string", "description": "Código ISO de 2 letras del país que se desea filtrar. Por ejemplo US para Estados Unidos o CL para Chile" }, "paymentTerm": { "type": "number", "description": "Días de plazo de pago por defecto para el cliente" }, "region": { "type": "string", "description": "Región del cliente" }, "city": { "type": "string", "description": "Ciudad del cliente" }, "address": { "type": "string", "description": "Dirección del cliente" }, "phone": { "type": "string", "description": "Télefono del cliente" }, "fax": { "type": "string", "description": "Fax del cliente" }, "zipcode": { "type": "string", "description": "Código Zip del cliente" }, "externalId": { "type": "number", "description": "Identificador externo (Útil para integración con sistemas externos)" }, "tags": { "type": "array", "description": "Conjunto de etiquetas para asociar al cliente", "items": { "type": "string" } }, "owners": { "type": "array", "description": "Conjunto de propietarios del documento", "items": { "properties": { "name": { "type": "string", "description": "Tipo de propietario. Ejemplo: Ejecutivo" }, "userId": { "type": "number", "description": "Id de usuario correspondiente al propietario" } } } } }, "required": [ "id", "name", "taxId", "country" ] } } } }, "responses": { "200": { "description": "Request correctly received. Does not guarantees the underlying operation. Underlying operation must be followed up on another endpoint.", "content": { "application/json": { "schema": { "title": "DuemintApiResponseCollectionClient", "$ref": "#/components/schemas/CollectionClient" } } } }, "400": { "description": "Invalid schema or request. Check the message array for more information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "error": { "type": "string", "default": "Bad Request" }, "message": { "type": "array", "items": { "type": "string" } } } } } } }, "401": { "description": "Missing or invalid authentication method. Check the message array for more information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "error": { "type": "string", "default": "Bad Request" }, "message": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Resource access forbidden. Request has been authenticated but does not have the required permission. Check the message array for more information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "error": { "type": "string", "default": "Bad Request" }, "message": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "The requested resource or associated resources were not found. Check the message array for more information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "error": { "type": "string", "default": "Bad Request" }, "message": { "type": "array", "items": { "type": "string" } } } } } } } }, "tags": [ "collection-clients" ], "security": [ { "JWT": [], "CompanyId": [] } ], "x-code-samples": [ { "lang": "curl", "source": "# Both JWT and CompanyId headers are REQUIRED (AND logic)" } ] } } } } ```