Skip to content
/
Get Customer

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

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

Create Customer

Request

Bodyapplication/jsonrequired
namestring(Name)required
emailstring(Email)required
addressstring(Address)required
countrystring(Country)required
phonestring(Phone)required
websitestring(Website)required
full_addressobject or null(AddressSchemaIn)
curl -i -X POST \
  https://docs.dualentry.com/_mock/resources/public/v1/customers/ \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "string",
    "address": "string",
    "country": "string",
    "phone": "string",
    "website": "string",
    "full_address": {
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "",
      "second_line": ""
    }
  }'

Responses

Created

Bodyapplication/json
idinteger(Id)required
addressstring(Address)required
countrystring(Country)required
namestring(Name)required
websitestring(Website)required
emailstring(Email)required
customer_typestring(Customer Type)required
is_activeboolean(Is Active)required
phonestring(Phone)required
record_statusstring(Record Status)required
is_taxableboolean(Is Taxable)required
default_tax_codestring(Default Tax Code)required
tax_registration_numberstring(Tax Registration Number)required
Response
application/json
{
  "id": 0,
  "address": "string",
  "country": "string",
  "name": "string",
  "website": "string",
  "email": "string",
  "customer_type": "string",
  "is_active": true,
  "phone": "string",
  "record_status": "string",
  "is_taxable": true,
  "default_tax_code": "string",
  "tax_registration_number": "string"
}

Get Customer

Request

Path
customer_idinteger(Customer Id)required
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/customers/{customer_id}/'

Responses

OK

Bodyapplication/json
idinteger(Id)required
addressstring(Address)required
countrystring(Country)required
namestring(Name)required
websitestring(Website)required
emailstring(Email)required
customer_typestring(Customer Type)required
is_activeboolean(Is Active)required
phonestring(Phone)required
record_statusstring(Record Status)required
is_taxableboolean(Is Taxable)required
default_tax_codestring(Default Tax Code)required
tax_registration_numberstring(Tax Registration Number)required
Response
application/json
{
  "id": 0,
  "address": "string",
  "country": "string",
  "name": "string",
  "website": "string",
  "email": "string",
  "customer_type": "string",
  "is_active": true,
  "phone": "string",
  "record_status": "string",
  "is_taxable": true,
  "default_tax_code": "string",
  "tax_registration_number": "string"
}

Update Customer

Request

Path
customer_idinteger(Customer Id)required
Bodyapplication/jsonrequired
namestring(Name)required
emailstring(Email)required
addressstring(Address)required
countrystring(Country)required
phonestring(Phone)required
websitestring(Website)required
full_addressobject or null(AddressSchemaIn)
curl -i -X PUT \
  'https://docs.dualentry.com/_mock/resources/public/v1/customers/{customer_id}/' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "string",
    "address": "string",
    "country": "string",
    "phone": "string",
    "website": "string",
    "full_address": {
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "",
      "second_line": ""
    }
  }'

Responses

OK

Bodyapplication/json
idinteger(Id)required
addressstring(Address)required
countrystring(Country)required
namestring(Name)required
websitestring(Website)required
emailstring(Email)required
customer_typestring(Customer Type)required
is_activeboolean(Is Active)required
phonestring(Phone)required
record_statusstring(Record Status)required
is_taxableboolean(Is Taxable)required
default_tax_codestring(Default Tax Code)required
tax_registration_numberstring(Tax Registration Number)required
Response
application/json
{
  "id": 0,
  "address": "string",
  "country": "string",
  "name": "string",
  "website": "string",
  "email": "string",
  "customer_type": "string",
  "is_active": true,
  "phone": "string",
  "record_status": "string",
  "is_taxable": true,
  "default_tax_code": "string",
  "tax_registration_number": "string"
}

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