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
- 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
Customers
Edit the given customer.
PUT
/
api
/
customers
/
{id}
Copy
{
"balance": 1500,
"currencyCode": "USD",
"openingBalance": 1000,
"openingBalanceAt": "2024-01-01T00:00:00Z",
"openingBalanceExchangeRate": 1,
"openingBalanceBranchId": 1,
"salutation": "Mr.",
"firstName": "John",
"lastName": "Doe",
"companyName": "Acme Corporation",
"displayName": "John Doe - Acme Corporation",
"email": "[email protected]",
"workPhone": "+1 (555) 123-4567",
"personalPhone": "+1 (555) 987-6543",
"website": "https://www.acme.com",
"billingAddress1": "123 Business Ave",
"billingAddress2": "Suite 100",
"billingAddressCity": "New York",
"billingAddressCountry": "United States",
"billingAddressEmail": "[email protected]",
"billingAddressPostcode": "10001",
"billingAddressPhone": "+1 (555) 111-2222",
"billingAddressState": "NY",
"shippingAddress1": "456 Shipping St",
"shippingAddress2": "Unit 200",
"shippingAddressCity": "Los Angeles",
"shippingAddressCountry": "United States",
"shippingAddressEmail": "[email protected]",
"shippingAddressPostcode": "90001",
"shippingAddressPhone": "+1 (555) 333-4444",
"shippingAddressState": "CA",
"note": "Important client with regular monthly orders",
"active": true,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z",
"localOpeningBalance": 1000,
"closingBalance": 1500
}
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.
Path Parameters
Body
application/json
Response
200 - application/json
The customer has been successfully updated.
The response is of type object
.
Copy
{
"balance": 1500,
"currencyCode": "USD",
"openingBalance": 1000,
"openingBalanceAt": "2024-01-01T00:00:00Z",
"openingBalanceExchangeRate": 1,
"openingBalanceBranchId": 1,
"salutation": "Mr.",
"firstName": "John",
"lastName": "Doe",
"companyName": "Acme Corporation",
"displayName": "John Doe - Acme Corporation",
"email": "[email protected]",
"workPhone": "+1 (555) 123-4567",
"personalPhone": "+1 (555) 987-6543",
"website": "https://www.acme.com",
"billingAddress1": "123 Business Ave",
"billingAddress2": "Suite 100",
"billingAddressCity": "New York",
"billingAddressCountry": "United States",
"billingAddressEmail": "[email protected]",
"billingAddressPostcode": "10001",
"billingAddressPhone": "+1 (555) 111-2222",
"billingAddressState": "NY",
"shippingAddress1": "456 Shipping St",
"shippingAddress2": "Unit 200",
"shippingAddressCity": "Los Angeles",
"shippingAddressCountry": "United States",
"shippingAddressEmail": "[email protected]",
"shippingAddressPostcode": "90001",
"shippingAddressPhone": "+1 (555) 333-4444",
"shippingAddressState": "CA",
"note": "Important client with regular monthly orders",
"active": true,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z",
"localOpeningBalance": 1000,
"closingBalance": 1500
}
Assistant
Responses are generated using AI and may contain mistakes.