Payment Data Type

Subtypes
AutomatedPayment
Implemented Interfaces
Serializable
Properties
name data type description
fees number
paymentMethod PaymentMethodEnum
paymentOrder string
comment string
Properties inherited from AccountOperation
dueDate number
reference string
bankReference string
matchingAmounts array of MatchingAmount
parentCFEntities array of object
bankLot string
type string
excludedFromDunning boolean
orderNumber string
matchingAmount number
transactionCategory OperationCategoryEnum
accountCodeClientSide string
unMatchingAmount number
transactionDate number
occCode string
accountCode string
customerAccount CustomerAccount
matchingStatus MatchingStatusEnum
bankCollectionDate number
uuid string
occDescription string
amount number
depositDate number
Properties inherited from EnableEntity
active boolean
disabled boolean
Properties inherited from AuditableEntity
auditable Auditable
Properties inherited from BaseEntity
id number
transient boolean
version number

Example

{
  "fees" : 12345.0,
  "paymentMethod" : "TIP",
  "paymentOrder" : "...",
  "comment" : "...",
  "dueDate" : 12345,
  "reference" : "...",
  "bankReference" : "...",
  "matchingAmounts" : [ {
    "matchingAmount" : 12345.0,
    "accountOperation" : {
      "dueDate" : 12345,
      "reference" : "...",
      "bankReference" : "...",
      "matchingAmounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "bankLot" : "...",
      "type" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmount" : 12345.0,
      "transactionCategory" : "DEBIT",
      "accountCodeClientSide" : "...",
      "unMatchingAmount" : 12345.0,
      "transactionDate" : 12345,
      "occCode" : "...",
      "accountCode" : "...",
      "customerAccount" : { },
      "matchingStatus" : "C",
      "bankCollectionDate" : 12345,
      "uuid" : "...",
      "occDescription" : "...",
      "amount" : 12345.0,
      "depositDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "matchingCode" : {
      "matchingAmountCredit" : 12345.0,
      "matchingDate" : 12345,
      "matchingType" : "A_DERICT_DEBIT",
      "matchingAmountDebit" : 12345.0,
      "code" : "...",
      "matchingAmounts" : [ { }, { } ],
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  }, {
    "matchingAmount" : 12345.0,
    "accountOperation" : {
      "dueDate" : 12345,
      "reference" : "...",
      "bankReference" : "...",
      "matchingAmounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "bankLot" : "...",
      "type" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmount" : 12345.0,
      "transactionCategory" : "CREDIT",
      "accountCodeClientSide" : "...",
      "unMatchingAmount" : 12345.0,
      "transactionDate" : 12345,
      "occCode" : "...",
      "accountCode" : "...",
      "customerAccount" : { },
      "matchingStatus" : "P",
      "bankCollectionDate" : 12345,
      "uuid" : "...",
      "occDescription" : "...",
      "amount" : 12345.0,
      "depositDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "matchingCode" : {
      "matchingAmountCredit" : 12345.0,
      "matchingDate" : 12345,
      "matchingType" : "A_TIP",
      "matchingAmountDebit" : 12345.0,
      "code" : "...",
      "matchingAmounts" : [ { }, { } ],
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  } ],
  "parentCFEntities" : [ { }, { } ],
  "bankLot" : "...",
  "type" : "...",
  "excludedFromDunning" : true,
  "orderNumber" : "...",
  "matchingAmount" : 12345.0,
  "transactionCategory" : "DEBIT",
  "accountCodeClientSide" : "...",
  "unMatchingAmount" : 12345.0,
  "transactionDate" : 12345,
  "occCode" : "...",
  "accountCode" : "...",
  "customerAccount" : {
    "dueDateDelayEL" : "...",
    "dunningLevel" : "R4",
    "creditCategory" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "dateDunningLevel" : 12345,
    "customer" : {
      "customerBrand" : { },
      "parentEntity" : { },
      "contactInformation" : { },
      "seller" : { },
      "customerAccounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "mandateDate" : 12345,
      "parentEntityType" : { },
      "mandateIdentification" : "...",
      "customerCategory" : { },
      "defaultLevel" : true,
      "accountType" : "...",
      "name" : { },
      "externalRef1" : "...",
      "primaryContact" : { },
      "externalRef2" : "...",
      "providerContact" : "...",
      "address" : { },
      "businessAccountModel" : { },
      "uuid" : "...",
      "code" : "...",
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "billingAccounts" : [ {
      "status" : "TERMINATED",
      "billingRun" : { },
      "brAmountWithTax" : 12345.0,
      "paymentMethod" : "CHECK",
      "tradingCountry" : { },
      "parentCFEntities" : [ { }, { } ],
      "parentEntityType" : { },
      "billingCycle" : { },
      "brAmountWithoutTax" : 12345.0,
      "ratedTransactions" : [ { }, { } ],
      "terminationReason" : { },
      "invoicingThreshold" : 12345.0,
      "invoicePrefix" : "...",
      "statusDate" : 12345,
      "terminationDate" : 12345,
      "nextInvoiceDate" : 12345,
      "tradingLanguage" : { },
      "invoices" : [ { }, { } ],
      "bankCoordinates" : { },
      "discountRate" : 12345.0,
      "discountPlan" : { },
      "counters" : {
        "property1" : { },
        "property2" : { }
      },
      "subscriptionDate" : 12345,
      "billingRunLists" : [ { }, { } ],
      "parentEntity" : { },
      "invoiceAgregates" : [ { }, { } ],
      "email" : "...",
      "usersAccounts" : [ { }, { } ],
      "electronicBilling" : true,
      "customerAccount" : { },
      "paymentTerm" : "CASH",
      "defaultLevel" : true,
      "accountType" : "...",
      "name" : { },
      "externalRef1" : "...",
      "primaryContact" : { },
      "externalRef2" : "...",
      "providerContact" : "...",
      "address" : { },
      "businessAccountModel" : { },
      "uuid" : "...",
      "code" : "...",
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "status" : "TERMINATED",
      "billingRun" : { },
      "brAmountWithTax" : 12345.0,
      "paymentMethod" : "TIP",
      "tradingCountry" : { },
      "parentCFEntities" : [ { }, { } ],
      "parentEntityType" : { },
      "billingCycle" : { },
      "brAmountWithoutTax" : 12345.0,
      "ratedTransactions" : [ { }, { } ],
      "terminationReason" : { },
      "invoicingThreshold" : 12345.0,
      "invoicePrefix" : "...",
      "statusDate" : 12345,
      "terminationDate" : 12345,
      "nextInvoiceDate" : 12345,
      "tradingLanguage" : { },
      "invoices" : [ { }, { } ],
      "bankCoordinates" : { },
      "discountRate" : 12345.0,
      "discountPlan" : { },
      "counters" : {
        "property1" : { },
        "property2" : { }
      },
      "subscriptionDate" : 12345,
      "billingRunLists" : [ { }, { } ],
      "parentEntity" : { },
      "invoiceAgregates" : [ { }, { } ],
      "email" : "...",
      "usersAccounts" : [ { }, { } ],
      "electronicBilling" : true,
      "customerAccount" : { },
      "paymentTerm" : "CASH",
      "defaultLevel" : true,
      "accountType" : "...",
      "name" : { },
      "externalRef1" : "...",
      "primaryContact" : { },
      "externalRef2" : "...",
      "providerContact" : "...",
      "address" : { },
      "businessAccountModel" : { },
      "uuid" : "...",
      "code" : "...",
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "paymentMethod" : "TIP",
    "accountOperations" : [ {
      "dueDate" : 12345,
      "reference" : "...",
      "bankReference" : "...",
      "matchingAmounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "bankLot" : "...",
      "type" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmount" : 12345.0,
      "transactionCategory" : "CREDIT",
      "accountCodeClientSide" : "...",
      "unMatchingAmount" : 12345.0,
      "transactionDate" : 12345,
      "occCode" : "...",
      "accountCode" : "...",
      "customerAccount" : { },
      "matchingStatus" : "C",
      "bankCollectionDate" : 12345,
      "uuid" : "...",
      "occDescription" : "...",
      "amount" : 12345.0,
      "depositDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "dueDate" : 12345,
      "reference" : "...",
      "bankReference" : "...",
      "matchingAmounts" : [ { }, { } ],
      "parentCFEntities" : [ { }, { } ],
      "bankLot" : "...",
      "type" : "...",
      "excludedFromDunning" : true,
      "orderNumber" : "...",
      "matchingAmount" : 12345.0,
      "transactionCategory" : "DEBIT",
      "accountCodeClientSide" : "...",
      "unMatchingAmount" : 12345.0,
      "transactionDate" : 12345,
      "occCode" : "...",
      "accountCode" : "...",
      "customerAccount" : { },
      "matchingStatus" : "P",
      "bankCollectionDate" : 12345,
      "uuid" : "...",
      "occDescription" : "...",
      "amount" : 12345.0,
      "depositDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "parentEntityType" : { },
    "password" : "...",
    "actionDunnings" : [ {
      "creationDate" : 12345,
      "fromLevel" : "R0",
      "typeAction" : "FILE",
      "dunningLOT" : { },
      "status" : "T",
      "actionPlanItem" : { },
      "amountDue" : 12345.0,
      "toLevel" : "R1",
      "recordedInvoice" : { },
      "customerAccount" : { },
      "statusDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "creationDate" : 12345,
      "fromLevel" : "R0",
      "typeAction" : "FILE",
      "dunningLOT" : { },
      "status" : "E",
      "actionPlanItem" : { },
      "amountDue" : 12345.0,
      "toLevel" : "R0",
      "recordedInvoice" : { },
      "customerAccount" : { },
      "statusDate" : 12345,
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "mandateDate" : 12345,
    "parentCFEntities" : [ { }, { } ],
    "tradingCurrency" : {
      "prCurrencyToThis" : 12345.0,
      "prDescription" : "...",
      "currencyCode" : "...",
      "currency" : { },
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "contactInformation" : {
      "phone" : "...",
      "mobile" : "...",
      "email" : "...",
      "fax" : "..."
    },
    "tradingLanguage" : {
      "language" : { },
      "prDescription" : "...",
      "languageCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "status" : "ACTIVE",
    "dateStatus" : 12345,
    "mandateIdentification" : "...",
    "defaultLevel" : true,
    "accountType" : "...",
    "name" : {
      "lastName" : "...",
      "firstName" : "...",
      "title" : { },
      "fullName" : "..."
    },
    "externalRef1" : "...",
    "primaryContact" : {
      "address" : { },
      "mobile" : "...",
      "email" : "...",
      "lastName" : "...",
      "genericMail" : "...",
      "firstName" : "...",
      "phone" : "...",
      "fax" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "externalRef2" : "...",
    "providerContact" : "...",
    "address" : {
      "address2" : "...",
      "zipCode" : "...",
      "country" : "...",
      "state" : "...",
      "city" : "...",
      "countryBundle" : "...",
      "address1" : "...",
      "address3" : "..."
    },
    "businessAccountModel" : {
      "hierarchyType" : "CA_BA",
      "logoPicture" : "...",
      "script" : { },
      "moduleItems" : [ { }, { } ],
      "downloaded" : true,
      "installed" : true,
      "license" : "BSD3_N",
      "moduleSource" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "uuid" : "...",
    "code" : "...",
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  },
  "matchingStatus" : "L",
  "bankCollectionDate" : 12345,
  "uuid" : "...",
  "occDescription" : "...",
  "amount" : 12345.0,
  "depositDate" : 12345,
  "active" : true,
  "disabled" : true,
  "auditable" : {
    "lastModified" : 12345,
    "updater" : "...",
    "created" : 12345,
    "updated" : 12345,
    "creator" : "...",
    "lastUser" : "..."
  },
  "id" : 12345,
  "transient" : true,
  "version" : 12345
}