invoices.get

One invoice with its lines, what has been paid, the balance, the due date, and whether a bank payment is still clearing. display_status is payment_pending while a bank payment clears (3 to 5 business days), otherwise the invoice status. last_bank_payment_failed_at is set when the latest bank payment failed and the customer can pay again.


Who	Agents can call this
REST	`GET /v1/invoices/get`
MCP tool	`invoices_get`
Writes	no
Area	Shop

When to use it

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

Field	Type	Required
`invoice_id`	string (uuid)	yes

Example

GET https://doingwork.work/v1/invoices/get?invoice_id=00000000-0000-4000-8000-000000000000

Output

Field	Type	Always there
`invoice_id`	string (uuid)	yes
`job_id`	string (uuid)	yes
`status`	string	yes
`currency`	string	yes
`total_minor`	integer	yes
`collected_minor`	integer	yes
`balance_minor`	integer	yes
`deposit_minor`	['integer', 'null']	yes
`issued_at`	['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']	yes
`due_on`	['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')']	yes
`memo`	['string', 'null']	yes
`bank_payment_clearing`	boolean	yes
`display_status`	string	yes
`last_bank_payment_failed_at`	['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']	yes
`lines`	array	yes
`lines[].position`	integer	yes
`lines[].description`	string	yes
`lines[].quantity`	number	yes
`lines[].unit_price_minor`	integer	yes
`lines[].kind`	string	yes
`lines[].taxable`	boolean	yes
`lines[].amount_minor`	integer	yes
`tax`	object	no
`tax.name`	['string', 'null']	yes
`tax.jurisdiction`	['string', 'null']	yes
`tax.rate_bps`	integer	yes
`tax.taxable_minor`	integer	yes
`tax.tax_minor`	integer	yes

{
  "invoice_id": "00000000-0000-4000-8000-000000000000",
  "job_id": "00000000-0000-4000-8000-000000000000",
  "status": "...",
  "currency": "...",
  "total_minor": 50000,
  "collected_minor": 50000,
  "balance_minor": 50000,
  "deposit_minor": "...",
  "issued_at": "...",
  "due_on": "...",
  "memo": "...",
  "bank_payment_clearing": true,
  "display_status": "...",
  "last_bank_payment_failed_at": "...",
  "lines": [
    {
      "position": 1,
      "description": "40 gallon gas heater, installed",
      "quantity": "...",
      "unit_price_minor": 50000,
      "kind": "...",
      "taxable": true,
      "amount_minor": 50000
    }
  ]
}

Errors

Code	Status	What to do
`invalid_input`, `invalid_token`, `rate_limited`		Can happen on any call. See errors.