---
title: "Retrieves a Invoice resource."
method: GET
path: "/invoices/{id}"
tags: ["Invoice"]
---

# Retrieves a Invoice resource.

`GET /invoices/{id}`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/invoices/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/invoices/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a Invoice resource.

## Path parameters

- `id` string, required

## Response `200`

Invoice resource

- Invoice: A statement of the money due for goods or services; a bill.
  - `id` string: unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34"
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `additionalType` string, nullable: An additional type for the item. This is a relationship between something and a class that the thing is in.
  - `category` string, nullable: A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
  - `confirmationNumber` string, nullable: a number that confirms the given order or payment has been received
  - `customerId` string, nullable: party placing the order or paying the invoice
  - `paymentMethod` string, nullable: the name of the credit card or other method of payment for the order
  - `paymentMethodId` string, nullable: An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
  - `paymentDueDate` string, date-time, nullable: The date the payment is due
  - `provider` string, nullable: The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
  - `potentialAction` string, nullable: indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role
  - `broker` string, nullable: An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.
  - `minimumPaymentDue` integer, nullable: the minimum payment required at this time
  - `accountId` string, nullable: the identifier for the account the payment will be applied to
  - `scheduledPaymentDate` string, date-time, nullable: the date the invoice is scheduled to be paid
  - `billingPeriod` string, nullable: the time interval used to compute the invoice in ISO 8601 duration format
  - `status` string, nullable: the status of payment; whether the invoice has been paid or not
  - `paymentStatus` string, nullable
  - `created` string, date-time, nullable: The date and time the invoice was first created
  - `modified` string, date-time, nullable: The date and time the invoice was last updated
  - `subtotal` integer, nullable: Total payment amount, before tax
  - `taxAmount` integer, nullable: Tax amount
  - `currencyCode` string, nullable: Currency code
  - `invoiceNumber` string, nullable: Invoice number
  - `amountPaid` integer, nullable: Amount paid so far
  - `amountCredited` integer, nullable: The amount remaining that is due
  - `customerName` string, nullable: The customer's name
  - `customerMemo` string, nullable
  - `billingEmail` string, nullable: The customer's email
  - `billingAddressType` string, nullable
  - `billingAddressLine1` string, nullable: * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true})
  - `billingAddressLine2` string, nullable
  - `billingCity` string, nullable
  - `billingPostalCode` string, nullable
  - `shippingAddressType` string, nullable
  - `shippingAddressLine1` string, nullable
  - `shippingAddressLine2` string, nullable
  - `shippingCity` string, nullable
  - `shippingPostalCode` string, nullable
  - `srcId` string: the unique identifier of the source 3rd party integration
  - `url` string, nullable: Invoice url
  - `txnDate` string, date-time, nullable: Transaction date
  - `jsonAddress` string, nullable: Billing address in json format
  - `subscriptionId` string, nullable: The ID of the subscription the invoice was prepared for
  - `referenceNumber` string, nullable: Reference number of sale order
  - `balance` integer, nullable: Ending customer balance after the invoice is finalized
  - `accountName` string, nullable: The name of the business associated with the invoice
  - `purchaseOrderNum` integer, nullable: Purchase order number
  - `billingCountry` string, nullable: Billing address country
  - `totalAmount` integer, nullable: Total amount of the invoice
  - `billingState` string, nullable: State the billing address is addressed to
  - `shippingCountry` string, nullable: Country the shipping address is addressed to
  - `shippingState` string, nullable: State the shipping address is addressed to
  - `amountDue` integer, nullable: The unpaid amount that is due on the invoice

## Other responses

- `404`: Resource not found

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)