API reference

Income

NQD API Income reference. List income records; Retrieve income record; Create income records

OpenAPI JSON
GET /v1/income
List income records
GET /v1/income/{incomeId}
Retrieve income record
POST /v1/income
Create income records
PUT /v1/income/{incomeId}
Upsert income record
DELETE /v1/income/{incomeId}
Delete income record
PUT /v1/income
Upsert income records in a batch
GET /v1/income/{incomeId}/entries
List applied entries for an income record
POST /v1/income/{incomeId}/entries
Add applied entry to an income record
PATCH /v1/income/{incomeId}/entries/{entryId}
Partially update applied entry on an income record
DELETE /v1/income/{incomeId}/entries/{entryId}
Remove applied entry from an income record
PUT /v1/income/{incomeId}/entries/reorder
Reorder applied entries for an income record
GET /v1/income/{incomeId}/modifiers
List applied modifiers for an income record
POST /v1/income/{incomeId}/modifiers
Add applied modifier to an income record
PATCH /v1/income/{incomeId}/modifiers/{modifierId}
Partially update applied modifier on an income record
DELETE /v1/income/{incomeId}/modifiers/{modifierId}
Remove applied modifier from an income record
PUT /v1/income/{incomeId}/modifiers/reorder
Reorder applied modifiers for an income record
GET /v1/income/{sourceId}/transactions
List transactions
POST /v1/income/{sourceId}/transactions
Record a payment

Every operation uses the same Core contract as the dashboard. Request and response fields, examples, and code samples are generated from the current API descriptor.