Monitor API availability and service status. Use these endpoints to verify connectivity and check if the API is operational.
API References
/- List usage records for a contract
List Contracts
Create Contract
Get Contract
Upsert usage records for contract obligations
List usage records for a...
DualEntry Public API (1.0.0)
Download OpenAPI description
Languages
Servers
Production environment
https://api.dualentry.com
Development environment (for testing)
https://api-dev.dualentry.com
- Production environmenthttps://api.dualentry.com/public/v1/contracts/{record_id}/
- Development environment (for testing)https://api-dev.dualentry.com/public/v1/contracts/{record_id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.dualentry.com/public/v1/contracts/{record_id}/'OK
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Amount that was already paid by Customer Repayment Applications or Customer Payments
Default "straight_line"
Enum"straight_line""straight_line_start_end_even""daily_prorata""milestone""usage_tiered""usage""immediate""deposit_release"
Enum"daily""weekly""monthly""annually"
Enum"daily""weekly""monthly""annually"
Gross amount before discount.
Response
application/json
{ "custom_fields": [], "integration_remote_records": [], "id": 0, "number": 0, "company_id": 0, "company_name": "string", "company_currency": "string", "customer_id": 0, "customer_name": "string", "name": "string", "currency_iso_4217_code": "AED", "memo": "string", "date": "2019-08-24", "term_id": 0, "start_date": "2019-08-24", "end_date": "2019-08-24", "bill_to_address": "string", "ship_to_address": "string", "billing_address": { "street": "string", "city": "string", "state": "", "postal_code": "string", "country": "", "second_line": "", "name": "string" }, "shipping_address": { "street": "string", "city": "string", "state": "", "postal_code": "string", "country": "", "second_line": "", "name": "string" }, "billing_start_date": "2019-08-24", "billing_frequency": "daily", "billing_interval": 0, "billing_anchor_weekday": 0, "recognition_start_date": "2019-08-24", "recognition_frequency": "daily", "recognition_interval": 0, "recognition_anchor_weekday": 0, "status": "draft", "record_status": "draft", "is_locked": true, "payment": { "type": "string", "id": 0, "body": "string", "link": "string" }, "revenue_recognitions": [ { … } ], "invoices": [ { … } ], "obligations": [ { … } ], "obligation_usage": [ { … } ], "contract_attachments": [], "change_orders_attachments": [] }
- Production environmenthttps://api.dualentry.com/public/v1/contracts/{contract_id}/usage/
- Development environment (for testing)https://api-dev.dualentry.com/public/v1/contracts/{contract_id}/usage/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.dualentry.com/public/v1/contracts/{contract_id}/usage/'Response
application/json
[ { "id": 0, "contract_id": 0, "obligation_id": 0, "usage_date": "2019-08-24", "quantity": "string", "rate": "string", "amount": "string", "effective_rate": "string", "revenue_recognition_id": 0, "status": "draft", "invoice_status": "string", "memo": "", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ]
- Production environmenthttps://api.dualentry.com/public/v1/contracts/{contract_id}/usage/bulk-upsert/
- Development environment (for testing)https://api-dev.dualentry.com/public/v1/contracts/{contract_id}/usage/bulk-upsert/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.dualentry.com/public/v1/contracts/{contract_id}/usage/bulk-upsert/' \
-H 'Content-Type: application/json' \
-d '{
"items": [
{
"id": 0,
"obligation_id": 0,
"usage_date": "2019-08-24",
"quantity": 0,
"rate": 0,
"status": "draft"
}
]
}'Response
application/json
[ { "id": 0, "contract_id": 0, "obligation_id": 0, "usage_date": "2019-08-24", "quantity": "string", "rate": "string", "amount": "string", "effective_rate": "string", "revenue_recognition_id": 0, "status": "draft", "invoice_status": "string", "memo": "", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ]