Get one record of any type

​

Fetch a record without knowing its type in advance. act-minted ids carry their type in the prefix (t0_invoice_…); for ids you supplied through insert, pass type.

Path Parameters
  • external_id
    Type: string · External Id
    required

    The record's external id.

Query Parameters
  • type
    Type: string · Typeenumnullable

    Public type name. Required when the id was not minted by act.

    values
    • Invoice
    • VendorBill
    • Payment
    • Customer
    • Vendor
    • LineItem
    • BillLineItem
  • expand
    Type: array string[] | null · Expandnullable

    Linked records to include under expanded; must be links the resolved type declares (see /types).

  • include_deleted
    Type: boolean · Include Deleted

    Return the record even if act has deleted it.

Headers
  • X-Api-Key
    Type: string · X-Api-Keynullable
Responses
  • application/json
  • 400

    The record's type could not be resolved: no act prefix and no type, an unknown type, a type contradicting the prefix, or an act type not served here (CAPI66); or expand names a link the resolved type does not declare (CAPI68).

  • 401

    Missing or invalid X-Api-Key (CAPI11).

  • 403

    The key lacks the customer_api:read permission (CAPI71).

  • 404

    No record of this type with that id in the key's entity (CAPI61).

  • 409

    The id resolves to more than one record of this type (CAPI63), or the entity has no applied books start date (CAPI67).

  • application/json
Request Example for get/v1/objects/{external_id}
curl '/v1/objects/{external_id}' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

{
  "data": {
    "amount": 1,
    "currencyCode": "string",
    "customFields": {
      "additionalProperty": "anything"
    },
    "date": "2026-09-10",
    "description": "string",
    "endDate": "2026-09-10",
    "exchangeRates": [],
    "startDate": "2026-09-10"
  },
  "id": {
    "dataType": "Adjustment",
    "externalId": "string",
    "platformDataType": "string",
    "platformId": "string",
    "platformType": "string"
  },
  "links": [],
  "expanded": {
    "additionalProperty": [
      {
        "data": {
          "amount": 1,
          "currencyCode": "string",
          "customFields": {
            "additionalProperty": "anything"
          },
          "date": "2026-09-10",
          "description": "string",
          "endDate": "2026-09-10",
          "exchangeRates": [],
          "startDate": "2026-09-10"
        },
        "id": {
          "dataType": "Adjustment",
          "externalId": "string",
          "platformDataType": "string",
          "platformId": "string",
          "platformType": "string"
        },
        "links": []
      }
    ]
  },
  "expanded_truncated": [
    "string"
  ]
}

Successful Response