Skip to content
/
Create PurchaseOrder 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

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

Update PurchaseOrder record

Request

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

Path
record_numberinteger(Record Number)required
Bodyapplication/jsonrequired
datestring(date)(Date)required
company_idinteger(Company Id)required
vendor_idinteger(Vendor 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)
memostring(Memo)required
itemsArray of objects(Items)required
items[].​idinteger or null(Id)
items[].​positioninteger(Position)required

Position of the item in the purchase order

items[].​item_idinteger(Item Id)required

ID of the item

items[].​memostring(Memo)required

Memo of the item

items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:

Quantity of the item

number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:

Rate of the item

number(Rate)
items[].​classificationsArray of objects(Classifications)required

Classifications of the item

items[].​classifications[].​idinteger(Id)required
items[].​classifications[].​namestring(Name)required
items[].​classifications[].​line_idinteger(Line Id)required
items[].​classifications[].​line_namestring(Line Name)required
items[].​classifications[].​parent_classification_idinteger or null(Parent Classification Id)
items[].​classifications[].​parent_classification_line_idinteger or null(Parent Classification Line Id)
attachmentsArray of objects(Attachments)
Default []
record_statusstring(RecordStatus)
Default "posted"
Enum"draft""posted""archived"
term_idinteger or null(Term Id)
reference_numberstring(Reference Number)
Default ""
curl -i -X PUT \
  'https://docs.dualentry.com/_mock/resources/public/v1/purchase-orders/{record_number}/' \
  -H 'Content-Type: application/json' \
  -d '{
    "date": "2019-08-24",
    "company_id": 0,
    "vendor_id": 0,
    "currency_iso_4217_code": "AED",
    "exchange_rate": 0,
    "memo": "string",
    "items": [
      {
        "id": 0,
        "position": 0,
        "item_id": 0,
        "memo": "string",
        "quantity": 0,
        "rate": 0,
        "classifications": [
          {
            "id": 0,
            "name": "string",
            "line_id": 0,
            "line_name": "string",
            "parent_classification_id": 0,
            "parent_classification_line_id": 0
          }
        ]
      }
    ],
    "attachments": [],
    "record_status": "posted",
    "term_id": 0,
    "reference_number": ""
  }'

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
term_idinteger or null(Term Id)required
term_namestring(Term Name)required
numberinteger(Number)required
datestring(date)(Date)required
company_idinteger(Company Id)required
company_namestring(Company Name)required

Name of the company

company_currencystring(Company Currency)required
vendor_idinteger(Vendor Id)required
vendor_namestring(Vendor 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)
billed_totalBilled Total (number) or Billed Total (string)(Billed Total)required
Any of:

Total quantity of items that were already billed

number(Billed Total)
due_totalDue Total (number) or Due Total (string)(Due Total)required
Any of:

Total quantity of items yet to be billed

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

Total amount of ordered items

number(Amount)
memostring(Memo)required
itemsArray of objects(Items)required
items[].​classificationsArray of objects(Classifications)required

Classifications of the item

items[].​classifications[].​idinteger(Id)required
items[].​classifications[].​namestring(Name)required
items[].​classifications[].​line_idinteger(Line Id)required
items[].​classifications[].​line_namestring(Line Name)required
items[].​classifications[].​parent_classification_idinteger or null(Parent Classification Id)
items[].​classifications[].​parent_classification_line_idinteger or null(Parent Classification Line Id)
items[].​idinteger(Id)required

ID of the item

items[].​item_idinteger(Item Id)required

ID of the inventory item

items[].​positioninteger(Position)required

Position of the item in the purchase order

items[].​memostring(Memo)required

Memo of the item

items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:

Quantity ordered

number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:

Rate per unit

number(Rate)
items[].​quantity_billedQuantity Billed (number) or Quantity Billed (string)(Quantity Billed)required
Any of:

Quantity of items that already have corresponding Bill

number(Quantity Billed)
items[].​quantity_dueQuantity Due (number) or Quantity Due (string)(Quantity Due)required
Any of:

Quantity of items yet to be billed

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

Total amount expected to be paid for this item

number(Amount)
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
billed_statusstring(PurchaseOrderBilledStatus)required
Enum"billed""unbilled""partially_billed"
reference_numberstring(Reference Number)
Default ""
Response
application/json
{
  "attachments": [],
  "term_id": 0,
  "term_name": "string",
  "number": 0,
  "date": "2019-08-24",
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "currency_iso_4217_code": "AED",
  "exchange_rate": 0,
  "billed_total": 0,
  "due_total": 0,
  "amount": 0,
  "memo": "string",
  "items": [
    { … }
  ],
  "record_status": "draft",
  "billed_status": "billed",
  "reference_number": ""
}

Create PurchaseOrder record attachments

Request

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

Path
record_numberstring(Record Number)required
Bodymultipart/form-datarequired
filesArray of strings(binary)(Files)required
curl -i -X POST \
  'https://docs.dualentry.com/_mock/resources/public/v1/purchase-orders/{record_number}/attachments/' \
  -H 'Content-Type: multipart/form-data' \
  -F files=string

Responses

OK

Bodyapplication/json
attachmentsArray of objects(Attachments)
Default []
term_idinteger or null(Term Id)required
term_namestring(Term Name)required
numberinteger(Number)required
datestring(date)(Date)required
company_idinteger(Company Id)required
company_namestring(Company Name)required

Name of the company

company_currencystring(Company Currency)required
vendor_idinteger(Vendor Id)required
vendor_namestring(Vendor 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)
billed_totalBilled Total (number) or Billed Total (string)(Billed Total)required
Any of:

Total quantity of items that were already billed

number(Billed Total)
due_totalDue Total (number) or Due Total (string)(Due Total)required
Any of:

Total quantity of items yet to be billed

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

Total amount of ordered items

number(Amount)
memostring(Memo)required
itemsArray of objects(Items)required
items[].​classificationsArray of objects(Classifications)required

Classifications of the item

items[].​classifications[].​idinteger(Id)required
items[].​classifications[].​namestring(Name)required
items[].​classifications[].​line_idinteger(Line Id)required
items[].​classifications[].​line_namestring(Line Name)required
items[].​classifications[].​parent_classification_idinteger or null(Parent Classification Id)
items[].​classifications[].​parent_classification_line_idinteger or null(Parent Classification Line Id)
items[].​idinteger(Id)required

ID of the item

items[].​item_idinteger(Item Id)required

ID of the inventory item

items[].​positioninteger(Position)required

Position of the item in the purchase order

items[].​memostring(Memo)required

Memo of the item

items[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:

Quantity ordered

number(Quantity)
items[].​rateRate (number) or Rate (string)(Rate)required
Any of:

Rate per unit

number(Rate)
items[].​quantity_billedQuantity Billed (number) or Quantity Billed (string)(Quantity Billed)required
Any of:

Quantity of items that already have corresponding Bill

number(Quantity Billed)
items[].​quantity_dueQuantity Due (number) or Quantity Due (string)(Quantity Due)required
Any of:

Quantity of items yet to be billed

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

Total amount expected to be paid for this item

number(Amount)
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
billed_statusstring(PurchaseOrderBilledStatus)required
Enum"billed""unbilled""partially_billed"
reference_numberstring(Reference Number)
Default ""
Response
application/json
{
  "attachments": [],
  "term_id": 0,
  "term_name": "string",
  "number": 0,
  "date": "2019-08-24",
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "currency_iso_4217_code": "AED",
  "exchange_rate": 0,
  "billed_total": 0,
  "due_total": 0,
  "amount": 0,
  "memo": "string",
  "items": [
    { … }
  ],
  "record_status": "draft",
  "billed_status": "billed",
  "reference_number": ""
}

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