Skip to content
/
Get Classification

DualEntry Public API (1.0.0)

Download OpenAPI description
resources.json
resources.yaml
Languages
Servers
Mock server
https://docs.dualentry.com/_mock/resources/
Production environment
https://api.dualentry.com/
Development environment (for testing)
https://api-dev.dualentry.com/

Health

Monitor API availability and service status. Use these endpoints to verify connectivity and check if the API is operational.

Operations

Accounts

Manage your chart of accounts. Create and maintain the accounts used to categorize financial transactions, including assets, liabilities, equity, revenue, and expenses.

Operations

Items

Manage products and services. Define items that appear on invoices and bills, including pricing, descriptions, and associated accounts for revenue or expense tracking.

Operations

Classifications

Manage custom classification dimensions. Create and maintain classification categories (e.g., departments, locations, projects) used to tag and analyze transactions across multiple dimensions.

Operations

Create Classification

Request

Bodyapplication/jsonrequired
idinteger or null(Id)
namestring(Name)[ 2 .. 128 ] charactersrequired
is_activeboolean(Is Active)required
selectionsArray of objects(Selections)required
selections[].​idinteger or null(Id)
selections[].​namestring(Name)[ 2 .. 128 ] charactersrequired
selections[].​is_activeboolean(Is Active)required
selections[].​parent_idinteger or null(Parent Id)required
required_for_recordsArray of strings(Required For Records)required
Items Enum"purchase_order""sales_order""cash_sale""invoice""bill""direct_expense""vendor_credit""journal_entry""intercompany_journal_entry""customer_credit"
parent_idinteger or null(Parent Id)required
curl -i -X POST \
  https://docs.dualentry.com/_mock/resources/public/v1/classifications/ \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "is_active": true,
    "selections": [
      {
        "id": 0,
        "name": "string",
        "is_active": true,
        "parent_id": 0
      }
    ],
    "required_for_records": [
      "purchase_order"
    ],
    "parent_id": 0
  }'

Responses

OK

Bodyapplication/json
idinteger(Id)required
selectionsArray of objects(Selections)required
selections[].​idinteger(Id)required
selections[].​namestring(Name)[ 2 .. 128 ] charactersrequired
selections[].​is_activeboolean(Is Active)required
selections[].​parent_idinteger or null(Parent Id)required
selections[].​parent_namestring or null(Parent Name)required
required_for_recordsArray of strings(Required For Records)required
Items Enum"purchase_order""sales_order""cash_sale""invoice""bill""direct_expense""vendor_credit""journal_entry""intercompany_journal_entry""customer_credit"
parent_idinteger or null(Parent Id)required
parent_namestring or null(Parent Name)required
namestring(Name)<= 128 charactersrequired
is_activeboolean(Is Active)
Default true
Response
application/json
{
  "id": 0,
  "selections": [
    { … }
  ],
  "required_for_records": [
    "purchase_order"
  ],
  "parent_id": 0,
  "parent_name": "string",
  "name": "string",
  "is_active": true
}

Get Classification

Request

Path
classification_idinteger(Classification Id)required
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/classifications/{classification_id}/'

Responses

OK

Bodyapplication/json
idinteger(Id)required
selectionsArray of objects(Selections)required
selections[].​idinteger(Id)required
selections[].​namestring(Name)[ 2 .. 128 ] charactersrequired
selections[].​is_activeboolean(Is Active)required
selections[].​parent_idinteger or null(Parent Id)required
selections[].​parent_namestring or null(Parent Name)required
required_for_recordsArray of strings(Required For Records)required
Items Enum"purchase_order""sales_order""cash_sale""invoice""bill""direct_expense""vendor_credit""journal_entry""intercompany_journal_entry""customer_credit"
parent_idinteger or null(Parent Id)required
parent_namestring or null(Parent Name)required
namestring(Name)<= 128 charactersrequired
is_activeboolean(Is Active)
Default true
Response
application/json
{
  "id": 0,
  "selections": [
    { … }
  ],
  "required_for_records": [
    "purchase_order"
  ],
  "parent_id": 0,
  "parent_name": "string",
  "name": "string",
  "is_active": true
}

Update Classification

Request

Path
classification_idinteger(Classification Id)required
Bodyapplication/jsonrequired
idinteger or null(Id)
namestring(Name)[ 2 .. 128 ] charactersrequired
is_activeboolean(Is Active)required
selectionsArray of objects(Selections)required
selections[].​idinteger or null(Id)
selections[].​namestring(Name)[ 2 .. 128 ] charactersrequired
selections[].​is_activeboolean(Is Active)required
selections[].​parent_idinteger or null(Parent Id)required
required_for_recordsArray of strings(Required For Records)required
Items Enum"purchase_order""sales_order""cash_sale""invoice""bill""direct_expense""vendor_credit""journal_entry""intercompany_journal_entry""customer_credit"
parent_idinteger or null(Parent Id)required
curl -i -X PUT \
  'https://docs.dualentry.com/_mock/resources/public/v1/classifications/{classification_id}/' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "is_active": true,
    "selections": [
      {
        "id": 0,
        "name": "string",
        "is_active": true,
        "parent_id": 0
      }
    ],
    "required_for_records": [
      "purchase_order"
    ],
    "parent_id": 0
  }'

Responses

OK

Bodyapplication/json
idinteger(Id)required
selectionsArray of objects(Selections)required
selections[].​idinteger(Id)required
selections[].​namestring(Name)[ 2 .. 128 ] charactersrequired
selections[].​is_activeboolean(Is Active)required
selections[].​parent_idinteger or null(Parent Id)required
selections[].​parent_namestring or null(Parent Name)required
required_for_recordsArray of strings(Required For Records)required
Items Enum"purchase_order""sales_order""cash_sale""invoice""bill""direct_expense""vendor_credit""journal_entry""intercompany_journal_entry""customer_credit"
parent_idinteger or null(Parent Id)required
parent_namestring or null(Parent Name)required
namestring(Name)<= 128 charactersrequired
is_activeboolean(Is Active)
Default true
Response
application/json
{
  "id": 0,
  "selections": [
    { … }
  ],
  "required_for_records": [
    "purchase_order"
  ],
  "parent_id": 0,
  "parent_name": "string",
  "name": "string",
  "is_active": true
}

Classifications Lines

Manage classification values. Define the specific values within each classification category that can be assigned to transaction line items for detailed reporting and analysis.

Operations

Companies

Access and manage company information. Retrieve details about your organization including legal name, tax identifiers, addresses, and accounting preferences.

Operations

Journal Entries

Create and manage manual journal entries. Record direct debits and credits to accounts for adjustments, accruals, reclassifications, and other accounting transactions.

Operations

Recurring Journal Entries

Automate recurring journal entries. Create templates for journal entries that occur regularly (e.g., monthly depreciation, amortization) to ensure consistent accounting treatment.

Operations

Invoices

Manage sales invoices. Create and track invoices sent to customers for goods or services rendered, including line items, taxes, discounts, and payment status.

Operations

Recurring Invoices

Automate recurring billing. Set up and manage templates for invoices that are automatically generated on a regular schedule (e.g., monthly subscriptions).

Operations

Customers

Manage customer records. Create, update, and track customers who purchase goods or services from your organization, including contact information, billing addresses, and payment terms.

Operations

Customer Payments

Record and manage customer payments. Track payments received from customers and apply them to outstanding invoices, including partial payments and overpayments.

Operations

Customer Prepayments

Track advance payments from customers. Access prepayments received before goods or services are delivered, which can be applied to future invoices.

Operations

Customer Deposits

Manage customer deposit transactions. Record and track deposits received from customers as security or partial payment, held in liability accounts until earned or refunded.

Operations

Customer Refunds

Process and track customer refunds. Record refunds issued to customers for overpayments, returns, or cancelled transactions.

Operations

Customer Credits

Manage credit memos for customers. Issue credits for returned goods, billing adjustments, or discounts that reduce customer balances or can be applied to future invoices.

Operations

Bills

Manage vendor bills and payables. Record and track bills received from vendors for goods or services purchased, including line items, due dates, and payment tracking.

Operations

Recurring Bills

Automate recurring expenses. Configure templates for bills that repeat on a regular basis (e.g., monthly rent, subscriptions) to streamline expense tracking.

Operations

Purchase Orders

Create and track purchase orders. Manage formal requests to vendors for goods or services, including approval workflows, receiving tracking, and bill matching.

Operations

Vendors

Manage vendor and supplier records. Track businesses and individuals from whom you purchase goods or services, including contact details, payment terms, and tax information.

Operations