List a purchase invoice's lines

Returns the lines of a purchase invoice under purchase_invoice.lines.

GET /purchase_invoices/{purchase_invoice_id}/lines

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001/lines?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "purchase_invoice": {
    "lines": [
      {
        "accounting_code": "<string>",
        "id": "<string>",
        "item": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "object": "<string>",
        "quantity": 123,
        "subtotal": "<string>",
        "tax": "<string>",
        "total": "<string>",
        "uom": "<string>",
        "version": 123,
        "warehouse": "<string>"
      }
    ],
    "object": "<string>"
  }
}

Returns the purchase invoice’s lines as purchase_invoice.lines, not as a paged data list. This read is not paged, and limit, cursor and sort are not documented to change it. Use a line’s id to read it on its own.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

purchase_invoice_id · string · required

The purchase invoice's id.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor value from the previous page, to read the next one.

sort · string

The field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

The invoice's lines, under purchase_invoice.lines.

purchase_invoice · object

Show child attributes