Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Invoices
Get invoices
Returns a list of invoices for a specified matter.
GET
/
matters
/
{matterId}
/
invoices
Get invoices
Copy
Ask AI
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/invoices \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
Copy
Ask AI
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"id": "16567e88-784c-470e-8952-e5a70fe2eb0c",
"versionId": "39ffde97-eeeb-4747-bb8f-7c7c10b3c985",
"matter": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"matterId": "6398a045-509e-49a2-9268-bb8231fa9340",
"lastUpdatedByUserId": "5fc5ee85-6643-4623-b019-a0dccceafe47",
"description": "Services provided.",
"status": 0,
"invoiceNumber": 10001,
"invoiceTitle": "My First Invoice",
"invoiceTitleLine2": "Subtitle",
"issuedDate": "2022-09-16T00:00:00+00:00",
"dueDate": "2022-09-25T00:00:00+00:00",
"paidDate": "2022-09-20T00:00:00+00:00",
"discount": {
"type": 0,
"fixedDiscount": 100,
"percentage": 10,
"description": "Friend of the Firm"
},
"surcharge": {
"type": 1,
"fixedSurcharge": 100,
"percentage": 123,
"description": "Late Payment Fee",
"applyTo": 1
},
"debtors": [
{
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}
],
"entries": [
{
"id": "<string>",
"versionId": "<string>",
"type": 0
}
],
"waived": false,
"invoiceTotals": {
"paid": 100,
"billed": 200,
"unpaid": 100,
"unpaidExcInterest": 100,
"writtenOff": 0,
"waived": 0,
"discount": 0,
"total": 100,
"tax": 10,
"interest": 0,
"feeTotal": 100,
"writtenOffFeeTotal": 100,
"expenseTotal": 100,
"writtenOffExpenseTotal": 180
}
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}
Path Parameters
The unique identifier of the matter that the invoice belongs to.
Query Parameters
Timestamp in ticks. Use this to only get invoices which have been updated
Required range:
0 <= x <= 2147483647
Required range:
1 <= x <= 500
Response
200 - application/json
Returns the invoices
The response is of type object
.
Get invoices
Copy
Ask AI
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/invoices \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
Copy
Ask AI
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"id": "16567e88-784c-470e-8952-e5a70fe2eb0c",
"versionId": "39ffde97-eeeb-4747-bb8f-7c7c10b3c985",
"matter": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"matterId": "6398a045-509e-49a2-9268-bb8231fa9340",
"lastUpdatedByUserId": "5fc5ee85-6643-4623-b019-a0dccceafe47",
"description": "Services provided.",
"status": 0,
"invoiceNumber": 10001,
"invoiceTitle": "My First Invoice",
"invoiceTitleLine2": "Subtitle",
"issuedDate": "2022-09-16T00:00:00+00:00",
"dueDate": "2022-09-25T00:00:00+00:00",
"paidDate": "2022-09-20T00:00:00+00:00",
"discount": {
"type": 0,
"fixedDiscount": 100,
"percentage": 10,
"description": "Friend of the Firm"
},
"surcharge": {
"type": 1,
"fixedSurcharge": 100,
"percentage": 123,
"description": "Late Payment Fee",
"applyTo": 1
},
"debtors": [
{
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}
],
"entries": [
{
"id": "<string>",
"versionId": "<string>",
"type": 0
}
],
"waived": false,
"invoiceTotals": {
"paid": 100,
"billed": 200,
"unpaid": 100,
"unpaidExcInterest": 100,
"writtenOff": 0,
"waived": 0,
"discount": 0,
"total": 100,
"tax": 10,
"interest": 0,
"feeTotal": 100,
"writtenOffFeeTotal": 100,
"expenseTotal": 100,
"writtenOffExpenseTotal": 180
}
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.