API - name for objects
For information about the Opencell business object model, see Business Object Model.
You can use the GET operation to list the fields of each object that is available in your tenant. When you call the operation, you must specify the API name of the Opencell object.
The following table provides the API name of each Opencell object:
Object | API Name |
|---|---|
Access | /v1/accountManagement/accesses/ |
Account | /v1/accountManagement/ |
Account operation | /accountOperation/ |
Accounting articles | /v2/articles/ |
Accounting Code | /v1/accountingCodes/ |
Accounting Period | /v2/accountingPeriodManagement |
AuditDataLog | /v2/auditDataLog |
Billing cycle | /v1/billingCycles/ |
Billing Run | /v2/billing/invoicing/ |
Billing Preview Run | /billing/invoiving/createBillingRun |
Catalog | /v1/catalog/ |
Charge | /catalog/recurringChargeTemplate/createOrUpdate |
Collection plan | /vé/dunning/collectionPlan/ |
Commercial rules | /cpq/contracts/ |
Contact | /v1/contacts/ |
Counter | /v2/accountsManagement/counterInstance |
Customer | /v1/accountManagement/customers/ |
Custom Exchange Rate | /currency/addExchangeRate |
Custom entity instance | /customEntityInstance/ |
Custom field | /customFieldTemplate/ |
Custom table | /customTable/ |
Debit Memo | /billing/invoices/basicInvoices with the InvoiceType |
Debit Memo Item | /billing/invoices/{id}/invoiceLines |
Discount Plans | /v2/catalog/discountPlans/ |
Discount Plan instances | /v2/billing/billingAccounts/.../discountPlanInstances |
Documents | /v2/document/ |
Document signature | /document/sign/ |
Dunning | /v2/dunning/ |
Generic requests | /v2/generic/ |
Generic workflow | /admin/genericWorkFlow/ |
Invoice | /invoice |
Invoice generate | /invoice/generateInvoice |
Invoice Adjustment | /billing/invoiceLines/{id}/invoiceLines |
Invoice Line | /v2/billing/invoiceLines |
Invoice Item Adjustment | /v2/billing/invoiceLines/markForAdjustment |
Invoicing plan | /billing/invoicingPlans/ |
Jobs | /v1/jobInstances/ |
Journal Entry | to be retieved through generic API |
Journal Entry Item | to be retieved through generic API |
Journal Run | through Accounting entry job |
Matching | /v2/accountReceivable/matchOperations |
Mediation | /v2/mediation/cdrs/chargeCdrList |
Module | /module/ |
Notification | /notification/ |
Notification email | /notification/email/ |
Notification webhook | /notification/webhook/ |
Offer | /catalog/businessOfferModel/createOrUpdate |
Order | /orderManagement/commercialOrders |
Open orders | /v2/ordering/openOrder/ |
Payment | /payment/ |
Payment by card | /payment/paymentByCard |
Payment by SEPA | /payment/paymentBySepa |
Payment Method | /v1/payment/paymentMethods/ |
Payment plan | /v2/payment-plan/ |
Price list | /v2/catalog/priceList/ |
Price List Item | /v2/catalog/priceListLine |
Price plan | /catalog/pricePlan |
Product | /catalog/products |
Product Charge Definition | /v1/catalog/*ChargeTemplates/ |
Product Attribute | /attribute/ |
Provider | /provider/ |
Quote | /cpq/quotes/ |
Quote item | /cpq/quotes/quoteItems |
Refund | /v2/refund/refundByCard /v2/refund/refundBySepa |
Report query | /v2/queryManagement/ |
Revenue recognition | /revenueRecognitionRule/ |
Script | /scriptInstance |
Security deposit | /v2/securityDeposit/ |
Seller | /v2/seller |
Service template | /catalog/serviceTemplate |
Subscription | /v1/accountManagement/subscriptions |
Tax | /v1/taxes/ |
Tax class | /v1/taxClasses/ |
Usage | /v2/mediation/cdrs/chargeCdrList |
User | /user/ |