Get an invoice
- Permissions
customers:read,invoices:read- Also available as
fieldtask_get_invoice
Returns one invoice by its ID, with its line items, taxes and discount.
Use the id from List invoices or from the Location header of a create response. The invoice must belong to the organization your credential is connected to; otherwise the response is 404 resource_not_found, the same as for an ID that doesn't exist or an invoice that has been deleted.
Reading an invoice never changes it. There's no endpoint to send an invoice, record a payment or collect money.
Permissions
| Permission | Dependency in the permission map |
|---|---|
customers:read | No dependencies |
invoices:read | Depends on customers:read |
Invoicing must be enabled for your organization. Otherwise the response is 404 resource_not_found.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 503
OK
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Bad Request
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Unauthorized
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Forbidden
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Not Found
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Method Not Allowed
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Too Many Requests
Response Headers
Responses must not be cached.
Seconds before retry; present on 429 and an in-progress operation.
Server-generated request correlation ID.
Service Unavailable
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
What's included
The invoice has every field from List invoices, plus:
| Field | Meaning |
|---|---|
items | The invoice's line items. |
tax1, tax2 | Each tax's name, type (percent or fixed), percent_amount and fixed_amount, or null. The amount that doesn't apply to the type is "0.00". |
discount | The discount's type, percent_amount and fixed_amount, or null. |
Each item has:
| Item field | Meaning |
|---|---|
name, description, item_type | As shown on the invoice. |
quantity, unit_price | Decimal strings with two decimal places. |
amount | Quantity × unit price, rounded to cents. |
tax1, tax2 | Whether each invoice tax applies to this item. |
tax1_amount, tax2_amount | The item's tax. A fixed tax adds its full amount to each flagged item. |
taxed_amount | amount plus both taxes. |
is_active | false for an item that's kept on the invoice but marked inactive. Inactive items still count towards the totals, as they do in FieldTask. |
For the order of the calculation and the rounding rule, see Totals, taxes and discounts.
An invoice can have at most 200 items in this response. An invoice with more returns 503 temporarily_unavailable rather than a partial list.
Payment details, sending history and the invoice's subject, po_number and notes aren't returned.
Errors
This endpoint accepts no query parameters.
| Status | code | Meaning | What to do |
|---|---|---|---|
| 400 | invalid_query | The query string has an unknown, repeated or invalid parameter. | Send only the documented query parameters, each once. |
| 401 | invalid_token | The bearer token is missing, malformed, expired, revoked or issued for a different resource (for example an MCP sign-in). | Send a current REST API token or REST OAuth access token as Authorization: Bearer …. |
| 403 | api_access_not_enabled | FieldTask hasn't enabled API access for this organization, or has disabled it. | An owner or admin requests access in Settings → API connections. |
| 403 | insufficient_scope | The connection lacks a permission this request needs. error.code is missing_permission. | Add the permission named in error.message to the connection. |
| 404 | resource_not_found | The invoice doesn't exist, has been deleted or belongs to another organization; invoicing isn't enabled for your organization or in this environment; or the URL is wrong. | Check the ID, that your organization can use invoices in FieldTask, and that the path has no trailing slash. |
| 405 | method_not_allowed | This path doesn't accept the HTTP method, or the create isn't enabled in this environment. The Allow header lists the methods that are. | Use a method listed in Allow. |
| 429 | rate_limit_exceeded | Too many requests in the current minute, or too many concurrent requests, for the organization or connection. | Wait for Retry-After seconds, then retry. |
| 429 | daily_quota_exceeded | The organization or connection has used its daily allowance for this kind of request. Allowances reset at 00:00 UTC. | Wait for Retry-After seconds, or check remaining allowance in Settings → API connections. |
| 503 | temporarily_unavailable | The service couldn't complete the request, or the invoice has more than 200 items or saved values the API can't return. | Retry with exponential backoff. If it keeps failing for one invoice, open it in FieldTask and include the request ID when contacting support. |