YOM Docs

Untitled

Untitled

Untitled

Pagos

Los Pagos en el sistema de YOM son registros que documentan las transacciones entre clientes y la empresa. Aquí se detallan los campos esenciales para registrar y gestionar estos pagos de manera precisa.

Carpeta y nombre de archivos

Entidad → payment

/<nombre_cliente>
	/production
		/load
			/payment
				/all
					20240201_180000_payment.csv
					...
				/created
					...
				/updated
					...
	/development
		...

Payment

La entidad payment.

Campo Tipo Carácter Descripción Ejemplos
paymentId 📝 Texto 🟢 Requerido Identificador único del Pago. "PAY001"
internalPaymentId 🆔 ObjectId 🟡 Opcional Identificador único del Pago.
**Generado por YOM
Se envía en el evento payment.created "YOM-PAY001"
commerceId 📝 Texto 🟢 Requerido Identificador único del Comercio. "CLI001"
voucherId 📝 Texto 🟡 Opcional Identificador único del comprobante emitido como evidencia del Pago.
*Puede estar relacionado a más de un Pago. "VOU001"
date 📝 Texto 🟢 Requerido Fecha de creación del Pago en formato ISO 8601. "2024-07-01T10:30:00.000Z"
status 📝 Texto 🟢 Requerido Estado actual del Pago.
"pending" → pago pendiente de procesar
"processed" → pago procesado
"accepted" → pago aceptado
"rejected" → pago rechazado "pending"
"processed"
"accepted"
"rejected"
amount 🔢 Número 🟢 Requerido Monto total del Pago. 500.00
currencyCode 📝 Texto 🟢 Requerido Código de moneda en formato ISO 4217.
"CLP"
"USD"
"COL"
"PEN"
"MXN" "CLP"
"USD"
"COL"
"PEN"
"MXN"
source 📝 Objeto → paymentSource 🟢 Requerido Información sobre el origen del registro del Pago.
paymentDocuments 🔡 Lista de Objetos → PaymentDocument 🟢 Requerido Lista con el detalle de los Documentos financieros sobre los que se hace el Pago.
paymentDetails 🔡 Lista de Objetos → PaymentDetail 🟢 Requerido Lista que contiene los detalles de cada forma de pago utilizada para realizar el Pago.
observation 📝 Texto 🟡 Opcional Observaciones acerca del Pago. "pagado en local 221"

PaymentDocument

La estructura paymentDocuments permite detallar los documentos tributarios sobre los que se efectua el Pago, con los montos del Pago asignados al Documento.

Campo Tipo Carácter Descripción Ejemplos
document Objeto → FinancialDocument 🟢 Requerido Documento Financiero relacionado al Pago.
paymentAmount 🔢 Número 🟢 Requerido Monto pagado sobre el Documento.
*menor o igual a documentAmount 1000.00

PaymentDetail

La estructura paymentDetails permite detallar cada forma de pago utilizada para el Pago.

Campo Tipo Carácter Descripción Ejemplos
type 📝 Texto 🟢 Requerido Tipo de forma de Pago utilizada.
cash → Efectivo
check → Cheque
transfer → Transferencia
card → Tarjeta "DOC12345”
amount 🔢 Número 🟢 Requerido Monto específico pagado utilizando esta forma de pago. 20000
globalUserId 📝 Texto 🟢 Requerido RUT / CI de quien emite el Pago. "76345678-9”
paymentDocumentId 📝 Texto 🟢 Requerido Id del PaymentDocument asociado este detalle "CRED001”
transactionId 📝 Texto 🟡 Opcional Identificador único de la transacción bancaria o de tarjeta. "TRX12345”
bankName 📝 Texto 🟡 Opcional Nombre del Banco asociado al Detalle. "Banco Estado”
bankAccount 📝 Texto 🟡 Opcional Número de cuenta bancaria utilizada para el pago. "123456789”
bankAccountType 📝 Texto 🟡 Opcional Tipo de cuenta bancaria utilizada.
checking → Cuenta Corriente
savings → Cuenta de Ahorro
sight → Cuenta Vista checking
savings
sight
cardType 📝 Texto 🟡 Opcional Tipo de tarjeta utilizada.
credit → Crédito
debit → Débito credit
debit
checkDate 📅 Fecha 🟡 Opcional Fecha de cobro para cheques a fecha en formato ISO 8601. "2024-12-15T00:00:00.000Z”
checkNumber 📝 Texto 🟡 Opcional Número del cheque. "0009233”

PaymentSource

La estructura paymentSource contiene información sobre el origen del registro del Pago.

Campo Tipo Carácter Descripción Ejemplos
type 📝 Texto 🟢 Requerido Tipo de origen del registro del Pago.
seller → Registrado por un Vendedor
external → Registrado fuera de la plataforma Yom seller
external
sourceId 📝 Texto 🟡 Opcional Identificador único del origen.
*Si el tipo es seller corresponde al sellerId. SELL001

Respuesta

La gestión eficiente de Pagos en YOM asegura una transparencia y seguimiento adecuado de todas las transacciones financieras realizadas con los clientes.

Ejemplo de Respuesta

{
  "paymentId": "PAY001",
  "commerceId": "CLI001",
  "voucherId": "VOU001",
  "date": "2024-07-01T10:30:00.000Z",
  "status": "accepted",
  "amount": 100000,
  "currencyCode": "CLP",
  "source": {
    "type": "seller",
    "sourceId": "SELL001"
  },
  "observation": "Pago realizado por varias formas.",
  "paymentDocuments": [
    {
      "document": {
			  "documentId": "INV001",
			  "governmentDocumentId": "123456789",
			  "type": "credit_note",
			  "commerceId": "COM001",
			  "dueDate": "2024-07-15T00:00:00.000Z",
			  "date": "2024-07-01T00:00:00.000Z",
			  "pricing": {
			    "subtotalAmount": 10000.00,
			    "totalAmount": 10000.00,
			    "taxAmount": 0
			  },
			  "sellerId": "SELLER001",
			  "collectionStatus": "in_collection"
			}
      "paymentAmount": 100000
    }
  ],
  "paymentDetails": [
    {
      "type": "check",
      "amount": 30000,
      "globalUserId": "76345678-9",
      "paymentDocumentId": "INV001",
      "transactionId": "TRX00123",
      "bankName": "Banco Estado",
      "bankAccount": "123456789",
      "bankAccountType": "checking",
      "checkDate": "2024-07-15T00:00:00.000Z",
      "checkNumber": "0009233"
    },
    {
      "type": "transfer",
      "amount": 70000,
      "globalUserId": "76345678-9",
      "paymentDocumentId": "INV001",
      "transactionId": "TRX00456",
      "bankName": "Banco de Chile",
      "bankAccount": "987654321",
      "bankAccountType": "savings"
    }
  ],
  "internalPaymentId": "YOM-PAY001", # Generado por Yom
}

CSV Aplanado

paymentId;commerceId;voucherId;date;status;amount;currencyCode;source_type;source_id;paymentDocuments_0_documentId;paymentDocuments_0_parentDocumentId;paymentDocuments_0_taxEntityDocumentId;paymentDocuments_0_parentTaxEntityDocumentId;paymentDocuments_0_date;paymentDocuments_0_dueDate;paymentDocuments_0_documentType;paymentDocuments_0_documentAmount;paymentDocuments_0_paymentAmount;paymentDetails_0_type;paymentDetails_0_amount;paymentDetails_0_globalUserId;paymentDetails_0_transactionId;paymentDetails_0_bankName;paymentDetails_0_bankAccount;paymentDetails_0_bankAccountType;paymentDetails_0_cardType;paymentDetails_0_checkDate
PAY001;CLI001;VOU001;2024-07-01T10:30:00.000Z;accepted;100000;CLP;seller;SELL001;DOC12345;;11401031;;2024-06-30T10:30:00.000Z;2024-07-15T10:30:00.000Z;invoice;120000;100000;transfer;100000;76345678-9;TRX00456;Banco de Chile;987654321;savings;;

Lista de campos CSV

Columna Valor
paymentId PAY001
commerceId CLI001
voucherId VOU001
date 2024-07-01T10:30:00.000Z
status accepted
amount 100000
currencyCode CLP
source_type seller
source_id SELL001
paymentDocuments_0_documentId DOC12345
paymentDocuments_0_parentDocumentId
paymentDocuments_0_taxEntityDocumentId 11401031
paymentDocuments_0_parentTaxEntityDocumentId
paymentDocuments_0_date 2024-06-30T10:30:00.000Z
paymentDocuments_0_dueDate 2024-07-15T10:30:00.000Z
paymentDocuments_0_documentType invoice
paymentDocuments_0_documentAmount 120000
paymentDocuments_0_paymentAmount 100000
paymentDetails_0_type transfer
paymentDetails_0_amount 100000
paymentDetails_0_globalUserId 76345678-9
paymentDetails_0_transactionId TRX00456
paymentDetails_0_bankName Banco de Chile
paymentDetails_0_bankAccount 987654321

Estos campos permiten una correcta documentación y seguimiento de los pagos realizados en el sistema, asegurando la integridad y precisión de la información financiera de YOM.