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