Deposit Application API

Apply customer deposits (prepayments) to invoices.

---

Endpoints

Method	Endpoint	Description
GET	/record/v1/depositApplication	List applications
GET	/record/v1/depositApplication/{id}	Get specific application
POST	/record/v1/depositApplication	Create application
PATCH	/record/v1/depositApplication/{id}	Update application
DELETE	/record/v1/depositApplication/{id}	Delete application

---

Key Fields

Field	Type	Description	Required
customer	object	Customer	Yes
tranDate	string	Application date	Yes
subsidiary	object	Subsidiary	Yes (OneWorld)
currency	object	Currency	Yes
deposit	object	Customer deposit to apply	Yes
apply	collection	Invoices to apply deposit to	Yes

---

Example: Apply Deposit to Invoice

POST /record/v1/depositApplication
Content-Type: application/json

{
  "customer": {
    "id": "456"
  },
  "tranDate": "2025-12-25",
  "subsidiary": {
    "id": "1"
  },
  "currency": {
    "id": "1"
  },
  "deposit": {
    "id": "8001"
  },
  "apply": {
    "items": [
      {
        "doc": {
          "id": "5001"
        },
        "apply": true,
        "amount": 5000.00
      }
    ]
  }
}

---

Workflow

1. Customer places order: Create Sales Order
2. Customer pays deposit: Create Customer Deposit
3. Ship & invoice order: Create Invoice
4. Apply deposit to invoice: Create Deposit Application

---

See Also

• Customer Deposit - Record prepayments
• Invoice - Apply deposits to invoices
• Sales Order - Link deposits to orders