Skip to main content

Get an invoice

GEThttps://api.fieldtask.example/public/v1/invoices/{resource_id}
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​

PermissionDependency in the permission map
customers:readNo dependencies
invoices:readDepends on customers:read

Invoicing must be enabled for your organization. Otherwise the response is 404 resource_not_found.

Request​

Responses​

OK

Response Headers
    Cache-Control

    Responses must not be cached.

    X-Request-ID

    Server-generated request correlation ID.

What's included​

The invoice has every field from List invoices, plus:

FieldMeaning
itemsThe invoice's line items.
tax1, tax2Each 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".
discountThe discount's type, percent_amount and fixed_amount, or null.

Each item has:

Item fieldMeaning
name, description, item_typeAs shown on the invoice.
quantity, unit_priceDecimal strings with two decimal places.
amountQuantity × unit price, rounded to cents.
tax1, tax2Whether each invoice tax applies to this item.
tax1_amount, tax2_amountThe item's tax. A fixed tax adds its full amount to each flagged item.
taxed_amountamount plus both taxes.
is_activefalse 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.

StatuscodeMeaningWhat to do
400invalid_queryThe query string has an unknown, repeated or invalid parameter.Send only the documented query parameters, each once.
401invalid_tokenThe 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 ….
403api_access_not_enabledFieldTask hasn't enabled API access for this organization, or has disabled it.An owner or admin requests access in Settings → API connections.
403insufficient_scopeThe connection lacks a permission this request needs. error.code is missing_permission.Add the permission named in error.message to the connection.
404resource_not_foundThe 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.
405method_not_allowedThis 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.
429rate_limit_exceededToo many requests in the current minute, or too many concurrent requests, for the organization or connection.Wait for Retry-After seconds, then retry.
429daily_quota_exceededThe 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.
503temporarily_unavailableThe 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.