Skip to content
API References
/
/
Get CustomerDeposit recor...

DualEntry Public API (1.0.0)

Download OpenAPI description
resources.json
resources.yaml
Languages
Servers
Production environment
https://api.dualentry.io/
Development environment (for testing)
https://api-dev.dualentry.io/

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

Sales Orders

Create and manage sales orders. Track customer orders for goods or services before invoicing, including line items, quantities, fulfillment status, and invoicing progress.

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 Prepayment Applications

Apply customer prepayments and credits to invoices. Record applications of prepayments or credit memos to reduce invoice balances.

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

Create CustomerDeposit record

Request

Create a new CustomerDeposit record with the provided data. Validates all required fields and business rules.

Bodyapplication/jsonrequired
custom_fieldsArray of objects or null(Custom Fields)
datestring(date)(Date)required
transaction_datestring or null(date)(Transaction Date)
company_idinteger(Company Id)required
account_numberinteger(Account Number)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)
memostring(Memo)
Default ""
check_numberstring(Check Number)
Default ""
itemsArray of objects(Items)required
items[].​idinteger or null(Id)
items[].​positioninteger(Position)required
items[].​cash_sale_numberinteger or null(Cash Sale Number)
items[].​customer_payment_numberinteger or null(Customer Payment Number)
items[].​customer_prepayment_numberinteger or null(Customer Prepayment Number)
items[].​vendor_refund_numberinteger or null(Vendor Refund Number)
items[].​account_numberinteger or null(Account Number)
items[].​customer_idinteger or null(Customer Id)
items[].​vendor_idinteger or null(Vendor Id)
items[].​descriptionstring or null(Description)
Default ""
items[].​amountAmount (number) or Amount (string)(Amount)required
Any of:
number(Amount)
attachmentsArray of objects(Attachments)
Default []
record_statusstring(RecordStatus)
Default "posted"
Enum"draft""posted""archived"
curl -i -X POST \
  https://api.dualentry.io/public/v1/customer-deposits/ \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_fields": [
      {}
    ],
    "date": "2019-08-24",
    "transaction_date": "2019-08-24",
    "company_id": 0,
    "account_number": 0,
    "currency_iso_4217_code": "AED",
    "exchange_rate": 0,
    "memo": "",
    "check_number": "",
    "items": [
      {
        "id": 0,
        "position": 0,
        "cash_sale_number": 0,
        "customer_payment_number": 0,
        "customer_prepayment_number": 0,
        "vendor_refund_number": 0,
        "account_number": 0,
        "customer_id": 0,
        "vendor_id": 0,
        "description": "",
        "amount": 0
      }
    ],
    "attachments": [],
    "record_status": "posted"
  }'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
created_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

updated_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

internal_idinteger(Internal Id)required
numberinteger(Number)required
transaction_idinteger(Transaction Id)required
datestring(date)(Date)required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring(date)(Transaction Date)required

Transaction date (inception date) - the date when the transaction actually occurred

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

Total transaction amount

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": [],
  "created_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "internal_id": 0,
  "number": 0,
  "transaction_id": 0,
  "date": "2019-08-24",
  "transaction_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"
}

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://api.dualentry.io/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 []
created_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

updated_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

internal_idinteger(Internal Id)required
numberinteger(Number)required
transaction_idinteger(Transaction Id)required
datestring(date)(Date)required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring(date)(Transaction Date)required

Transaction date (inception date) - the date when the transaction actually occurred

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

Total transaction amount

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": [],
  "created_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "internal_id": 0,
  "number": 0,
  "transaction_id": 0,
  "date": "2019-08-24",
  "transaction_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"
}

Update CustomerDeposit record

Request

Update an existing CustomerDeposit record with the provided data. Validates all required fields and business rules.

Path
record_numberinteger(Record Number)required
Bodyapplication/jsonrequired
custom_fieldsArray of objects or null(Custom Fields)
datestring(date)(Date)required
transaction_datestring or null(date)(Transaction Date)
company_idinteger(Company Id)required
account_numberinteger(Account Number)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)
memostring(Memo)
Default ""
check_numberstring(Check Number)
Default ""
itemsArray of objects(Items)required
items[].​idinteger or null(Id)
items[].​positioninteger(Position)required
items[].​cash_sale_numberinteger or null(Cash Sale Number)
items[].​customer_payment_numberinteger or null(Customer Payment Number)
items[].​customer_prepayment_numberinteger or null(Customer Prepayment Number)
items[].​vendor_refund_numberinteger or null(Vendor Refund Number)
items[].​account_numberinteger or null(Account Number)
items[].​customer_idinteger or null(Customer Id)
items[].​vendor_idinteger or null(Vendor Id)
items[].​descriptionstring or null(Description)
Default ""
items[].​amountAmount (number) or Amount (string)(Amount)required
Any of:
number(Amount)
attachmentsArray of objects(Attachments)
Default []
record_statusstring(RecordStatus)
Default "posted"
Enum"draft""posted""archived"
curl -i -X PUT \
  'https://api.dualentry.io/public/v1/customer-deposits/{record_number}/' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_fields": [
      {}
    ],
    "date": "2019-08-24",
    "transaction_date": "2019-08-24",
    "company_id": 0,
    "account_number": 0,
    "currency_iso_4217_code": "AED",
    "exchange_rate": 0,
    "memo": "",
    "check_number": "",
    "items": [
      {
        "id": 0,
        "position": 0,
        "cash_sale_number": 0,
        "customer_payment_number": 0,
        "customer_prepayment_number": 0,
        "vendor_refund_number": 0,
        "account_number": 0,
        "customer_id": 0,
        "vendor_id": 0,
        "description": "",
        "amount": 0
      }
    ],
    "attachments": [],
    "record_status": "posted"
  }'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
created_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

updated_byobject or null(AuditActorSchemaOut)

Schema for audit actor information.

internal_idinteger(Internal Id)required
numberinteger(Number)required
transaction_idinteger(Transaction Id)required
datestring(date)(Date)required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring(date)(Transaction Date)required

Transaction date (inception date) - the date when the transaction actually occurred

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

Total transaction amount

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": [],
  "created_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "actor_type": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "internal_id": 0,
  "number": 0,
  "transaction_id": 0,
  "date": "2019-08-24",
  "transaction_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

Cash Sales

Record immediate cash sales transactions. Track sales where payment is received at the time of sale, including point-of-sale transactions and cash receipts.

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

Vendor Payments

Record and manage vendor payments. Track payments made to vendors and apply them to outstanding bills and credits, including partial payments and overpayments.

Operations

Vendor Credits

Manage vendor credit memos. Record credits from vendors for returned goods, billing adjustments, or discounts that reduce amounts owed or can be applied to future bills.

Operations

Vendor Refunds

Process and track vendor refunds. Record refunds received from vendors for overpayments, returns, or cancelled transactions.

Operations

Paper Checks

Manage paper check printing. Create, queue, and batch print paper checks for vendor payments, direct expenses, vendor prepayments, and customer refunds.

Operations