| name | data type | constraints | description |
|---|---|---|---|
| parentEntity | BusinessEntity | ||
| descriptionAndCode | string | ||
| appendGeneratedCode | boolean | ||
| paymentGateway | PaymentGateway | ||
| referenceDescription | string | ||
| parentEntityType | object | ||
| auditable | Auditable | ||
| version | number | ||
| genericSequence | GenericSequence | ||
| descriptionOrCode | string | ||
| auditableFields | array of AuditableFieldHistory | ||
| codeChanged | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| transient | boolean | ||
| description | string | max size: 255, min size: 0 | |
| referenceCode | string | ||
| historized | boolean | ||
| notified | boolean | ||
| id | number |
Example
{
"parentEntity" : {
"auditableFields" : [ {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "STATUS",
"historized" : true
}, {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "RENEWAL",
"historized" : true
} ],
"description" : "...",
"version" : 12345,
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"auditable" : {
"updater" : "...",
"updated" : 12345,
"creator" : "...",
"lastUser" : "...",
"created" : 12345,
"lastModified" : 12345
},
"codeChanged" : true,
"parentEntityType" : { },
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"transient" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"historized" : true,
"referenceCode" : "...",
"code" : "..."
},
"descriptionAndCode" : "...",
"appendGeneratedCode" : true,
"paymentGateway" : {
"historized" : true,
"errorsToReplay" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"disabled" : true,
"parentCFEntities" : [ {
"cfValuesNullSafe" : { },
"dirtyCF" : true,
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"cfAccumulatedValues" : { },
"uuid" : "...",
"CFValuesCopy" : { }
}, {
"cfValuesNullSafe" : { },
"dirtyCF" : true,
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"cfAccumulatedValues" : { },
"uuid" : "...",
"CFValuesCopy" : { }
} ],
"scriptInstance" : {
"auditable" : { },
"notified" : true,
"executionRoles" : [ "...", "..." ],
"auditableFields" : [ { }, { } ],
"sourceTypeEnum" : "JAVA",
"appendGeneratedCode" : true,
"referenceDescription" : "...",
"id" : 12345,
"codeChanged" : true,
"active" : true,
"version" : 12345,
"reuse" : true,
"error" : true,
"descriptionOrCode" : "...",
"parentEntityType" : { },
"parentEntity" : { },
"sourcingRoles" : [ "...", "..." ],
"disabled" : true,
"referenceCode" : "...",
"scriptInstanceCategory" : { },
"historized" : true,
"scriptErrors" : [ { }, { } ],
"transient" : true,
"code" : "...",
"description" : "...",
"script" : "...",
"descriptionAndCode" : "..."
},
"referenceCode" : "...",
"secretKeyKS" : "...",
"secretKey" : "...",
"notified" : true,
"replayCause" : "REJECT",
"referenceDescription" : "...",
"auditableFields" : [ {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "STATUS",
"historized" : true
}, {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "STATUS",
"historized" : true
} ],
"applicationEL" : "...",
"transient" : true,
"description" : "...",
"nbTries" : 12345,
"webhooksKeyId" : "...",
"descriptionAndCode" : "...",
"version" : 12345,
"paymentMethodType" : "CARD",
"bankCoordinates" : {
"accountNumber" : "...",
"issuerNumber" : "...",
"bankId" : "...",
"key" : "...",
"branchCode" : "...",
"bankName" : "...",
"issuerName" : "...",
"bankCode" : "...",
"iban" : "...",
"ics" : "...",
"accountOwner" : "...",
"bic" : "..."
},
"seller" : {
"customerSequences" : [ { }, { } ],
"notified" : true,
"contracts" : [ { }, { } ],
"descriptionOrCode" : "...",
"vatNo" : "...",
"referenceCode" : "...",
"appendGeneratedCode" : true,
"code" : "...",
"paymentGateways" : [ { }, { } ],
"parentEntityType" : { },
"invoiceTypeSequence" : [ { }, { } ],
"tradingCountry" : { },
"description" : "...",
"name" : { },
"minimumAmountEl" : "...",
"descriptionAndCode" : "...",
"primaryContact" : { },
"legalType" : "...",
"parentEntity" : { },
"cfValues" : { },
"seller" : { },
"defaultLevel" : true,
"legalEntityType" : { },
"isCompany" : true,
"auditable" : { },
"cfAccumulatedValues" : { },
"registrationNo" : "...",
"providerContact" : "...",
"transient" : true,
"minimumChargeTemplate" : { },
"parentCFEntities" : [ { }, { } ],
"referenceDescription" : "...",
"contactInformation" : { },
"codeChanged" : true,
"version" : 12345,
"minimumLabelEl" : "...",
"externalRef1" : "...",
"id" : 12345,
"historized" : true,
"externalRef2" : "...",
"contactInformationNullSafe" : { },
"accountType" : "...",
"legalText" : "...",
"generalLedger" : { },
"uuid" : "...",
"address" : { },
"jobTitle" : "...",
"tradingLanguage" : { },
"auditableFields" : [ { }, { } ],
"tradingCurrency" : { },
"minimumArticle" : { },
"businessAccountModel" : { }
},
"tradingCurrency" : {
"currentRate" : 12345.0,
"disabled" : true,
"currency" : { },
"auditable" : { },
"prCurrencyToThis" : 12345.0,
"version" : 12345,
"currentRateFromDate" : 12345,
"active" : true,
"id" : 12345,
"historized" : true,
"currentRateUpdater" : "...",
"auditableFields" : [ { }, { } ],
"decimalPlaces" : 12345,
"transient" : true,
"currencyCode" : "...",
"exchangeRates" : [ { }, { } ],
"symbol" : "...",
"notified" : true,
"prDescription" : "..."
},
"parentEntity" : {
"auditableFields" : [ { }, { } ],
"description" : "...",
"version" : 12345,
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"auditable" : { },
"codeChanged" : true,
"parentEntityType" : { },
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"transient" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"historized" : true,
"referenceCode" : "...",
"code" : "..."
},
"code" : "...",
"id" : 12345,
"apiKey" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"uuid" : "...",
"rumSequence" : {
"parentEntity" : { },
"descriptionAndCode" : "...",
"appendGeneratedCode" : true,
"paymentGateway" : { },
"referenceDescription" : "...",
"parentEntityType" : { },
"auditable" : { },
"version" : 12345,
"genericSequence" : { },
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"code" : "...",
"transient" : true,
"description" : "...",
"referenceCode" : "...",
"historized" : true,
"notified" : true,
"id" : 12345
},
"appendGeneratedCode" : true,
"parentEntityType" : { },
"implementationClassName" : "...",
"secretKeyDB" : "...",
"webhooksSecretKey" : "...",
"profile" : "...",
"country" : {
"description" : "...",
"historized" : true,
"currency" : { },
"version" : 12345,
"transient" : true,
"auditable" : { },
"code" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"countryCode" : "...",
"id" : 12345,
"language" : { },
"notified" : true,
"auditableFields" : [ { }, { } ],
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
}
},
"auditable" : {
"updater" : "...",
"updated" : 12345,
"creator" : "...",
"lastUser" : "...",
"created" : 12345,
"lastModified" : 12345
},
"descriptionOrCode" : "...",
"type" : "CUSTOM",
"cardType" : "AMERICAN_EXPRESS",
"active" : true,
"codeChanged" : true,
"marchandId" : "..."
},
"referenceDescription" : "...",
"parentEntityType" : { },
"auditable" : {
"updater" : "...",
"updated" : 12345,
"creator" : "...",
"lastUser" : "...",
"created" : 12345,
"lastModified" : 12345
},
"version" : 12345,
"genericSequence" : {
"currentSequenceNb" : 12345,
"prefix" : "...",
"sequenceSize" : 12345
},
"descriptionOrCode" : "...",
"auditableFields" : [ {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "OTHER",
"historized" : true
}, {
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notified" : true,
"notfiable" : true,
"previousState" : { },
"auditType" : "RENEWAL",
"historized" : true
} ],
"codeChanged" : true,
"code" : "...",
"transient" : true,
"description" : "...",
"referenceCode" : "...",
"historized" : true,
"notified" : true,
"id" : 12345
}