Get Started
API Reference
- Api keys
- Items
- Inventory Adjustments
- Branches
- Warehouses
- Accounts
- Inventory Cost
- Sale Invoices
- Pdf Templates
- Tax Rates
- Payments Received
- Import
- resources
- Payment Links
- stripe
- Item Categories
- Expenses
- Warehouse Transfers
- Customers
- Vendors
- Sale Estimates
- Sale Receipts
- Bills
- Landed Cost
- Manual Journals
- Credit Notes
- Credit Note Refunds
- Credit Notes Apply Invoice
- Vendor Credits
- Vendor Credits Apply Bills
- Bill Payments
- GETRetrieves the bill payments list.
- POSTCreate a new bill payment.
- GETRetrieves the bill payment details.
- PUTEdit the given bill payment.
- DELDelete the given bill payment.
- GETRetrieves the payable entries of the new page once vendor be selected.
- GETRetrieves the bills of the given bill payment.
- GETRetrieves the edit page of the given bill payment.
- GET
- Vendor Credits Refunds
- Bank Accounts
- Banking Plaid
- banking-plaid
- Banking Categorization
- Banking Transactions
- Banking Uncategorized Transactions
- Banking Pending Transactions
- Bank Rules
- Banking Recognized Transactions
- Banking Transactions Matching
- Transactions Locking
- Settings
- Reports
- Dashboard
- Roles
- Subscriptions
- Organization
- Payment Services
- Attachments
- Export
- Views
- Currencies
- misc
- Users
- Contacts
Bill Payments
Retrieves the bill payments list.
GET
/
api
/
bill-payments
Copy
{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"vendorId": 1,
"amount": 100,
"currencyCode": "USD",
"paymentAccountId": 2,
"paymentNumber": "PAY-2024-001",
"paymentDate": "2024-01-01",
"formattedPaymentDate": "2024-01-01",
"exchangeRate": 1,
"statement": "Payment for January bills",
"reference": "REF-123",
"branchId": 1,
"formattedAmount": "100.00 USD",
"createdAt": "2024-01-01T12:00:00Z",
"formattedCreatedAt": "2024-01-01",
"updatedAt": "2024-01-02T12:00:00Z",
"entries": [
{
"paymentAmountFormatted": "100.00",
"bill": {
"id": 1,
"billNumber": "BILL-2024-001",
"billDate": "2024-03-15T00:00:00Z",
"dueDate": "2024-04-15T00:00:00Z",
"referenceNo": "PO-2024-001",
"vendorId": 1001,
"exchangeRate": 1.25,
"currencyCode": "USD",
"note": "Office supplies and equipment for Q2 2024",
"isInclusiveTax": false,
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"warehouseId": 101,
"branchId": 201,
"projectId": 301,
"attachments": [
{}
],
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"taxAmountWithheld": 50,
"balance": 1000,
"paymentAmount": 500,
"creditedAmount": 0,
"subtotal": 900,
"total": 1000,
"dueAmount": 500,
"isOverdue": false,
"isPartiallyPaid": true,
"isFullyPaid": false,
"createdAt": "2024-03-15T00:00:00Z",
"updatedAt": "2024-03-16T00:00:00Z"
}
}
],
"attachments": [
{}
]
}
]
}
Headers
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Response
200 - application/json
The bill payments have been successfully retrieved.
The response is of type object
.
Copy
{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"vendorId": 1,
"amount": 100,
"currencyCode": "USD",
"paymentAccountId": 2,
"paymentNumber": "PAY-2024-001",
"paymentDate": "2024-01-01",
"formattedPaymentDate": "2024-01-01",
"exchangeRate": 1,
"statement": "Payment for January bills",
"reference": "REF-123",
"branchId": 1,
"formattedAmount": "100.00 USD",
"createdAt": "2024-01-01T12:00:00Z",
"formattedCreatedAt": "2024-01-01",
"updatedAt": "2024-01-02T12:00:00Z",
"entries": [
{
"paymentAmountFormatted": "100.00",
"bill": {
"id": 1,
"billNumber": "BILL-2024-001",
"billDate": "2024-03-15T00:00:00Z",
"dueDate": "2024-04-15T00:00:00Z",
"referenceNo": "PO-2024-001",
"vendorId": 1001,
"exchangeRate": 1.25,
"currencyCode": "USD",
"note": "Office supplies and equipment for Q2 2024",
"isInclusiveTax": false,
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"warehouseId": 101,
"branchId": 201,
"projectId": 301,
"attachments": [
{}
],
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"taxAmountWithheld": 50,
"balance": 1000,
"paymentAmount": 500,
"creditedAmount": 0,
"subtotal": 900,
"total": 1000,
"dueAmount": 500,
"isOverdue": false,
"isPartiallyPaid": true,
"isFullyPaid": false,
"createdAt": "2024-03-15T00:00:00Z",
"updatedAt": "2024-03-16T00:00:00Z"
}
}
],
"attachments": [
{}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.