ABCS Contacts API

1.0.0OAS 3.0
REST API for managing contacts in the ABCS Accounting system. ## Authentication Flow 1. Call `POST /api/token` with your `apiKey` and `secret`. 2. Use the returned JWT token on all protected endpoints as `Authorization: Bearer <token>`. 3. Each successful contacts endpoint response returns a new `nextToken` β€” use it on the next request. ## Rate Limiting All endpoints (except health check) have rate limiting. Response headers include: - `X-RateLimit-Limit` - `X-RateLimit-Remaining` - `X-RateLimit-Reset`
Servers
http://localhost:3000β€” Current server

Health

Service health check

GET/api/healthHealth Check

Authentication

Token generation

POST/api/tokenGenerate JWT Token

Contacts

Contact CRUD operations

GET/api/contactsList ContactsπŸ”’
POST/api/contactsCreate ContactπŸ”’
GET/api/contacts/{id}Get Contact by IDπŸ”’
PUT/api/contacts/{id}Update ContactπŸ”’
DELETE/api/contacts/{id}Delete Contact (Soft Delete)πŸ”’

Banks

Enrolled bank accounts (tbl_banks). Immediate write. DELETE sets isActive=0 (soft deactivate). Use GET /api/lookups/banks for institution and Cash-in-Bank GL dropdowns.

GET/api/banksList BanksπŸ”’
POST/api/banksCreate Bank AccountπŸ”’
GET/api/banks/{id}Get Bank by IDπŸ”’
PUT/api/banks/{id}Update BankπŸ”’
DELETE/api/banks/{id}Deactivate BankπŸ”’

Chart of Accounts

GL accounts (tbl_coa). Immediate write. DELETE sets isBlocked=1. glClass: Asset | Liability | Equity | Expense | Revenue normalBal: Dr | Cr Use GET /api/lookups/coa for class/type/category/taxType.

GET/api/coaList GL AccountsπŸ”’
POST/api/coaCreate GL AccountπŸ”’
GET/api/coa/{id}Get GL Account by IDπŸ”’
PUT/api/coa/{id}Update GL AccountπŸ”’
DELETE/api/coa/{id}Block GL AccountπŸ”’

Inventory

Inventory items (tbl_inventory). Immediate write. DELETE sets isBlocked=1. Use GET /api/lookups/inventory for type, category, and UOM.

GET/api/inventoryList Inventory ItemsπŸ”’
POST/api/inventoryCreate Inventory ItemπŸ”’
GET/api/inventory/{id}Get Inventory Item by IDπŸ”’
PUT/api/inventory/{id}Update Inventory ItemπŸ”’
DELETE/api/inventory/{id}Block Inventory ItemπŸ”’

Acknowledgement Receipt

Acknowledgement Receipt pending CRUD. Status: -1 = pending, 0 = posted. Dropdown values: - payment_method: cash | check - transaction_type: Cash Return | Donations or Similar | Payment - bank: bank institution ID - receive_to_account: enrolled bank account ID - tags: tag IDs (groups 1 / 2 / 4) - details account/code: chart of accounts title + code

GET/api/ar-requestsList Acknowledgement ReceiptsπŸ”’
POST/api/ar-requestsCreate Pending AR RequestπŸ”’
GET/api/ar-requests/{id}Get AR Request by IDπŸ”’
PUT/api/ar-requests/{id}Update Pending AR RequestπŸ”’
DELETE/api/ar-requests/{id}Delete Pending AR RequestπŸ”’

Accounts Receivable

Create Invoice / ARV billing. Status: -1 = pending, 0 = approved/posted. Server computes VAT, CWT, discount, and A/R lines from user `details`. Use GET /api/lookups/invoice for dropdown predict.

GET/api/invoice-requestsList Accounts ReceivableπŸ”’
POST/api/invoice-requestsCreate Pending Invoice (ARV)πŸ”’
GET/api/invoice-requests/{id}Get Invoice Request by IDπŸ”’
PUT/api/invoice-requests/{id}Update Pending Invoice RequestπŸ”’
DELETE/api/invoice-requests/{id}Delete Pending Invoice RequestπŸ”’
POST/api/invoice-requests/{id}/approveApprove Invoice RequestπŸ”’

AP Requests

Bills to Pay (AP) pending CRUD. Status: -1 = pending, 0 = posted. Dropdown values (use GET /api/lookups/ap for search): - btpType: bill type name - btpBiller: contact ID - btpPayTerms / btpPayType: payment term and type codes - btpTag1–btpTag4: tag IDs (0 if unused) - details[].btpAcctCode: chart of accounts GL code - details[].btpATC: BIR ATC code (optional) - details[].btpEWTRate: 0, 0.005, 1, 2, 5, 10, 15

GET/api/ap-requestsList AP RequestsπŸ”’
POST/api/ap-requestsCreate Pending AP RequestπŸ”’
GET/api/ap-requests/{id}Get AP Request by IDπŸ”’
PUT/api/ap-requests/{id}Update Pending AP RequestπŸ”’
DELETE/api/ap-requests/{id}Delete Pending AP RequestπŸ”’
POST/api/ap-requests/{id}/approveApprove AP RequestπŸ”’

Collection Requests

Collection Receipt (CRB) pending CRUD. Status: -1 = pending, 0 = posted. Approve posts CRB journal lines and updates invoice balance.

GET/api/collection-requestsList Collection RequestsπŸ”’
POST/api/collection-requestsCreate Pending Collection RequestπŸ”’
GET/api/collection-requests/{id}Get Collection Request by IDπŸ”’
PUT/api/collection-requests/{id}Update Pending Collection RequestπŸ”’
DELETE/api/collection-requests/{id}Delete Pending Collection RequestπŸ”’
POST/api/collection-requests/{id}/approveApprove Collection RequestπŸ”’

Check Voucher

Check Voucher / Cash Disbursement (CDB) pending CRUD. Status: -1 = pending, 0 = posted. Approve inserts payment record and updates BTP balance.

GET/api/cv-requestsList Check Voucher RequestsπŸ”’
POST/api/cv-requestsCreate Pending Check VoucherπŸ”’
GET/api/cv-requests/{id}Get Check Voucher by IDπŸ”’
PUT/api/cv-requests/{id}Update Pending Check VoucherπŸ”’
DELETE/api/cv-requests/{id}Delete Pending Check VoucherπŸ”’
POST/api/cv-requests/{id}/approveApprove Check VoucherπŸ”’

Journal Voucher

Manual Journal (MJ) pending CRUD. Resource `{id}` is the journal reference (`trxRef`). Status: -1 = pending, 0 = posted. Dr/Cr lines must balance.

GET/api/journal-requestsList Journal Voucher RequestsπŸ”’
POST/api/journal-requestsCreate Pending Journal VoucherπŸ”’
GET/api/journal-requests/{id}Get Journal Voucher by ReferenceπŸ”’
PUT/api/journal-requests/{id}Update Pending Journal VoucherπŸ”’
DELETE/api/journal-requests/{id}Delete Pending Journal VoucherπŸ”’
POST/api/journal-requests/{id}/approveApprove Journal VoucherπŸ”’

Void Transactions

Void billing invoices or disbursements. Requires `confirm: true`. Sets document status to 3; creates reverse JV when paid/partial.

GET/api/void-requestsList Void RecordsπŸ”’
POST/api/void-requestsVoid Invoice or DisbursementπŸ”’

Closing Periods

Month-end closing control. Insert-only; requires `confirm: true`.

GET/api/closing-periodsList Closed PeriodsπŸ”’
POST/api/closing-periodsClose Accounting PeriodπŸ”’

Lookups

Dropdown search for docs Try-it-out and API callers

GET/api/lookups/invoiceInvoice dropdown lookupπŸ”’
GET/api/lookups/apAP dropdown lookupπŸ”’
GET/api/lookups/arAR dropdown lookupπŸ”’
GET/api/lookups/banksBank dropdown lookupπŸ”’
GET/api/lookups/coaCOA dropdown lookupπŸ”’
GET/api/lookups/inventoryInventory dropdown lookupπŸ”’
GET/api/lookups/collectionCollection dropdown lookupπŸ”’
GET/api/lookups/cvCheck voucher dropdown lookupπŸ”’