| name | data type | constraints | description |
|---|---|---|---|
| referenceCode | string | ||
| historized | boolean | ||
| provider | Provider | ||
| version | number | ||
| descriptionOrCode | string | ||
| code | string | required, max size: 255, min size: 1 | |
| id | number | ||
| description | string | max size: 255, min size: 0 | |
| parentEntityType | object | ||
| auditableFields | array of AuditableFieldHistory | ||
| descriptionAndCode | string | ||
| transient | boolean | ||
| auditable | Auditable | ||
| notified | boolean | ||
| descriptionI18n | map of string | ||
| codeChanged | boolean | ||
| referenceDescription | string | ||
| parentEntity | BusinessEntity | ||
| appendGeneratedCode | boolean |
Example
{
"referenceCode" : "...",
"historized" : true,
"provider" : {
"invoiceRoundingMode" : "NEAREST",
"transient" : true,
"recognizeRevenue" : true,
"customerNoSequence" : {
"currentSequenceNb" : 12345,
"sequenceSize" : 12345,
"prefix" : "..."
},
"customerAccount" : {
"externalRef1" : "...",
"minimumTargetAccount" : { },
"thresholdPerEntity" : true,
"tradingCurrency" : { },
"invoicingThreshold" : 12345.0,
"code" : "...",
"parentCFEntities" : [ { }, { } ],
"id" : 12345,
"minimumLabelEl" : "...",
"paymentMethods" : [ { }, { } ],
"accountType" : "...",
"referenceDescription" : "...",
"addressbook" : { },
"legalEntityType" : { },
"dunningLevel" : "R4",
"descriptionOrCode" : "...",
"auditable" : { },
"businessAccountModel" : { },
"contracts" : [ { }, { } ],
"name" : { },
"status" : "CLOSE",
"registrationNo" : "...",
"address" : { },
"paymentPlans" : [ { }, { } ],
"preferredPaymentMethodType" : "CHECK",
"cfAccumulatedValues" : { },
"minimumArticle" : { },
"creditCategory" : { },
"descriptionAndCode" : "...",
"customer" : { },
"externalRef2" : "...",
"DDPaymentMethods" : [ { }, { } ],
"accountOperations" : [ { }, { } ],
"excludedFromPayment" : true,
"tradingLanguage" : { },
"minimumChargeTemplate" : { },
"noMoreValidCard" : true,
"referenceCode" : "...",
"contactInformation" : { },
"auditableFields" : [ { }, { } ],
"dunningDocuments" : [ { }, { } ],
"vatNo" : "...",
"minimumAmountEl" : "...",
"stripePaymentMethods" : [ { }, { } ],
"paypalPaymentMethods" : [ { }, { } ],
"password" : "...",
"wirePaymentMethods" : [ { }, { } ],
"dateDunningLevel" : 12345,
"preferredPaymentMethod" : { },
"dueBalance" : "...",
"jobTitle" : "...",
"dueDateDelayEL" : "...",
"cfValues" : { },
"checkThreshold" : "POSITIVE_IL",
"transient" : true,
"version" : 12345,
"generalClientAccount" : { },
"actionDunnings" : [ { }, { } ],
"notified" : true,
"isCompany" : true,
"parentEntity" : { },
"counters" : {
"property1" : { },
"property2" : { }
},
"uuid" : "...",
"appendGeneratedCode" : true,
"description" : "...",
"checkPaymentMethods" : [ { }, { } ],
"providerContact" : "...",
"primaryContact" : { },
"defaultLevel" : true,
"billingAccounts" : [ { }, { } ],
"auditedMethodPayments" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"dateStatus" : 12345,
"parentEntityType" : { },
"codeChanged" : true,
"historized" : true,
"contactInformationNullSafe" : { }
},
"paymentPlanPolicy" : {
"defaultInstallmentCount" : 12345,
"allowedPaymentMethods" : [ "CHECK", "PAYPAL" ],
"defaultInterestRate" : 12345,
"defaultBlockPayments" : true,
"minInstallmentAmount" : 12345.0,
"defaultStartingDateOfPlan" : "TODAY",
"allowedCreditCategories" : [ { }, { } ],
"splitEvenly" : true,
"maxAllowedReceivableAmount" : 12345.0,
"dunningDefaultPauseReason" : { },
"theresHoldForApproval" : 12345.0,
"defaultRecurrenceUnit" : "DAY",
"maxPaymentPlanDuration" : 12345,
"requireInternalApproval" : true,
"minAllowedReceivableAmount" : 12345.0,
"addInterestRate" : true,
"actionOnRemainingAmount" : "FIRST",
"defaultFeePerInstallmentPlan" : 12345,
"allowCustomInstallmentPlan" : true,
"installmentAmountRounding" : 12345,
"clearingPriority" : "NEWEST",
"addInstallmentFee" : true
},
"discountAccountingCode" : "...",
"interBankTitle" : {
"adresseTSA" : { },
"codeEtablissementCreancier" : "...",
"codeCreancier" : "...",
"nne" : "...",
"codeCentre" : "..."
},
"roundingMode" : "DOWN",
"maximumDelay" : 12345,
"entreprise" : true,
"paymentDeferral" : true,
"maximumDeferralPerInvoice" : 12345,
"parentCFEntities" : [ {
"dirtyCF" : true,
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"uuid" : "...",
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
}, {
"dirtyCF" : true,
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"uuid" : "...",
"cfAccumulatedValuesNullSafe" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValues" : { },
"cfValues" : { }
} ],
"active" : true,
"auditableFields" : [ {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "OTHER"
}, {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "RENEWAL"
} ],
"billingAccount" : {
"businessAccountModel" : { },
"parentEntity" : { },
"invoicingThreshold" : 12345.0,
"descriptionOrCode" : "...",
"exoneratedFromtaxes" : true,
"referenceDescription" : "...",
"billingCycle" : { },
"contactInformationNullSafe" : { },
"invoices" : [ { }, { } ],
"contracts" : [ { }, { } ],
"thresholdPerEntity" : true,
"mailingType" : "AUTO",
"brAmountWithTax" : 12345.0,
"uuid" : "...",
"description" : "...",
"paymentMethod" : { },
"cfAccumulatedValues" : { },
"totalInvoicingAmountTax" : 12345.0,
"emailTemplate" : { },
"subscriptionDate" : 12345,
"checkThreshold" : "POSITIVE_IL",
"contactInformation" : { },
"version" : 12345,
"taxCategory" : { },
"customerAccount" : { },
"minimumAmountEl" : "...",
"tags" : [ { }, { } ],
"totalInvoicingAmountWithTax" : 12345.0,
"isCompany" : true,
"name" : { },
"statusDate" : 12345,
"counters" : {
"property1" : { },
"property2" : { }
},
"registrationNo" : "...",
"vatNo" : "...",
"minRatedTransactions" : [ { }, { } ],
"terminationReason" : { },
"accountType" : "...",
"codeChanged" : true,
"minInvoiceLines" : [ { }, { } ],
"providerContact" : "...",
"minimumChargeTemplate" : { },
"transient" : true,
"minimumInvoiceSubCategory" : { },
"appendGeneratedCode" : true,
"legalEntityType" : { },
"invoicePrefix" : "...",
"discountPlan" : { },
"discountRate" : 12345.0,
"externalRef1" : "...",
"tradingLanguage" : { },
"historized" : true,
"minimumArticle" : { },
"minimumLabelEl" : "...",
"descriptionAndCode" : "...",
"electronicBilling" : true,
"referenceCode" : "...",
"ccedEmails" : "...",
"primaryContact" : { },
"status" : "CLOSED",
"discountPlanInstances" : [ { }, { } ],
"tradingCurrency" : { },
"allDiscountPlanInstances" : [ { }, { } ],
"address" : { },
"nextInvoiceDate" : 12345,
"parentCFEntities" : [ { }, { } ],
"taxCategoryResolved" : { },
"usersAccounts" : [ { }, { } ],
"externalRef2" : "...",
"parentUserAccounts" : [ { }, { } ],
"terminationDate" : 12345,
"notified" : true,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"jobTitle" : "...",
"tradingCountry" : { },
"auditable" : { },
"billingRun" : { },
"cfValues" : { },
"defaultLevel" : true,
"brAmountWithoutTax" : 12345.0,
"auditableFields" : [ { }, { } ],
"totalInvoicingAmountWithoutTax" : 12345.0
},
"rumSequence" : {
"currentSequenceNb" : 12345,
"sequenceSize" : 12345,
"prefix" : "..."
},
"multicurrencyFlag" : true,
"multicountryFlag" : true,
"notified" : true,
"language" : {
"historized" : true,
"notified" : true,
"descriptionEn" : "...",
"id" : 12345,
"description" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"languageCode" : "...",
"auditableFields" : [ { }, { } ],
"transient" : true,
"version" : 12345,
"auditable" : { }
},
"currency" : {
"descriptionEn" : "...",
"systemCurrency" : true,
"notified" : true,
"symbol" : "...",
"description" : "...",
"id" : 12345,
"auditableFields" : [ { }, { } ],
"auditable" : { },
"historized" : true,
"currencyCode" : "...",
"version" : 12345,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"transient" : true
},
"description" : "...",
"rounding" : 12345,
"prepaidReservationExpirationDelayinMillisec" : 12345,
"multilanguageFlag" : true,
"auditable" : {
"lastUser" : "...",
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"created" : 12345,
"creator" : "..."
},
"customer" : {
"historized" : true,
"notified" : true,
"accountType" : "...",
"defaultLevel" : true,
"auditableFields" : [ { }, { } ],
"addressbook" : { },
"legalEntityType" : { },
"appendGeneratedCode" : true,
"codeChanged" : true,
"code" : "...",
"customerCategory" : { },
"minimumChargeTemplate" : { },
"parentCFEntities" : [ { }, { } ],
"minimumAmountEl" : "...",
"primaryContact" : { },
"seller" : { },
"checkThreshold" : "POSITIVE_IL",
"isCompany" : true,
"contactInformation" : { },
"counters" : {
"property1" : { },
"property2" : { }
},
"anonymized" : true,
"name" : { },
"auditable" : { },
"uuid" : "...",
"businessAccountModel" : { },
"description" : "...",
"parentEntity" : { },
"referenceDescription" : "...",
"address" : { },
"minimumArticle" : { },
"referenceCode" : "...",
"descriptionOrCode" : "...",
"jobTitle" : "...",
"parentEntityType" : { },
"registrationNo" : "...",
"providerContact" : "...",
"contactInformationNullSafe" : { },
"invoicingThreshold" : 12345.0,
"customerBrand" : { },
"descriptionAndCode" : "...",
"transient" : true,
"externalRef1" : "...",
"customerAccounts" : [ { }, { } ],
"minimumLabelEl" : "...",
"anonymizationDate" : 12345,
"cfAccumulatedValues" : { },
"id" : 12345,
"thresholdPerEntity" : true,
"cfValues" : { },
"minimumTargetAccount" : { },
"externalRef2" : "...",
"vatNo" : "...",
"version" : 12345,
"contracts" : [ { }, { } ],
"additionalDetails" : { }
},
"bankCoordinates" : {
"iban" : "...",
"issuerName" : "...",
"key" : "...",
"bankCode" : "...",
"bankName" : "...",
"ics" : "...",
"bic" : "...",
"bankId" : "...",
"accountOwner" : "...",
"accountNumber" : "...",
"branchCode" : "...",
"issuerNumber" : "..."
},
"code" : "...",
"invoiceConfigurationOrDefault" : {
"displayDetail" : true,
"displayProvider" : true,
"displayServices" : true,
"defaultInvoiceSubCategory" : { },
"displayPricePlans" : true,
"defaultInvoiceMinimumAccountingArticle" : { },
"defaultGenericAccountingArticle" : { },
"currentInvoiceNb" : 12345,
"id" : 12345,
"defaultDiscountAccountingArticle" : { },
"defaultAdvancedPaymentAccountingArticle" : { },
"transient" : true,
"version" : 12345,
"displayUserAccountHierarchy" : true,
"displayTaxDetails" : true,
"displayEdrs" : true,
"displayWalletOperations" : true,
"displayOffers" : true,
"displayCfAsXML" : true,
"displayBillingCycle" : true,
"displaySubscriptions" : true,
"displayOrders" : true
},
"id" : 12345,
"version" : 12345,
"displayFreeTransacInInvoice" : true,
"automaticInvoicing" : true,
"country" : {
"auditableFields" : [ { }, { } ],
"id" : 12345,
"notified" : true,
"transient" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"historized" : true,
"version" : 12345,
"code" : "...",
"currency" : { },
"auditable" : { },
"description" : "...",
"language" : { },
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"countryCode" : "..."
},
"gdprConfigurationNullSafe" : {
"customerProspectLife" : 12345,
"deleteMailingLife" : true,
"accountingLife" : 12345,
"deleteInvoice" : true,
"deleteAoCheckUnpaidLife" : true,
"deleteSubscription" : true,
"inactiveOrderLife" : 12345,
"version" : 12345,
"transient" : true,
"invoiceLife" : 12345,
"deleteOrder" : true,
"mailingLife" : 12345,
"deleteCustomerProspect" : true,
"inactiveSubscriptionLife" : 12345,
"deleteAccounting" : true,
"aoCheckUnpaidLife" : 12345,
"id" : 12345
},
"disabled" : true,
"functionalCurrencyFlag" : true,
"paymentPlan" : true,
"uuid" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"activateCascadingDiscounts" : true,
"currentProvider" : true,
"cdrDeduplicationKeyEL" : "...",
"email" : "...",
"invoiceRounding" : 12345,
"userAccount" : {
"billingAccount" : { },
"contactInformationNullSafe" : { },
"parentEntityType" : { },
"cfValues" : { },
"contactInformation" : { },
"isCompany" : true,
"terminationReason" : { },
"referenceCode" : "...",
"externalRef2" : "...",
"counters" : {
"property1" : { },
"property2" : { }
},
"providerContact" : "...",
"registrationNo" : "...",
"address" : { },
"historized" : true,
"minimumAmountEl" : "...",
"id" : 12345,
"vatNo" : "...",
"prepaidWallets" : {
"property1" : { },
"property2" : { }
},
"terminationDate" : 12345,
"cfAccumulatedValues" : { },
"status" : "ACTIVE",
"subscriptions" : [ { }, { } ],
"parentUserAccount" : { },
"userAccounts" : [ { }, { } ],
"notified" : true,
"uuid" : "...",
"referenceDescription" : "...",
"wallet" : { },
"minimumLabelEl" : "...",
"parentEntity" : { },
"defaultLevel" : true,
"code" : "...",
"name" : { },
"descriptionOrCode" : "...",
"minimumChargeTemplate" : { },
"externalRef1" : "...",
"transient" : true,
"auditable" : { },
"version" : 12345,
"primaryContact" : { },
"accountType" : "...",
"subscriptionDate" : 12345,
"descriptionAndCode" : "...",
"jobTitle" : "...",
"parentCFEntities" : [ { }, { } ],
"businessAccountModel" : { },
"codeChanged" : true,
"description" : "...",
"appendGeneratedCode" : true,
"statusDate" : 12345,
"minimumArticle" : { },
"legalEntityType" : { },
"auditableFields" : [ { }, { } ],
"isConsumer" : true
},
"levelDuplication" : true,
"invoiceConfiguration" : {
"displayDetail" : true,
"displayProvider" : true,
"displayServices" : true,
"defaultInvoiceSubCategory" : { },
"displayPricePlans" : true,
"defaultInvoiceMinimumAccountingArticle" : { },
"defaultGenericAccountingArticle" : { },
"currentInvoiceNb" : 12345,
"id" : 12345,
"defaultDiscountAccountingArticle" : { },
"defaultAdvancedPaymentAccountingArticle" : { },
"transient" : true,
"version" : 12345,
"displayUserAccountHierarchy" : true,
"displayTaxDetails" : true,
"displayEdrs" : true,
"displayWalletOperations" : true,
"displayOffers" : true,
"displayCfAsXML" : true,
"displayBillingCycle" : true,
"displaySubscriptions" : true,
"displayOrders" : true
},
"historized" : true,
"paymentMethods" : [ "PAYPAL", "CHECK" ],
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"amountValidation" : true,
"gdprConfiguration" : {
"customerProspectLife" : 12345,
"deleteMailingLife" : true,
"accountingLife" : 12345,
"deleteInvoice" : true,
"deleteAoCheckUnpaidLife" : true,
"deleteSubscription" : true,
"inactiveOrderLife" : 12345,
"version" : 12345,
"transient" : true,
"invoiceLife" : 12345,
"deleteOrder" : true,
"mailingLife" : 12345,
"deleteCustomerProspect" : true,
"inactiveSubscriptionLife" : 12345,
"deleteAccounting" : true,
"aoCheckUnpaidLife" : 12345,
"id" : 12345
}
},
"version" : 12345,
"descriptionOrCode" : "...",
"code" : "...",
"id" : 12345,
"description" : "...",
"parentEntityType" : { },
"auditableFields" : [ {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "OTHER"
}, {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "OTHER"
} ],
"descriptionAndCode" : "...",
"transient" : true,
"auditable" : {
"lastUser" : "...",
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"created" : 12345,
"creator" : "..."
},
"notified" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"codeChanged" : true,
"referenceDescription" : "...",
"parentEntity" : {
"version" : 12345,
"historized" : true,
"auditableFields" : [ {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "RENEWAL"
}, {
"previousState" : { },
"notified" : true,
"currentState" : { },
"historable" : true,
"notfiable" : true,
"historized" : true,
"fieldName" : "...",
"auditType" : "OTHER"
} ],
"id" : 12345,
"parentEntityType" : { },
"descriptionOrCode" : "...",
"transient" : true,
"code" : "...",
"referenceDescription" : "...",
"descriptionAndCode" : "...",
"parentEntity" : { },
"codeChanged" : true,
"auditable" : {
"lastUser" : "...",
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"created" : 12345,
"creator" : "..."
},
"description" : "...",
"appendGeneratedCode" : true,
"referenceCode" : "...",
"notified" : true
},
"appendGeneratedCode" : true
}