| name | data type | constraints | description |
|---|---|---|---|
| description | string | max size: 255, min size: 0 | |
| code | string | required, max size: 255, min size: 1 | |
| codeChanged | boolean | ||
| referenceDescription | string | ||
| descriptionOrCode | string | ||
| seller | Seller | ||
| auditable | Auditable | ||
| notified | boolean | ||
| descriptionAndCode | string | ||
| parentEntityType | object | ||
| auditableFields | array of AuditableFieldHistory | ||
| referenceCode | string | ||
| transient | boolean | ||
| version | number | ||
| genericSequence | GenericSequence | ||
| historized | boolean | ||
| appendGeneratedCode | boolean | ||
| id | number | ||
| parentEntity | BusinessEntity |
Example
{
"description" : "...",
"code" : "...",
"codeChanged" : true,
"referenceDescription" : "...",
"descriptionOrCode" : "...",
"seller" : {
"externalRef2" : "...",
"parentEntityType" : { },
"paymentGateways" : [ {
"cardType" : "AMERICAN_EXPRESS",
"code" : "...",
"tradingCurrency" : { },
"descriptionAndCode" : "...",
"replayCause" : "ERROR",
"version" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"webhooksSecretKey" : "...",
"description" : "...",
"disabled" : true,
"codeChanged" : true,
"cfAccumulatedValues" : { },
"nbTries" : 12345,
"marchandId" : "...",
"errorsToReplay" : "...",
"secretKeyKS" : "...",
"referenceCode" : "...",
"seller" : { },
"scriptInstance" : { },
"active" : true,
"parentEntityType" : { },
"country" : { },
"secretKey" : "...",
"applicationEL" : "...",
"type" : "CUSTOM",
"referenceDescription" : "...",
"profile" : "...",
"uuid" : "...",
"cfValues" : { },
"secretKeyDB" : "...",
"auditable" : { },
"apiKey" : "...",
"descriptionOrCode" : "...",
"id" : 12345,
"transient" : true,
"bankCoordinates" : { },
"historized" : true,
"webhooksKeyId" : "...",
"paymentMethodType" : "PAYPAL",
"rumSequence" : { },
"parentEntity" : { },
"implementationClassName" : "...",
"parentCFEntities" : [ { }, { } ],
"auditableFields" : [ { }, { } ]
}, {
"cardType" : "CB",
"code" : "...",
"tradingCurrency" : { },
"descriptionAndCode" : "...",
"replayCause" : "REJECT",
"version" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"webhooksSecretKey" : "...",
"description" : "...",
"disabled" : true,
"codeChanged" : true,
"cfAccumulatedValues" : { },
"nbTries" : 12345,
"marchandId" : "...",
"errorsToReplay" : "...",
"secretKeyKS" : "...",
"referenceCode" : "...",
"seller" : { },
"scriptInstance" : { },
"active" : true,
"parentEntityType" : { },
"country" : { },
"secretKey" : "...",
"applicationEL" : "...",
"type" : "NATIF",
"referenceDescription" : "...",
"profile" : "...",
"uuid" : "...",
"cfValues" : { },
"secretKeyDB" : "...",
"auditable" : { },
"apiKey" : "...",
"descriptionOrCode" : "...",
"id" : 12345,
"transient" : true,
"bankCoordinates" : { },
"historized" : true,
"webhooksKeyId" : "...",
"paymentMethodType" : "WIRETRANSFER",
"rumSequence" : { },
"parentEntity" : { },
"implementationClassName" : "...",
"parentCFEntities" : [ { }, { } ],
"auditableFields" : [ { }, { } ]
} ],
"contactInformation" : {
"fax" : "...",
"email" : "...",
"phone" : "...",
"mobile" : "..."
},
"isCompany" : true,
"minimumChargeTemplate" : {
"invoiceSubCategory" : { },
"inputUnitEL" : "...",
"historized" : true,
"status" : "ARCHIVED",
"immediateInvoicing" : true,
"disabled" : true,
"filterExpression" : "...",
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"sortIndexEl" : "...",
"taxClassEl" : "...",
"auditable" : { },
"edrTemplates" : [ { }, { } ],
"inputUnitOfMeasure" : { },
"version" : 12345,
"parentEntityType" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"inputUnitDescription" : "...",
"cfValues" : { },
"chargeMainType" : "RECURRING",
"roundingMode" : "DOWN",
"notified" : true,
"ratingUnitDescription" : "...",
"taxClass" : { },
"descriptionAndCode" : "...",
"referenceDescription" : "...",
"attributes" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"chargeType" : "...",
"unitMultiplicator" : 12345.0,
"dropZeroWo" : true,
"oneShotChargeTemplateType" : "SUBSCRIPTION",
"ratingUnitOfMeasure" : { },
"unitNbDecimal" : 12345,
"roundingValuesComputed" : true,
"uuid" : "...",
"id" : 12345,
"parentCFEntities" : [ { }, { } ],
"cfAccumulatedValues" : { },
"revenueRecognitionRule" : { },
"ratingScript" : { },
"transient" : true,
"appendGeneratedCode" : true,
"outputUnitEL" : "...",
"description" : "...",
"productCharges" : [ { }, { } ],
"active" : true,
"auditableFields" : [ { }, { } ],
"type" : "CREDIT",
"descriptionOrCode" : "...",
"amountEditable" : true,
"referenceCode" : "...",
"code" : "..."
},
"transient" : true,
"tradingCurrency" : {
"currentRate" : 12345.0,
"decimalPlaces" : 12345,
"prCurrencyToThis" : 12345.0,
"historized" : true,
"prDescription" : "...",
"notified" : true,
"currentRateFromDate" : 12345,
"active" : true,
"currencyCode" : "...",
"version" : 12345,
"transient" : true,
"symbol" : "...",
"currency" : { },
"currentRateUpdater" : "...",
"disabled" : true,
"auditableFields" : [ { }, { } ],
"exchangeRates" : [ { }, { } ],
"auditable" : { },
"id" : 12345
},
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"contactInformationNullSafe" : {
"fax" : "...",
"email" : "...",
"phone" : "...",
"mobile" : "..."
},
"historized" : true,
"code" : "...",
"appendGeneratedCode" : true,
"invoiceTypeSequence" : [ {
"invoiceType" : { },
"transient" : true,
"prefixEL" : "...",
"id" : { },
"invoiceSequence" : { },
"seller" : { }
}, {
"invoiceType" : { },
"transient" : true,
"prefixEL" : "...",
"id" : { },
"invoiceSequence" : { },
"seller" : { }
} ],
"parentCFEntities" : [ {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"dirtyCF" : true,
"CFValuesCopy" : { },
"uuid" : "..."
}, {
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"dirtyCF" : true,
"CFValuesCopy" : { },
"uuid" : "..."
} ],
"legalText" : "...",
"minimumLabelEl" : "...",
"referenceDescription" : "...",
"jobTitle" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ { }, { } ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : { },
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
},
"registrationNo" : "...",
"minimumAmountEl" : "...",
"legalEntityType" : {
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"referenceCode" : "...",
"appendGeneratedCode" : true,
"descriptionNotNull" : "...",
"auditableFields" : [ { }, { } ],
"notified" : true,
"version" : 12345,
"descriptionAndCode" : "...",
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"isCompany" : true,
"id" : 12345,
"transient" : true,
"code" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"auditable" : { },
"referenceDescription" : "...",
"description" : "...",
"historized" : true,
"descriptionOrCode" : "...",
"parentEntity" : { }
},
"vatNo" : "...",
"description" : "...",
"providerContact" : "...",
"defaultLevel" : true,
"tradingCountry" : {
"appendGeneratedCode" : true,
"parentCFEntities" : [ { }, { } ],
"parentEntityType" : { },
"id" : 12345,
"description" : "...",
"transient" : true,
"historized" : true,
"uuid" : "...",
"cfAccumulatedValues" : { },
"notified" : true,
"auditable" : { },
"code" : "...",
"descriptionAndCode" : "...",
"countryCode" : "...",
"parentEntity" : { },
"version" : 12345,
"referenceDescription" : "...",
"active" : true,
"country" : { },
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"cfValues" : { },
"referenceCode" : "...",
"disabled" : true
},
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"address" : {
"state" : "...",
"address4" : "...",
"city" : "...",
"countryBundle" : "...",
"address5" : "...",
"address2" : "...",
"zipCode" : "...",
"address3" : "...",
"country" : { },
"address1" : "..."
},
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"descriptionOrCode" : "...",
"businessAccountModel" : {
"active" : true,
"logoPicture" : "...",
"moduleSource" : "...",
"notified" : true,
"appendGeneratedCode" : true,
"parentEntityType" : { },
"description" : "...",
"referenceCode" : "...",
"code" : "...",
"version" : 12345,
"transient" : true,
"installed" : true,
"parentEntity" : { },
"auditable" : { },
"disabled" : true,
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"referenceDescription" : "...",
"historized" : true,
"codeChanged" : true,
"script" : { },
"id" : 12345,
"moduleItems" : [ { }, { } ],
"downloaded" : true,
"hierarchyType" : "S",
"license" : "APACHE",
"auditableFields" : [ { }, { } ]
},
"name" : {
"title" : { },
"lastName" : "...",
"fullName" : "...",
"firstName" : "..."
},
"descriptionAndCode" : "...",
"legalType" : "...",
"seller" : { },
"customerSequences" : [ {
"description" : "...",
"code" : "...",
"codeChanged" : true,
"referenceDescription" : "...",
"descriptionOrCode" : "...",
"seller" : { },
"auditable" : { },
"notified" : true,
"descriptionAndCode" : "...",
"parentEntityType" : { },
"auditableFields" : [ { }, { } ],
"referenceCode" : "...",
"transient" : true,
"version" : 12345,
"genericSequence" : { },
"historized" : true,
"appendGeneratedCode" : true,
"id" : 12345,
"parentEntity" : { }
}, {
"description" : "...",
"code" : "...",
"codeChanged" : true,
"referenceDescription" : "...",
"descriptionOrCode" : "...",
"seller" : { },
"auditable" : { },
"notified" : true,
"descriptionAndCode" : "...",
"parentEntityType" : { },
"auditableFields" : [ { }, { } ],
"referenceCode" : "...",
"transient" : true,
"version" : 12345,
"genericSequence" : { },
"historized" : true,
"appendGeneratedCode" : true,
"id" : 12345,
"parentEntity" : { }
} ],
"id" : 12345,
"primaryContact" : {
"address" : { },
"mobile" : "...",
"appendGeneratedCode" : true,
"email" : "...",
"id" : 12345,
"description" : "...",
"lastName" : "...",
"descriptionOrCode" : "...",
"genericMail" : "...",
"firstName" : "...",
"notified" : true,
"auditable" : { },
"transient" : true,
"auditableFields" : [ { }, { } ],
"fax" : "...",
"version" : 12345,
"parentEntity" : { },
"parentEntityType" : { },
"descriptionAndCode" : "...",
"referenceCode" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"code" : "...",
"phone" : "...",
"historized" : true
},
"version" : 12345,
"tradingLanguage" : {
"transient" : true,
"disabled" : true,
"auditableFields" : [ { }, { } ],
"prDescription" : "...",
"language" : { },
"languageCode" : "...",
"version" : 12345,
"notified" : true,
"active" : true,
"id" : 12345,
"historized" : true,
"auditable" : { }
},
"uuid" : "...",
"contracts" : [ {
"id" : 12345,
"descriptionAndCode" : "...",
"beginDate" : 12345,
"cfValues" : { },
"seller" : { },
"descriptionOrCode" : "...",
"appendGeneratedCode" : true,
"transient" : true,
"version" : 12345,
"notified" : true,
"code" : "...",
"renewal" : true,
"referenceDescription" : "...",
"cfAccumulatedValues" : { },
"codeChanged" : true,
"parentEntityType" : { },
"parentEntity" : { },
"billingRules" : [ { }, { } ],
"contractDate" : 12345,
"statusDate" : 12345,
"uuid" : "...",
"contractDuration" : 12345,
"disabled" : true,
"status" : "DRAFT",
"endDate" : 12345,
"active" : true,
"historized" : true,
"referenceCode" : "...",
"billingAccount" : { },
"contractItems" : [ { }, { } ],
"parentCFEntities" : [ { }, { } ],
"description" : "...",
"customer" : { },
"auditable" : { },
"customerAccount" : { },
"auditableFields" : [ { }, { } ]
}, {
"id" : 12345,
"descriptionAndCode" : "...",
"beginDate" : 12345,
"cfValues" : { },
"seller" : { },
"descriptionOrCode" : "...",
"appendGeneratedCode" : true,
"transient" : true,
"version" : 12345,
"notified" : true,
"code" : "...",
"renewal" : true,
"referenceDescription" : "...",
"cfAccumulatedValues" : { },
"codeChanged" : true,
"parentEntityType" : { },
"parentEntity" : { },
"billingRules" : [ { }, { } ],
"contractDate" : 12345,
"statusDate" : 12345,
"uuid" : "...",
"contractDuration" : 12345,
"disabled" : true,
"status" : "ACTIVE",
"endDate" : 12345,
"active" : true,
"historized" : true,
"referenceCode" : "...",
"billingAccount" : { },
"contractItems" : [ { }, { } ],
"parentCFEntities" : [ { }, { } ],
"description" : "...",
"customer" : { },
"auditable" : { },
"customerAccount" : { },
"auditableFields" : [ { }, { } ]
} ],
"generalLedger" : {
"referenceCode" : "...",
"codeChanged" : true,
"seller" : { },
"parentEntityType" : { },
"parentEntity" : { },
"auditable" : { },
"id" : 12345,
"otherTransactions" : [ { }, { } ],
"transient" : true,
"descriptionOrCode" : "...",
"version" : 12345,
"code" : "...",
"historized" : true,
"description" : "...",
"notified" : true,
"referenceDescription" : "...",
"descriptionAndCode" : "...",
"auditableFields" : [ { }, { } ],
"appendGeneratedCode" : true
},
"referenceCode" : "...",
"accountType" : "...",
"codeChanged" : true,
"externalRef1" : "...",
"minimumArticle" : {
"referenceCode" : "...",
"descriptionI18nNotNull" : {
"property1" : "...",
"property2" : "..."
},
"accountingCodeMappings" : [ { }, { } ],
"auditableFields" : [ { }, { } ],
"unitPrice" : 12345.0,
"parentCFEntities" : [ { }, { } ],
"codeChanged" : true,
"code" : "...",
"descriptionAndCode" : "...",
"active" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"columnCriteriaEL" : "...",
"disabled" : true,
"taxClass" : { },
"historized" : true,
"cfValues" : { },
"analyticCode1" : "...",
"invoiceSubCategory" : { },
"invoiceTypeEl" : "...",
"notified" : true,
"description" : "...",
"accountingCode" : { },
"analyticCode3" : "...",
"descriptionOrCode" : "...",
"id" : 12345,
"articleFamily" : { },
"ignoreAggregation" : true,
"auditable" : { },
"appendGeneratedCode" : true,
"parentEntity" : { },
"analyticCode2" : "...",
"accountingCodeEl" : "...",
"invoiceType" : { },
"uuid" : "...",
"cfAccumulatedValues" : { },
"transient" : true,
"parentEntityType" : { },
"version" : 12345,
"referenceDescription" : "..."
},
"notified" : true
},
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"notified" : true,
"descriptionAndCode" : "...",
"parentEntityType" : { },
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"referenceCode" : "...",
"transient" : true,
"version" : 12345,
"genericSequence" : {
"prefix" : "...",
"sequenceSize" : 12345,
"currentSequenceNb" : 12345
},
"historized" : true,
"appendGeneratedCode" : true,
"id" : 12345,
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
}
}