Skip to content
/
List CustomerDeposit reco...

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

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

List CustomerDeposit records

Request

Retrieve a paginated list of CustomerDeposit records with filtering and ordering options.

Query
searchstring or null(Search)
company_idArray of integers or null(Company Id)
numberArray of integers or null(Number)
customer_idArray of integers or null(Customer Id)
start_datestring or null(date)(Start Date)
end_datestring or null(date)(End Date)
transaction_currencystring or null(SystemCurrencies)
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
record_statusstring or null(RecordStatus)
Enum"draft""posted""archived"
limitinteger(Limit)>= 1
Default 100
offsetinteger(Offset)>= 0
Default 0
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/customer-deposits/?search=string&company_id=0&number=0&customer_id=0&start_date=2019-08-24&end_date=2019-08-24&transaction_currency=AED&record_status=draft&limit=100&offset=0'

Responses

OK

Bodyapplication/json
itemsArray of objects(Items)required
items[].​attachmentsArray of objects(Attachments)
Default []
items[].​numberinteger(Number)required
items[].​transaction_idinteger(Transaction Id)required
items[].​datestring(date)(Date)required
items[].​company_idinteger(Company Id)required
items[].​company_namestring(Company Name)required
items[].​company_currencystring(Company Currency)required
items[].​account_idinteger(Account Id)required
items[].​currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
items[].​exchange_rateExchange Rate (number) or Exchange Rate (string)(Exchange Rate)required
Any of:
number(Exchange Rate)
items[].​amountAmount (number) or Amount (string)(Amount)required
Any of:

Total transaction amount

number(Amount)
items[].​memostring(Memo)required
items[].​itemsArray of objects(Items)required
items[].​items[].​classificationsArray of objects(Classifications)
Default []
items[].​items[].​idinteger(Id)required
items[].​items[].​customer_prepayment_numberinteger or null(Customer Prepayment Number)required
items[].​items[].​customer_payment_numberinteger or null(Customer Payment Number)required
items[].​items[].​cash_sale_numberinteger or null(Cash Sale Number)required
items[].​items[].​vendor_refund_numberinteger or null(Vendor Refund Number)required
items[].​items[].​account_idinteger or null(Account Id)required
items[].​items[].​descriptionstring or null(Description)required
items[].​items[].​customer_idinteger or null(Customer Id)required
items[].​items[].​vendor_idinteger or null(Vendor Id)required
items[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
countinteger(Count)required
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0
}

Get CustomerDeposit record

Request

Retrieve a specific CustomerDeposit record by number with all related data.

Path
record_numberinteger(Record Number)required
Query
searchstring or null(Search)
company_idArray of integers or null(Company Id)
numberArray of integers or null(Number)
customer_idArray of integers or null(Customer Id)
start_datestring or null(date)(Start Date)
end_datestring or null(date)(End Date)
transaction_currencystring or null(SystemCurrencies)
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
record_statusstring or null(RecordStatus)
Enum"draft""posted""archived"
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/customer-deposits/{record_number}/?search=string&company_id=0&number=0&customer_id=0&start_date=2019-08-24&end_date=2019-08-24&transaction_currency=AED&record_status=draft'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
numberinteger(Number)required
transaction_idinteger(Transaction Id)required
datestring(date)(Date)required
company_idinteger(Company Id)required
company_namestring(Company Name)required
company_currencystring(Company Currency)required
account_idinteger(Account Id)required
currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
exchange_rateExchange Rate (number) or Exchange Rate (string)(Exchange Rate)required
Any of:
number(Exchange Rate)
amountAmount (number) or Amount (string)(Amount)required
Any of:

Total transaction amount

number(Amount)
memostring(Memo)required
itemsArray of objects(Items)required
items[].​classificationsArray of objects(Classifications)
Default []
items[].​idinteger(Id)required
items[].​customer_prepayment_numberinteger or null(Customer Prepayment Number)required
items[].​customer_payment_numberinteger or null(Customer Payment Number)required
items[].​cash_sale_numberinteger or null(Cash Sale Number)required
items[].​vendor_refund_numberinteger or null(Vendor Refund Number)required
items[].​account_idinteger or null(Account Id)required
items[].​descriptionstring or null(Description)required
items[].​customer_idinteger or null(Customer Id)required
items[].​vendor_idinteger or null(Vendor Id)required
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
Response
application/json
{
  "attachments": [],
  "number": 0,
  "transaction_id": 0,
  "date": "2019-08-24",
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "account_id": 0,
  "currency_iso_4217_code": "AED",
  "exchange_rate": 0,
  "amount": 0,
  "memo": "string",
  "items": [
    { … }
  ],
  "record_status": "draft"
}

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