| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | — | link | — | — | — |
Actions (57)
Categories · 20
- Create expensePOST /api/categories/expenses
Create a new expense category/record.
documented - Create itemPOST /api/categories/items
Create a new item (saved line item).
documented - Create taskPOST /api/categories/tasks
Create a new task category/record.
documented - Create tripPOST /api/categories/trips
Create a new trip.
documented - Delete expenseDELETE /api/categories/expenses/{id}
Delete an expense.
documented - Delete itemDELETE /api/categories/items/{id}
Delete an item.
documented - Delete taskDELETE /api/categories/tasks/{id}
Delete a task.
documented - Delete tripDELETE /api/categories/trips/{id}
Delete a trip.
documented - List expensesGET /api/categories/expenses
List expense categories/records.
documented - List itemsGET /api/categories/items
List saved items.
documented - List tasksGET /api/categories/tasks
List task categories/records.
documented - List tripsGET /api/categories/trips
List trips.
documented - Retrieve expenseGET /api/categories/expenses/{id}
Retrieve an expense by ID.
documented - Retrieve itemGET /api/categories/items/{id}
Retrieve an item by ID.
documented - Retrieve taskGET /api/categories/tasks/{id}
Retrieve a task by ID.
documented - Retrieve tripGET /api/categories/trips/{id}
Retrieve a trip by ID.
documented - Update expensePUT /api/categories/expenses/{id}
Update an expense category/record.
documented - Update itemPUT /api/categories/items/{id}
Update a saved item.
documented - Update taskPUT /api/categories/tasks/{id}
Update a task category/record.
documented - Update tripPUT /api/categories/trips/{id}
Update a trip.
documented
Invoices · 13
- Create invoicePOST /api/invs
Create a new invoice.
documented - Create paymentPOST /api/invs/{hash_key}/payments
Record a new payment against this invoice.
documented - Delete invoiceDELETE /api/invs/{hash_key}
Move the invoice to Trash.
documented - Delete paymentDELETE /api/invs/{hash_key}/payments/{id}
Permanently delete a payment.
documented - Deliver invoicePOST /api/invs/{hash_key}/deliver
Deliver the invoice via email using default or custom content.
documented - Deliver invoicePOST /api/invs/{hash_key}/deliver
Deliver the invoice via email.
documented - List invoicesGET /api/invs
Return all invoices for the account.
documented - List paymentsGET /api/invs/{hash_key}/payments
List payments recorded for this invoice.
documented - Mark payment as realizedPOST /api/invs/{hash_key}/payments/{id}/mark_as_realized
Mark a payment as realized.
documented - Retrieve invoiceGET /api/invs/{hash_key}
Get a single invoice by its hash_key.
documented - Retrieve paymentGET /api/invs/{hash_key}/payments/{id}
Get a specific payment by ID.
documented - Send invoice reminderPOST /api/invs/{hash_key}/reminder
Send a reminder for the invoice.
documented - Update invoicePUT /api/invs/{hash_key}
Update an existing invoice.
documented
Networks · 13
- Create connectionPOST /api/network
Create a new Hiveage Connection (company, client or vendor).
documented - Create contactPOST /api/network/{hash_key}/contacts
Create a new contact for the specified connection.
documented - Delete connectionDELETE /api/network/{hash_key}
Move the connection to Trash (soft delete).
documented - Delete contactDELETE /api/network/{hash_key}/contacts/{id}
Delete a contact.
documented - List connectionsGET /api/network
Return all connections for the account, sorted alphabetically.
documented - List contactsGET /api/network/{hash_key}/contacts
List all contacts for the specified connection.
documented - List estimates (for network)GET /api/network/{hash_key}/estimates
List estimates associated with the network (connection).
documented - List invoices (for network)GET /api/network/{hash_key}/invoices
List invoices associated with the network (connection).
documented - List recurring invoices (for network)GET /api/network/{hash_key}/recurring_invoices
List recurring invoices associated with the network.
documented - Retrieve connectionGET /api/network/{hash_key}
Get details of a specific connection by hash_key.
documented - Retrieve contactGET /api/network/{hash_key}/contacts/{id}
Get a contact by ID for the specified connection.
documented - Update connectionPUT /api/network/{hash_key}
Update details of an existing connection.
documented - Update contactPUT /api/network/{hash_key}/contacts/{id}
Update details of a contact.
documented
Recurring Invoices · 6
- Create recurring invoicePOST /api/rinv
Create a new recurring invoice schedule.
documented - Delete recurring invoiceDELETE /api/rinv/{hash_key}
Move the recurring invoice to Trash.
documented - List recurring invoices (network)GET /api/network/{hash_key}/recurring_invoices
List recurring invoices associated with a network.
documented - Recurring invoice -> generated invoicesGET /api/rinv/{hash_key}/invoices
List invoices generated from a recurring invoice.
documented - Retrieve recurring invoiceGET /api/rinv/{hash_key}
Get a recurring invoice by hash_key.
documented - Update recurring invoicePUT /api/rinv/{hash_key}
Update an existing recurring invoice.
documented
Estimates · 5
- Create estimatePOST /api/estm
Create a new estimate.
documented - Delete estimateDELETE /api/estm/{hash_key}
Move the estimate to Trash.
documented - List estimates (network)GET /api/network/{hash_key}/estimates
List estimates associated with a network/connection.
documented - Retrieve estimateGET /api/estm/{hash_key}
Get a specific estimate by hash_key.
documented - Update estimatePUT /api/estm/{hash_key}
Update an existing estimate.
documented