Skip to content
/
List Invoice records

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

List Invoice records

Request

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

Query
integration_sourcesArray of strings or null(Integration Sources)
Enum"bill_com""ramp""zoho""stripe""finch""hubspot""brex""cubby""avalara""deel"
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)
due_datestring or null(date)(Due Date)
due_date_untilstring or null(date)(Due Date Until)
transaction_currencyArray of strings or null(Transaction Currency)
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
limitinteger(Limit)>= 1
Default 100
offsetinteger(Offset)>= 0
Default 0
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/invoices/?integration_sources=bill_com&search=string&company_id=0&number=0&customer_id=0&start_date=2019-08-24&end_date=2019-08-24&due_date=2019-08-24&due_date_until=2019-08-24&transaction_currency=AED&limit=100&offset=0'

Responses

OK

Bodyapplication/json
itemsArray of objects(Items)required
items[].​attachmentsArray of objects(Attachments)
Default []
items[].​paymentobject or null(PaymentSchemaOut)
items[].​term_idinteger or null(Term Id)required
items[].​term_namestring(Term Name)required
items[].​transaction_idsArray of integers(Transaction Ids)required
items[].​numberinteger(Number)required
items[].​itemsArray of objects(Items)required
items[].​items[].​classificationsArray of objects(Classifications)
Default []
items[].​items[].​idinteger(Id)required
items[].​items[].​item_idinteger(Item Id)required
items[].​items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:
number(Quantity)
items[].​items[].​rateRate (number) or Rate (string)(Rate)required
Any of:
number(Rate)
items[].​items[].​positioninteger(Position)required
items[].​items[].​memostring(Memo)required
items[].​company_idinteger(Company Id)required
items[].​company_namestring(Company Name)required
items[].​company_currencystring(Company Currency)required
items[].​customer_idinteger(Customer Id)required
items[].​customer_namestring(Customer Name)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 amount of transaction

number(Amount)
items[].​amount_dueAmount Due (number) or Amount Due (string)(Amount Due)required
Any of:

Amount to be paid

number(Amount Due)
items[].​paid_totalPaid Total (number) or Paid Total (string)(Paid Total)required
Any of:

Amount that was already paid by Customer Repayment Applications or Customer Payments

number(Paid Total)
items[].​memostring(Memo)required
items[].​datestring(date)(Date)required
items[].​due_datestring(date)(Due Date)required
items[].​bill_to_addressstring(Bill To Address)required
items[].​ship_to_addressstring(Ship To Address)required
items[].​billing_addressobject or null(AddressSchemaIn)
items[].​shipping_addressobject or null(AddressSchemaIn)
items[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
items[].​recurring_record_numberinteger or null(Recurring Record Number)required
items[].​reference_numberstring(Reference Number)required
countinteger(Count)required
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0
}

Create Invoice record

Request

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

Bodyapplication/jsonrequired
custom_fieldsArray of objects or null(Custom Fields)
itemsArray of objects(Items)required
items[].​idinteger or null(Id)
items[].​item_idinteger(Item Id)required
items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:
number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:
number(Rate)
items[].​positioninteger(Position)required
items[].​memostring(Memo)required
items[].​classificationsArray of objects(Classifications)
Default []
items[].​taxobject or null(ItemTaxData)
memostring(Memo)required
datestring(date)(Date)required
due_datestring(date)(Due Date)required
company_idinteger(Company Id)required
customer_idinteger(Customer Id)required
currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
bill_to_addressstring or null(Bill To Address)
Default ""
billing_addressobject or null(AddressSchemaIn)
ship_to_addressstring or null(Ship To Address)
Default ""
shipping_addressobject or null(AddressSchemaIn)
exchange_rateExchange Rate (number) or Exchange Rate (string)(Exchange Rate)required
Any of:
number(Exchange Rate)
sales_order_idinteger or null(Sales Order Id)
record_statusstring(RecordStatus)
Default "posted"
Enum"draft""posted""archived"
attachmentsArray of objects(Attachments)
Default []
contractedboolean(Contracted)
Default false
term_idinteger or null(Term Id)
reference_numberstring(Reference Number)
Default ""
paymentobject or null(PaymentSchemaIn)
curl -i -X POST \
  https://docs.dualentry.com/_mock/resources/public/v1/invoices/ \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_fields": [
      {}
    ],
    "items": [
      {
        "id": 0,
        "item_id": 0,
        "quantity": 0,
        "rate": 0,
        "position": 0,
        "memo": "string",
        "classifications": [],
        "tax": {
          "code": "string",
          "rate": 0,
          "amount": 0,
          "is_taxable": true,
          "tax_exempt_amount": 0
        }
      }
    ],
    "memo": "string",
    "date": "2019-08-24",
    "due_date": "2019-08-24",
    "company_id": 0,
    "customer_id": 0,
    "currency_iso_4217_code": "AED",
    "bill_to_address": "",
    "billing_address": {
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "",
      "second_line": ""
    },
    "ship_to_address": "",
    "shipping_address": {
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "",
      "second_line": ""
    },
    "exchange_rate": 0,
    "sales_order_id": 0,
    "record_status": "posted",
    "attachments": [],
    "contracted": false,
    "term_id": 0,
    "reference_number": "",
    "payment": {
      "type": "string",
      "id": 0,
      "body": "string",
      "link": "string"
    }
  }'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
paymentobject or null(PaymentSchemaOut)
term_idinteger or null(Term Id)required
term_namestring(Term Name)required
transaction_idsArray of integers(Transaction Ids)required
numberinteger(Number)required
itemsArray of objects(Items)required
items[].​classificationsArray of objects(Classifications)
Default []
items[].​idinteger(Id)required
items[].​item_idinteger(Item Id)required
items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:
number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:
number(Rate)
items[].​positioninteger(Position)required
items[].​memostring(Memo)required
company_idinteger(Company Id)required
company_namestring(Company Name)required
company_currencystring(Company Currency)required
customer_idinteger(Customer Id)required
customer_namestring(Customer Name)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 amount of transaction

number(Amount)
amount_dueAmount Due (number) or Amount Due (string)(Amount Due)required
Any of:

Amount to be paid

number(Amount Due)
paid_totalPaid Total (number) or Paid Total (string)(Paid Total)required
Any of:

Amount that was already paid by Customer Repayment Applications or Customer Payments

number(Paid Total)
memostring(Memo)required
datestring(date)(Date)required
due_datestring(date)(Due Date)required
bill_to_addressstring(Bill To Address)required
ship_to_addressstring(Ship To Address)required
billing_addressobject or null(AddressSchemaIn)
shipping_addressobject or null(AddressSchemaIn)
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
recurring_record_numberinteger or null(Recurring Record Number)required
reference_numberstring(Reference Number)required
Response
application/json
{
  "attachments": [],
  "payment": {
    "type": "string",
    "id": 0,
    "body": "string",
    "link": "string"
  },
  "term_id": 0,
  "term_name": "string",
  "transaction_ids": [
    0
  ],
  "number": 0,
  "items": [
    { … }
  ],
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "customer_id": 0,
  "customer_name": "string",
  "currency_iso_4217_code": "AED",
  "exchange_rate": 0,
  "amount": 0,
  "amount_due": 0,
  "paid_total": 0,
  "memo": "string",
  "date": "2019-08-24",
  "due_date": "2019-08-24",
  "bill_to_address": "string",
  "ship_to_address": "string",
  "billing_address": {
    "street": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "",
    "second_line": ""
  },
  "shipping_address": {
    "street": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "",
    "second_line": ""
  },
  "record_status": "draft",
  "recurring_record_number": 0,
  "reference_number": "string"
}

Get Invoice record

Request

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

Path
record_numberinteger(Record Number)required
Query
integration_sourcesArray of strings or null(Integration Sources)
Enum"bill_com""ramp""zoho""stripe""finch""hubspot""brex""cubby""avalara""deel"
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)
due_datestring or null(date)(Due Date)
due_date_untilstring or null(date)(Due Date Until)
transaction_currencyArray of strings or null(Transaction Currency)
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
curl -i -X GET \
  'https://docs.dualentry.com/_mock/resources/public/v1/invoices/{record_number}/?integration_sources=bill_com&search=string&company_id=0&number=0&customer_id=0&start_date=2019-08-24&end_date=2019-08-24&due_date=2019-08-24&due_date_until=2019-08-24&transaction_currency=AED'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
paymentobject or null(PaymentSchemaOut)
term_idinteger or null(Term Id)required
term_namestring(Term Name)required
transaction_idsArray of integers(Transaction Ids)required
numberinteger(Number)required
itemsArray of objects(Items)required
items[].​classificationsArray of objects(Classifications)
Default []
items[].​idinteger(Id)required
items[].​item_idinteger(Item Id)required
items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:
number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:
number(Rate)
items[].​positioninteger(Position)required
items[].​memostring(Memo)required
company_idinteger(Company Id)required
company_namestring(Company Name)required
company_currencystring(Company Currency)required
customer_idinteger(Customer Id)required
customer_namestring(Customer Name)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 amount of transaction

number(Amount)
amount_dueAmount Due (number) or Amount Due (string)(Amount Due)required
Any of:

Amount to be paid

number(Amount Due)
paid_totalPaid Total (number) or Paid Total (string)(Paid Total)required
Any of:

Amount that was already paid by Customer Repayment Applications or Customer Payments

number(Paid Total)
memostring(Memo)required
datestring(date)(Date)required
due_datestring(date)(Due Date)required
bill_to_addressstring(Bill To Address)required
ship_to_addressstring(Ship To Address)required
billing_addressobject or null(AddressSchemaIn)
shipping_addressobject or null(AddressSchemaIn)
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
recurring_record_numberinteger or null(Recurring Record Number)required
reference_numberstring(Reference Number)required
Response
application/json
{
  "attachments": [],
  "payment": {
    "type": "string",
    "id": 0,
    "body": "string",
    "link": "string"
  },
  "term_id": 0,
  "term_name": "string",
  "transaction_ids": [
    0
  ],
  "number": 0,
  "items": [
    { … }
  ],
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "customer_id": 0,
  "customer_name": "string",
  "currency_iso_4217_code": "AED",
  "exchange_rate": 0,
  "amount": 0,
  "amount_due": 0,
  "paid_total": 0,
  "memo": "string",
  "date": "2019-08-24",
  "due_date": "2019-08-24",
  "bill_to_address": "string",
  "ship_to_address": "string",
  "billing_address": {
    "street": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "",
    "second_line": ""
  },
  "shipping_address": {
    "street": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "country": "",
    "second_line": ""
  },
  "record_status": "draft",
  "recurring_record_number": 0,
  "reference_number": "string"
}

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