# Puzzle

> Read company accounting data, transactions, journal entries, bills, invoices, accounts, customers, vendors, statements and financial metrics.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/puzzle

## Actions

### Get Balance Sheet Statement

Get Balance Sheet Statement.

**Inputs**

- Company (`id`, text, required): The company ID
- Basis (`basis`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `cash`, `accrual`.
- ViewBy (`viewBy`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`, `quarter`, `year`, `totals`, `departments`.
- StartPeriod (`startPeriod`, text): Startperiod
- EndPeriod (`endPeriod`, text): Endperiod
- DateMacro (`dateMacro`, text): Datemacro. One of: `CurrentMonth`, `LastFullMonth`, `LastThreeMonths`, `LastThreeFullMonths`, `CurrentYear`, `LastYear`, `QuarterToDate`, `YearToDate`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "columns": [],
    "lines": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Bill

Get Bill.

**Inputs**

- Company (`id`, text, required): The company ID
- BillId (`billId`, text, required): The bill ID

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "amount": null,
    "currentness": "Current",
    "description": null,
    "documents": [],
    "dueDate": null,
    "externalId": null,
    "id": "example",
    "issueDate": "example",
    "lines": [],
    "paidAt": null,
    "provider": null,
    "status": "Deleted",
    "submittedAt": null,
    "userId": "example",
    "vendorId": "example",
    "voidedAt": null
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Bills

Get Bills.

**Inputs**

- Company (`id`, text, required): The company ID
- IsLinked (`isLinked`, text): Boolean flag; "true" enables, any other value disables
- IsPaid (`isPaid`, text): Boolean flag; "true" enables, any other value disables
- IsSubmitted (`isSubmitted`, text): Boolean flag; "true" enables, any other value disables
- IsVoided (`isVoided`, text): Boolean flag; "true" enables, any other value disables
- MinAmount (`minAmount`, text): Arbitrary-precision decimal, serialized as a string
- MaxAmount (`maxAmount`, text): Arbitrary-precision decimal, serialized as a string
- From value (`from_value`, text): Calendar date, YYYY-MM-DD
- To (`to`, text): Calendar date, YYYY-MM-DD
- DueDateFrom (`dueDateFrom`, text): Calendar date, YYYY-MM-DD
- DueDateTo (`dueDateTo`, text): Calendar date, YYYY-MM-DD
- Statuses (`statuses`, text): Statuses. One of: `Draft`, `Voided`, `Paid`, `Unpaid`, `Current`, `Overdue`.
- VendorIds (`vendorIds`, text): Partner-facing external identifier
- SortBy (`sortBy`, text): Sortby. One of: `AMOUNT_DESC`, `AMOUNT_ASC`, `DESCRIPTOR_DESC`, `DESCRIPTOR_ASC`, `DUE_DATE_DESC`, `DUE_DATE_ASC`, `ISSUE_DATE_DESC`, `ISSUE_DATE_ASC`, `VENDOR_DESC`, `VENDOR_ASC`.
- Count (`count`, number): Count
- After (`after`, text): After

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    },
    "total": {
      "amount": "example",
      "currency": "example"
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Cash Activity Statement

Get Cash Activity Statement.

**Inputs**

- Company (`id`, text, required): The company ID
- ViewBy (`viewBy`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`, `quarter`, `year`, `totals`, `departments`.
- StartPeriod (`startPeriod`, text): Startperiod
- EndPeriod (`endPeriod`, text): Endperiod
- DateMacro (`dateMacro`, text): Datemacro. One of: `CurrentMonth`, `LastFullMonth`, `LastThreeMonths`, `LastThreeFullMonths`, `CurrentYear`, `LastYear`, `QuarterToDate`, `YearToDate`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "columns": [],
    "lines": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Chart of Accounts

Get Chart of Accounts.

**Inputs**

- Company (`id`, text, required): The company ID
- Basis (`basis`, text): Basis. One of: `cash`, `accrual`.
- StartDate (`startDate`, date): Startdate
- EffectiveDate (`effectiveDate`, text): Calendar date, YYYY-MM-DD
- NominalCode (`nominalCode`, text): Nominalcode
- GetRestricted (`getRestricted`, text): Boolean flag; "true" enables, any other value disables

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "accounts": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get companies

Get companies.

**Inputs**

- Limit (`limit`, number): Page size for modern client credentials (default 100, maximum 100); ignored for OAuth and upstream users. From 1 to 100.
- Cursor (`cursor`, text): Pagination cursor for modern client credentials; ignored for OAuth and upstream users.
- Include (`include`, text): Adds integrationHealth to each company. Requires puzzle-client-id, Authorization: Bearer <client secret>, read:company, an active firm authorization and a nonremoved firm-client link. Ignored for OAuth and upstream users. One of: `integration_health`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "companies": [],
    "nextCursor": null
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Company

Get Company.

**Inputs**

- Company (`id`, text, required): The company ID

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "financialSummary": null,
    "id": "example",
    "institutionConnections": [],
    "metadata": null,
    "name": "example",
    "status": "Ready"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Current User

Get Current User.

**Inputs**: None.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "companies": [],
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Customers

Get Customers.

**Inputs**

- Company (`id`, text, required): The company ID
- Name (`name`, text): Name
- Type (`type`, text): Type. One of: `Individual`, `Business`, `Unknown`.
- Status (`status`, text): Status. One of: `Active`, `Inactive`, `Unknown`.
- Count (`count`, number): Count
- After (`after`, text): After

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Expense Metrics

Get Expense Metrics.

**Inputs**

- Company (`id`, text, required): The company ID
- StartDate (`startDate`, date, required): Calendar date, YYYY-MM-DD
- EndDateExclusive (`endDateExclusive`, text): Calendar date, YYYY-MM-DD
- Interval (`interval`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "metrics": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Financial Account Balances

Get Financial Account Balances.

**Inputs**

- Company (`id`, text, required): The company ID
- Dates (`dates`, date, required): Date to retrieve account balances for.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "balancesByDate": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Financial Accounts

Get Financial Accounts.

**Inputs**

- Company (`id`, text, required): The company ID

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "accounts": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Income Statement

Get Income Statement.

**Inputs**

- Company (`id`, text, required): The company ID
- Basis (`basis`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `cash`, `accrual`.
- ViewBy (`viewBy`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`, `quarter`, `year`, `totals`, `departments`.
- StartPeriod (`startPeriod`, text): Startperiod
- EndPeriod (`endPeriod`, text): Endperiod
- DateMacro (`dateMacro`, text): Datemacro. One of: `CurrentMonth`, `LastFullMonth`, `LastThreeMonths`, `LastThreeFullMonths`, `CurrentYear`, `LastYear`, `QuarterToDate`, `YearToDate`.
- Departments (`departments`, text): One or more cls_ classification segment IDs returned by GET /company/{id}/classifications, or the case-insensitive literal "none". Values may be repeated or comma-separated.
- Locations (`locations`, text): One or more cls_ classification segment IDs returned by GET /company/{id}/classifications, or the case-insensitive literal "none". Values may be repeated or comma-separated.
- ExpandCounterparties (`expandCounterparties`, text): Boolean flag; "true" enables, any other value disables
- ExpandRevenueSources (`expandRevenueSources`, text): Boolean flag; "true" enables, any other value disables

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "columns": [],
    "lines": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Invoice

Get Invoice.

**Inputs**

- Company (`id`, text, required): The company ID
- InvoiceId (`invoiceId`, text, required): The invoice ID

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "amount": {
      "amount": "example",
      "currency": "example"
    },
    "contractId": null,
    "customerId": null,
    "description": null,
    "documents": [],
    "dueDate": null,
    "id": "example",
    "issueDate": null,
    "lines": [],
    "nativeId": null,
    "status": "Deleted"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Invoices

Get Invoices.

**Inputs**

- Company (`id`, text, required): The company ID
- From value (`from_value`, text): Calendar date, YYYY-MM-DD
- To (`to`, text): Calendar date, YYYY-MM-DD
- CustomerIds (`customerIds`, text): Partner-facing external identifier
- Statuses (`statuses`, text): Statuses. One of: `Deleted`, `Draft`, `Posted`, `Voided`, `Paid`.
- CoaKeys (`coaKeys`, text): Chart-of-accounts key
- IsPaid (`isPaid`, text): Boolean flag; "true" enables, any other value disables
- MinAmount (`minAmount`, text): Arbitrary-precision decimal, serialized as a string
- MaxAmount (`maxAmount`, text): Arbitrary-precision decimal, serialized as a string
- SortBy (`sortBy`, text): Sortby. One of: `AMOUNT_DESC`, `AMOUNT_ASC`, `CUSTOMER_DESC`, `CUSTOMER_ASC`, `DESCRIPTOR_DESC`, `DESCRIPTOR_ASC`, `DUE_DATE_DESC`, `DUE_DATE_ASC`, `ISSUE_DATE_DESC`, `ISSUE_DATE_ASC`.
- Count (`count`, number): Count
- After (`after`, text): After

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    },
    "total": {
      "amount": "example",
      "currency": "example"
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Journal Entries

Get Journal Entries.

**Inputs**

- Company (`id`, text, required): The company ID
- Limit (`limit`, number): Limit
- Cursor (`cursor`, text): Cursor
- Basis (`basis`, text): Basis. One of: `cash`, `accrual`.
- CreatedAfter (`createdAfter`, date and time): ISO 8601 timestamp

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "journalEntries": [],
    "pageInfo": {
      "nextCursor": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Ledger Account

Get Ledger Account.

**Inputs**

- Company (`id`, text, required): The company ID
- LedgerAccountId (`ledgerAccountId`, text, required): The ledger account ID
- Basis (`basis`, text): Basis. One of: `cash`, `accrual`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "accountId": null,
    "category": "example",
    "coaKeys": [],
    "currentBalance": {
      "amount": "example",
      "currency": "example"
    },
    "currentBalanceWithoutSubAccounts": {
      "amount": "example",
      "currency": "example"
    },
    "currentness": null,
    "description": null,
    "id": "example",
    "isBankAccount": false,
    "keywords": [],
    "name": "example",
    "nominalCode": "example",
    "parentCode": null,
    "restrictedCoaKeys": [],
    "subCategory": null,
    "tags": [],
    "tertiaryCategory": null,
    "type": "example",
    "views": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Puzzle Categories

Get Puzzle Categories.

**Inputs**: None.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "categories": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Requests

Get Requests.

**Inputs**

- Company (`id`, text, required): The company ID
- Status (`status`, text): Status
- Type (`type`, text): Type
- TransactionIds (`transactionIds`, text): Partner-facing external identifier
- RequestedUserIds (`requestedUserIds`, text): Partner-facing external identifier
- RequestedByUserIds (`requestedByUserIds`, text): Partner-facing external identifier
- StartDate (`startDate`, date): Calendar date, YYYY-MM-DD
- EndDate (`endDate`, date): Calendar date, YYYY-MM-DD

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "requests": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Revenue Metrics

Get Revenue Metrics.

**Inputs**

- Company (`id`, text, required): The company ID
- StartDate (`startDate`, date, required): Calendar date, YYYY-MM-DD
- EndDateExclusive (`endDateExclusive`, text): Calendar date, YYYY-MM-DD
- Interval (`interval`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "metrics": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Spending Metrics

Get Spending Metrics.

**Inputs**

- Company (`id`, text, required): The company ID
- StartDate (`startDate`, date, required): Calendar date, YYYY-MM-DD
- EndDateExclusive (`endDateExclusive`, text): Calendar date, YYYY-MM-DD
- Interval (`interval`, text): The value is normalized before matching, so any casing that maps onto a listed value is accepted. One of: `month`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "endPeriod": "example",
    "nonPayrollMetrics": [],
    "payrollMetrics": [],
    "startPeriod": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Tasks

Get Tasks.

**Inputs**

- Company (`id`, text, required): The company ID
- Status (`status`, text): Status
- Type (`type`, text): Type
- AssigneeIds (`assigneeIds`, text): Partner-facing external identifier
- TransactionIds (`transactionIds`, text): Partner-facing external identifier
- CreatedBy (`createdBy`, text): Partner-facing external identifier
- CreatedAfter (`createdAfter`, date and time): ISO 8601 timestamp
- Count (`count`, number): Count
- After (`after`, text): After

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Transaction

Get Transaction.

**Inputs**

- IncludeCategorization (`includeCategorization`, text): Include categorization attribution and history only when "true"; omitted by default
- Company (`id`, text, required): The company ID
- TransactionId (`transactionId`, text, required): The transaction ID

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "accountId": null,
    "actorType": "SYSTEM_ACTOR",
    "amount": {
      "amount": "example",
      "currency": "example"
    },
    "categorization": {
      "confirmationStatus": "CONFIRMED",
      "confirmedAt": null,
      "details": [],
      "detailsConfirmationStatus": "CONFIRMED",
      "lastHumanConfirmation": null,
      "status": "CATEGORIZED"
    },
    "category": null,
    "classifications": null,
    "coaKey": null,
    "customerId": null,
    "descriptor": "example",
    "documents": null,
    "id": "example",
    "memo": null,
    "nativeId": null,
    "status": "Finalized",
    "timestamp": "example",
    "vendorId": null
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Transactions

Get Transactions.

**Inputs**

- IncludeCategorization (`includeCategorization`, text): Include categorization attribution and history only when "true"; omitted by default
- Company (`id`, text, required): The company ID
- StartDate (`startDate`, date, required): Calendar date, YYYY-MM-DD
- EndDate (`endDate`, date, required): Calendar date, YYYY-MM-DD
- AccountIds (`accountIds`, text): Partner-facing external identifier
- VendorIds (`vendorIds`, text): Partner-facing external identifier
- CoaKeys (`coaKeys`, text): Coakeys
- Status (`status`, text): Status. One of: `Finalized`, `NotFinalized`, `NotCategorized`.
- SortBy (`sortBy`, text): Sortby. One of: `ABS_AMOUNT_ASC`, `ABS_AMOUNT_DESC`, `AMOUNT_ASC`, `AMOUNT_DESC`, `DATE_ASC`, `DATE_DESC`, `DESCRIPTION_ASC`, `DESCRIPTION_DESC`, `NAME_ASC`, `UNCATEGORIZED_AMOUNT_DESC`, `VENDOR_ASC`, `VENDOR_DESC`.
- After (`after`, text): After
- Count (`count`, number): Count

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get Vendors

Get Vendors.

**Inputs**

- Company (`id`, text, required): The company ID
- Type (`type`, text): Type. One of: `Individual`, `Business`, `Unknown`.
- Status (`status`, text): Status. One of: `Active`, `Inactive`, `Unknown`.
- PermaNames (`permaNames`, text): Permanames
- Is1099Vendor (`is1099Vendor`, text): Boolean flag; "true" enables, any other value disables
- Count (`count`, number): Count
- After (`after`, text): After

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": [],
    "pageInfo": {
      "endCursor": null,
      "hasNextPage": false,
      "total": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}
```
