PaymentHistoryDto Data Type

Class to represent payments that was initiated from OC, we find payment done, ,pending,rejected and error.

Implemented Interfaces
Serializable
Properties
name data type description
auditableField array of AuditableFieldDto
customerAccountCode string The customer Account Code.
sellerCode string The seller Code.
customerAccountName string The customer Account Name.
operationDate number The operation date.
updatedStatusDate number The updated status date.
lastUpdateDate number The last Update Date.
amountCts number The amount in cts.
syncStatus PaymentStatusEnum The synchrone status.
asyncStatus PaymentStatusEnum The asynchrone status.
status PaymentStatusEnum The status.
externalPaymentId string The external payment id.
errorCode string The error code.
errorMessage string The error message.
errorType PaymentErrorTypeEnum The error type, rejected or error.
paymentGatewayCode string The payment gateway.
paymentMethodType PaymentMethodEnum The payment method.
paymentMethodName string The payment method name: card number or mandat.
operationCategory OperationCategoryEnum The operation category, credit for payment or debit for refund.
payment AccountOperationDto The payment.
refund AccountOperationDto The refund.
listAoPaid AccountOperationsDto The list ao paid.

Example

{
  "auditableField" : [ {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  }, {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  } ],
  "customerAccountCode" : "...",
  "sellerCode" : "...",
  "customerAccountName" : "...",
  "operationDate" : 12345,
  "updatedStatusDate" : 12345,
  "lastUpdateDate" : 12345,
  "amountCts" : 12345,
  "syncStatus" : "NOT_PROCESSED",
  "asyncStatus" : "REJECTED",
  "status" : "ACCEPTED",
  "externalPaymentId" : "...",
  "errorCode" : "...",
  "errorMessage" : "...",
  "errorType" : "ERROR",
  "paymentGatewayCode" : "...",
  "paymentMethodType" : "WIRETRANSFER",
  "paymentMethodName" : "...",
  "operationCategory" : "DEBIT",
  "payment" : {
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "id" : 12345,
    "dueDate" : 12345,
    "type" : "...",
    "transactionDate" : 12345,
    "transactionCategory" : "DEBIT",
    "reference" : "...",
    "accountingCode" : "...",
    "amount" : 12345.0,
    "amountWithoutTax" : 12345.0,
    "taxAmount" : 12345.0,
    "matchingAmount" : 12345.0,
    "unMatchingAmount" : 12345.0,
    "matchingStatus" : "R",
    "code" : "...",
    "description" : "...",
    "customerAccount" : "...",
    "excludedFromDunning" : true,
    "orderNumber" : "...",
    "matchingAmounts" : {
      "matchingAmount" : [ { }, { } ]
    },
    "otherCreditAndCharge" : {
      "operationDate" : 12345,
      "auditableField" : [ { }, { } ],
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "DEBIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "P",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "EXPORTED",
      "reason" : "CLOSED_PERIOD",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "recordedInvoice" : {
      "productionDate" : 12345,
      "invoiceDate" : 12345,
      "auditableField" : [ { }, { } ],
      "netToPay" : 12345.0,
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "CREDIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "O",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "POSTED",
      "reason" : "CLOSED_PERIOD",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "rejectedPayment" : {
      "rejectedType" : "M",
      "rejectedDate" : 12345,
      "auditableField" : [ { }, { } ],
      "rejectedDescription" : "...",
      "rejectedCode" : "...",
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "CREDIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "C",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "EXPORT_FAILED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "bankLot" : "...",
    "bankReference" : "...",
    "bankCollectionDate" : 12345,
    "depositDate" : 12345,
    "paymentMethod" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "paymentInfo" : "...",
    "paymentInfo1" : "...",
    "paymentInfo2" : "...",
    "paymentInfo3" : "...",
    "paymentInfo4" : "...",
    "paymentInfo5" : "...",
    "paymentInfo6" : "...",
    "billingAccountName" : "...",
    "paymentHistory" : [ {
      "auditableField" : [ { }, { } ],
      "customerAccountCode" : "...",
      "sellerCode" : "...",
      "customerAccountName" : "...",
      "operationDate" : 12345,
      "updatedStatusDate" : 12345,
      "lastUpdateDate" : 12345,
      "amountCts" : 12345,
      "syncStatus" : "REJECTED",
      "asyncStatus" : "NOT_PROCESSED",
      "status" : "ACCEPTED",
      "externalPaymentId" : "...",
      "errorCode" : "...",
      "errorMessage" : "...",
      "errorType" : "REJECT",
      "paymentGatewayCode" : "...",
      "paymentMethodType" : "WIRETRANSFER",
      "paymentMethodName" : "...",
      "operationCategory" : "DEBIT",
      "payment" : { },
      "refund" : { },
      "listAoPaid" : { }
    }, {
      "auditableField" : [ { }, { } ],
      "customerAccountCode" : "...",
      "sellerCode" : "...",
      "customerAccountName" : "...",
      "operationDate" : 12345,
      "updatedStatusDate" : 12345,
      "lastUpdateDate" : 12345,
      "amountCts" : 12345,
      "syncStatus" : "PENDING",
      "asyncStatus" : "ERROR",
      "status" : "ERROR",
      "externalPaymentId" : "...",
      "errorCode" : "...",
      "errorMessage" : "...",
      "errorType" : "ERROR",
      "paymentGatewayCode" : "...",
      "paymentMethodType" : "PAYPAL",
      "paymentMethodName" : "...",
      "operationCategory" : "DEBIT",
      "payment" : { },
      "refund" : { },
      "listAoPaid" : { }
    } ],
    "collectionDate" : 12345,
    "journalCode" : "...",
    "status" : "POSTED",
    "reason" : "FORCED",
    "accountingExportFile" : "...",
    "accountingDate" : 12345
  },
  "refund" : {
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "id" : 12345,
    "dueDate" : 12345,
    "type" : "...",
    "transactionDate" : 12345,
    "transactionCategory" : "DEBIT",
    "reference" : "...",
    "accountingCode" : "...",
    "amount" : 12345.0,
    "amountWithoutTax" : 12345.0,
    "taxAmount" : 12345.0,
    "matchingAmount" : 12345.0,
    "unMatchingAmount" : 12345.0,
    "matchingStatus" : "I",
    "code" : "...",
    "description" : "...",
    "customerAccount" : "...",
    "excludedFromDunning" : true,
    "orderNumber" : "...",
    "matchingAmounts" : {
      "matchingAmount" : [ { }, { } ]
    },
    "otherCreditAndCharge" : {
      "operationDate" : 12345,
      "auditableField" : [ { }, { } ],
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "DEBIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "R",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "EXPORTED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "recordedInvoice" : {
      "productionDate" : 12345,
      "invoiceDate" : 12345,
      "auditableField" : [ { }, { } ],
      "netToPay" : 12345.0,
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "CREDIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "C",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "POSTED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "rejectedPayment" : {
      "rejectedType" : "A",
      "rejectedDate" : 12345,
      "auditableField" : [ { }, { } ],
      "rejectedDescription" : "...",
      "rejectedCode" : "...",
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "DEBIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "I",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "EXPORTED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    },
    "bankLot" : "...",
    "bankReference" : "...",
    "bankCollectionDate" : 12345,
    "depositDate" : 12345,
    "paymentMethod" : "...",
    "customFields" : {
      "customField" : [ { }, { } ],
      "inheritedCustomField" : [ { }, { } ]
    },
    "paymentInfo" : "...",
    "paymentInfo1" : "...",
    "paymentInfo2" : "...",
    "paymentInfo3" : "...",
    "paymentInfo4" : "...",
    "paymentInfo5" : "...",
    "paymentInfo6" : "...",
    "billingAccountName" : "...",
    "paymentHistory" : [ {
      "auditableField" : [ { }, { } ],
      "customerAccountCode" : "...",
      "sellerCode" : "...",
      "customerAccountName" : "...",
      "operationDate" : 12345,
      "updatedStatusDate" : 12345,
      "lastUpdateDate" : 12345,
      "amountCts" : 12345,
      "syncStatus" : "ERROR",
      "asyncStatus" : "NOT_PROCESSED",
      "status" : "NOT_PROCESSED",
      "externalPaymentId" : "...",
      "errorCode" : "...",
      "errorMessage" : "...",
      "errorType" : "REJECT",
      "paymentGatewayCode" : "...",
      "paymentMethodType" : "PAYPAL",
      "paymentMethodName" : "...",
      "operationCategory" : "CREDIT",
      "payment" : { },
      "refund" : { },
      "listAoPaid" : { }
    }, {
      "auditableField" : [ { }, { } ],
      "customerAccountCode" : "...",
      "sellerCode" : "...",
      "customerAccountName" : "...",
      "operationDate" : 12345,
      "updatedStatusDate" : 12345,
      "lastUpdateDate" : 12345,
      "amountCts" : 12345,
      "syncStatus" : "ERROR",
      "asyncStatus" : "ACCEPTED",
      "status" : "REJECTED",
      "externalPaymentId" : "...",
      "errorCode" : "...",
      "errorMessage" : "...",
      "errorType" : "ERROR",
      "paymentGatewayCode" : "...",
      "paymentMethodType" : "CASH",
      "paymentMethodName" : "...",
      "operationCategory" : "DEBIT",
      "payment" : { },
      "refund" : { },
      "listAoPaid" : { }
    } ],
    "collectionDate" : 12345,
    "journalCode" : "...",
    "status" : "REJECTED",
    "reason" : "REJECTED",
    "accountingExportFile" : "...",
    "accountingDate" : 12345
  },
  "listAoPaid" : {
    "accountOperation" : [ {
      "auditableField" : [ { }, { } ],
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "DEBIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "O",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "EXPORTED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    }, {
      "auditableField" : [ { }, { } ],
      "id" : 12345,
      "dueDate" : 12345,
      "type" : "...",
      "transactionDate" : 12345,
      "transactionCategory" : "CREDIT",
      "reference" : "...",
      "accountingCode" : "...",
      "amount" : 12345.0,
      "amountWithoutTax" : 12345.0,
      "taxAmount" : 12345.0,
      "matchingAmount" : 12345.0,
      "unMatchingAmount" : 12345.0,
      "matchingStatus" : "L",
      "code" : "...",
      "description" : "...",
      "customerAccount" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmounts" : { },
      "otherCreditAndCharge" : { },
      "recordedInvoice" : { },
      "rejectedPayment" : { },
      "bankLot" : "...",
      "bankReference" : "...",
      "bankCollectionDate" : 12345,
      "depositDate" : 12345,
      "paymentMethod" : "...",
      "customFields" : { },
      "paymentInfo" : "...",
      "paymentInfo1" : "...",
      "paymentInfo2" : "...",
      "paymentInfo3" : "...",
      "paymentInfo4" : "...",
      "paymentInfo5" : "...",
      "paymentInfo6" : "...",
      "billingAccountName" : "...",
      "paymentHistory" : [ { }, { } ],
      "collectionDate" : 12345,
      "journalCode" : "...",
      "status" : "POSTED",
      "reason" : "FORCED",
      "accountingExportFile" : "...",
      "accountingDate" : 12345
    } ]
  }
}