### Install iDWELL Finance API Go SDK

Source: https://github.com/idwell/finance-api/blob/master/README.md

Command to install the iDWELL Finance API Go SDK using Go modules. This provides type-safe access to API endpoints.

```bash
go get github.com/iDWELL/finance-api/golang/finance
```

--------------------------------

### POST Partner Companies Example

Source: https://github.com/idwell/finance-api/blob/master/README.md

Example of how to create or update partner companies using a cURL request. This endpoint accepts a JSON array of partner objects.

```sh
curl -X POST \
  -H "Authorization: Bearer ${IDWELL_API_KEY}" \
  -H "Content-Type: application/json" \
  --data '[{"Name":"Beispiel GmbH","Street":"Ringstrasse","ZIP":"10115","City":"Berlin","Country":"DE","Email":"contact@example.com","ClientAccountNumber":"K1","VendorAccountNumber":"L1","Active":true}]' \
  -o - \
  https://idwell.ai/api/public/masterdata/partner-companies
```

--------------------------------

### GraphQL API Endpoint Example

Source: https://github.com/idwell/finance-api/blob/master/README.md

Example of a POST request to the GraphQL API endpoint for authentication.

```http
POST https://idwell.ai/api/public/graphql

Authorization: Bearer ${IDWELL_API_KEY}
```

--------------------------------

### Example JSON Request Body for GL Accounts

Source: https://github.com/idwell/finance-api/blob/master/README.md

Provides an example of the JSON array format required for the request body when posting General Ledger Accounts. It includes sample data for two accounts, showcasing different fields and their possible values.

```json
[
  {
    "Number": "1/200",
    "Name": "Account for object 66",
    "Category": null,
    "ObjectNo": "66",
    "Active": true
  },
  {
    "Number": "9/100",
    "Name": "Other costs",
    "Active": false
  }
]
```

--------------------------------

### Download Document PDF with Audit Trail Options

Source: https://github.com/idwell/finance-api/blob/master/README.md

This example shows how to download a document PDF with various audit trail options and language settings. The `auditTrail` parameter can be set to 'append', 'prepend', 'configured', or 'only'. The `auditTrailLang` parameter specifies the language.

```sh
https://idwell.ai/api/public/document/00000000-0000-0000-0000-000000000000.pdf?auditTrail=only&auditTrailLang=en
```

--------------------------------

### Example POST Request URL for GL Accounts

Source: https://github.com/idwell/finance-api/blob/master/README.md

This URL demonstrates how to use various optional query parameters to customize the GL account import process, such as specifying the data source, handling object-specific account numbers, enabling name search, and controlling error handling behavior.

```url
https://idwell.ai/api/public/masterdata/gl-accounts?source=MyCompany&objectSpecificAccountNos=true&findByName=true&failOnInvalid=false&allOrNone=true&useCleanedInvalid=true
```

--------------------------------

### Import General Ledger Accounts using Finance API

Source: https://github.com/idwell/finance-api/blob/master/README.md

Illustrates importing general ledger accounts into the Finance API. This example defines account details like number, name, category, and active status, then processes import results, checking for errors. Requires API key.

```go
import (
    "context"
    "github.com/iDWELL/finance-api/golang/finance"
    "github.com/domonda/go-types/account"
    "github.com/domonda/go-types/nullable"
)

func importGLAccounts() error {
    ctx := context.Background()
    apiKey := "YOUR_API_KEY"

    accounts := []*finance.GLAccount{
        {
            Number:   account.Number("1000"),
            Name:     nullable.TrimmedString("Cash"),
            Category: nullable.TrimmedString("Assets"),
            Active:   true,
        },
        {
            Number:   account.Number("4000"),
            Name:     nullable.TrimmedString("Sales Revenue"),
            Category: nullable.TrimmedString("Revenue"),
            Active:   true,
        },
    }

    results, err := finance.PostGLAccounts(
        ctx,
        apiKey,
        accounts,
        false, // findByName
        false, // objectSpecificAccountNos
        false, // failOnInvalid
        true,  // allOrNone
        "MyERP", // source
    )
    if err != nil {
        return err
    }

    // Check results
    for i, result := range results {
        if result.State == finance.ImportStateError {
            println("Account", i, "error:", result.Error)
        } else {
            println("Account", result.NormalizedNumber, "imported with state:", result.State)
        }
    }

    return nil
}
```

--------------------------------

### GraphQL API Authentication with Curl

Source: https://github.com/idwell/finance-api/blob/master/README.md

Minimal example using curl to authenticate and query the GraphQL API.

```sh
curl -X POST \
  -H "Authorization: Bearer ${IDWELL_API_KEY}" \
  -H "Content-Type: application/graphql" \
  --data "{ allDocuments{ totalCount } }" \
  -o - \
  https://idwell.ai/api/public/graphql
```

--------------------------------

### Bash Script to Get Document Custom Fields

Source: https://github.com/idwell/finance-api/blob/master/README.md

Example bash script using curl to fetch custom fields for a specific document from the iDWELL API. Replace 'your API key' and 'document ID' with actual values.

```bash
#!/bin/bash

TOKEN="your API key"
doc_id="document ID"

curl https://idwell.ai/api/public/document/${doc_id}/custom-fields/ \
    -H "Authorization: Bearer ${TOKEN}"
```

--------------------------------

### Download PDF with Go SDK

Source: https://github.com/idwell/finance-api/blob/master/README.md

Demonstrates how to download a document as a PDF using the Go SDK. Supports options for including an audit trail and embedding XML.

```go
import (
    "context"
    "github.com/domonda/go-types/uu"
    "github.com/iDWELL/finance-api/golang/finance"
)

func downloadDocument() error {
    ctx := context.Background()
    apiKey := "YOUR_API_KEY"
    docID := uu.IDFromString("00000000-0000-0000-0000-000000000000")

    // Plain PDF
    file, err := finance.DownloadDocumentPDF(ctx, apiKey, docID)

    // PDF with audit trail appended in English
    file, err = finance.DownloadDocumentPDF(ctx, apiKey, docID,
        finance.WithAuditTrail("append"),
        finance.WithAuditTrailLang("en"),
    )

    // Audit trail only, with embedded XML
    file, err = finance.DownloadDocumentPDF(ctx, apiKey, docID,
        finance.WithAuditTrail("only"),
        finance.WithEmbedXML(),
    )

    if err != nil {
        return err
    }

    println("Downloaded:", file.Name(), len(file.FileData), "bytes")
    return nil
}
```

--------------------------------

### Download PDF with Go SDK

Source: https://github.com/idwell/finance-api/blob/master/README.md

Demonstrates how to download PDF documents using the Go SDK, with options for including an audit trail and embedded XML.

```APIDOC
## Download PDF with Go SDK

This section details how to download PDF documents using the Go SDK.

### Function Signature
`finance.DownloadDocumentPDF(ctx context.Context, apiKey string, docID uu.ID, options ...finance.DownloadOption) (*finance.File, error)`

### Description
Downloads a PDF document associated with a given document ID. Optional parameters allow for the inclusion of an audit trail (with language specification) and embedding of XML data.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Options
- `finance.WithAuditTrail(value string)`: Appends an audit trail. Valid values are "append" or "only".
- `finance.WithAuditTrailLang(lang string)`: Specifies the language for the audit trail (e.g., "en").
- `finance.WithEmbedXML()`: Embeds XML data within the PDF.

### Request Example
```go
import (
    "context"
    "github.com/domonda/go-types/uu"
    "github.com/iDWELL/finance-api/golang/finance"
)

func downloadDocument() error {
    ctx := context.Background()
    apiKey := "YOUR_API_KEY"
    docID := uu.IDFromString("00000000-0000-0000-0000-000000000000")

    // Plain PDF
    file, err := finance.DownloadDocumentPDF(ctx, apiKey, docID)

    // PDF with audit trail appended in English
    file, err = finance.DownloadDocumentPDF(ctx, apiKey, docID,
        finance.WithAuditTrail("append"),
        finance.WithAuditTrailLang("en"),
    )

    // Audit trail only, with embedded XML
    file, err = finance.DownloadDocumentPDF(ctx, apiKey, docID,
        finance.WithAuditTrail("only"),
        finance.WithEmbedXML(),
    )

    if err != nil {
        return err
    }

    println("Downloaded:", file.Name(), len(file.FileData), "bytes")
    return nil
}
```

### Response
#### Success Response
Returns a `finance.File` object containing the downloaded file's name and data.

#### Response Example
```
Downloaded: document.pdf 12345 bytes
```
```

--------------------------------

### derivedTitle

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/document.doc.html

Gets the title of the Document, properly derived from its data.

```APIDOC
## derivedTitle

### Description
Gets the title of the `Document` properly derived from its data.

### Returns
[String](string.doc.html)!
```

--------------------------------

### createClientCompanyProject

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/mutation.doc.html

Creates a new ClientCompanyProject. Requires an input object containing the necessary details for the project.

```APIDOC
## createClientCompanyProject

### Description
Creates a new `ClientCompanyProject`.

### Method
MUTATION

### Arguments
#### input
- **input** ([CreateClientCompanyProjectInput](createclientcompanyprojectinput.doc.html)) - Required - The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.

### Response
#### Success Response
- **createClientCompanyProject** ([CreateClientCompanyProjectPayload](createclientcompanyprojectpayload.doc.html)) - The payload returned after a successful creation.
```

--------------------------------

### GET document's custom fields

Source: https://github.com/idwell/finance-api/blob/master/README.md

Returns custom document fields parsed from the document's fulltext.

```APIDOC
## GET /api/public/document/{doc_id}/custom-fields/

### Description
Returns custom document fields parsed from the document's fulltext.

### Method
GET

### Endpoint
https://idwell.ai/api/public/document/{doc_id}/custom-fields/

### Parameters
#### Path Parameters
- **doc_id** (string) - Required - The ID of the document.

### Request Example
```bash
#!/bin/bash

TOKEN="your API key"
doc_id="document ID"

curl https://idwell.ai/api/public/document/${doc_id}/custom-fields/ \
    -H "Authorization: Bearer ${TOKEN}"
```

### Response
#### Success Response (200)
- **name** (string) - The name of the custom field.
- **value** (string) - The value of the custom field.

#### Response Example
```json
[
  {
    "name":"field1",
    "value":"KundenNr. 14392"
  }
]
```
```

--------------------------------

### Upload a Document using Finance API

Source: https://github.com/idwell/finance-api/blob/master/README.md

Demonstrates how to upload a document and its associated invoice file to the Finance API. Ensure you have the API key, category ID, and file paths correctly set.

```go
import (
    "context"
    "github.com/iDWELL/finance-api/golang/finance"
    "github.com/domonda/go-types/uu"
    "github.com/ungerik/go-fs"
)

func uploadDocument() error {
    ctx := context.Background()
    apiKey := "YOUR_API_KEY"
    categoryID := uu.IDFromString("YOUR_CATEGORY_ID")

    documentFile := fs.File("invoice.pdf")
    invoiceFile := fs.File("invoice.json")

    documentID, err := finance.UploadDocument(
        ctx,
        apiKey,
        categoryID,
        documentFile,
        invoiceFile,
        "tag1", "tag2",
    )
    if err != nil {
        return err
    }

    // Use documentID for further operations
    println("Uploaded document:", documentID)
    return nil
}
```

--------------------------------

### GraphQL Query for Document Categories

Source: https://github.com/idwell/finance-api/blob/master/README.md

An example GraphQL query to retrieve all document categories, including their types and associated booking information.

```graphql
{
  allDocumentCategories {
    nodes {
      rowId
      documentType
      bookingType
      bookingCategory
      description
      emailAlias
    }
  }
}
```

--------------------------------

### JSON for Uploading Company Master Data

Source: https://github.com/idwell/finance-api/blob/master/README.md

Example JSON structure for updating client-company master data via the REST API. This follows an 'upsert' logic.

```json
{
  "number": "1/200",
  "name": "Account for object 66",
  "category": null,
  "objectNo": "66"
}
```

--------------------------------

### allClientCompanyProjects

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `ClientCompanyProject`. Supports filtering, sorting, and cursor-based pagination.

```APIDOC
## allClientCompanyProjects

### Description
Reads and enables pagination through a set of `ClientCompanyProject`. Supports filtering, sorting, and cursor-based pagination.

### Arguments
* **first** ([Int]): Only read the first `n` values of the set.
* **last** ([Int]): Only read the last `n` values of the set.
* **offset** ([Int]): Skip the first `n` values from our `after` cursor, an alternative to cursor-based pagination. May not be used with `last`.
* **before** ([Cursor]): Read all values in the set before (above) this cursor.
* **after** ([Cursor]): Read all values in the set after (below) this cursor.
* **orderBy** ([[ClientCompanyProjectsOrderBy]!]): The method to use when ordering `ClientCompanyProject`.
* **condition** ([ClientCompanyProjectCondition]): A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompanyProjectsConnection]
```

--------------------------------

### Query All Delivery Notes

Source: https://github.com/idwell/finance-api/blob/master/README.md

Retrieves a list of all delivery notes, including references to associated invoices and partner information. Use this to get an overview of all delivery notes.

```graphql
{ allDeliveryNotes {
  nodes {
    documentRowId
    partnerCompanyRowId
    invoiceDocumentRowId
    invoiceNumber
    deliveryNoteNumber
    deliveryDate
    createdAt
  }
}
}
```

--------------------------------

### allClientCompanyCostUnits

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `ClientCompanyCostUnit`. Supports filtering, sorting, and cursor-based pagination.

```APIDOC
## allClientCompanyCostUnits

### Description
Reads and enables pagination through a set of `ClientCompanyCostUnit`. Supports filtering, sorting, and cursor-based pagination.

### Arguments
* **first** ([Int]): Only read the first `n` values of the set.
* **last** ([Int]): Only read the last `n` values of the set.
* **offset** ([Int]): Skip the first `n` values from our `after` cursor, an alternative to cursor-based pagination. May not be used with `last`.
* **before** ([Cursor]): Read all values in the set before (above) this cursor.
* **after** ([Cursor]): Read all values in the set after (below) this cursor.
* **orderBy** ([[ClientCompanyCostUnitsOrderBy]!]): The method to use when ordering `ClientCompanyCostUnit`.
* **condition** ([ClientCompanyCostUnitCondition]): A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompanyCostUnitsConnection]
```

--------------------------------

### JSON Response for Document Custom Fields

Source: https://github.com/idwell/finance-api/blob/master/README.md

Example JSON response structure for custom fields retrieved from a document. Each object contains a 'name' and 'value' for a custom field.

```json
[
  {
    "name":"field1",
    "value":"KundenNr. 14392"
  }
]
```

--------------------------------

### Query All Invoices

Source: https://github.com/idwell/finance-api/blob/master/README.md

Retrieves a list of all invoices, including details like partner name, invoice numbers, dates, and financial amounts. Use this to get a comprehensive list of all invoices.

```graphql
{ allInvoices {
  nodes {
    documentRowId
    partnerName
    invoiceNumber
    invoiceDate
    dueDate
    orderNumber
    orderDate
    creditMemo
    net
    total
    vatPercent
    vatPercentages
    discountPercent
    discountUntil
    currency
    conversionRate
    conversionRateDate
    conversionRateSource
    goodsServices
    deliveredFrom
    deliveredUntil
    iban
    bic
  }
}
}
```

--------------------------------

### createClientCompanyTag

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/mutation.doc.html

Creates a new ClientCompanyTag. Requires an input object containing the necessary details for the tag.

```APIDOC
## createClientCompanyTag

### Description
Creates a new `ClientCompanyTag`.

### Method
MUTATION

### Arguments
#### input
- **input** ([CreateClientCompanyTagInput](createclientcompanytaginput.doc.html)) - Required - The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.

### Response
#### Success Response
- **createClientCompanyTag** ([CreateClientCompanyTagPayload](createclientcompanytagpayload.doc.html)) - The payload returned after a successful creation.
```

--------------------------------

### createClientCompanyPurchase

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/mutation.doc.html

Creates a new ClientCompanyPurchase. Requires an input object containing the necessary details for the purchase.

```APIDOC
## createClientCompanyPurchase

### Description
Creates a new `ClientCompanyPurchase`.

### Method
MUTATION

### Arguments
#### input
- **input** ([CreateClientCompanyPurchaseInput](createclientcompanypurchaseinput.doc.html)) - Required - The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.

### Response
#### Success Response
- **createClientCompanyPurchase** ([CreateClientCompanyPurchasePayload](createclientcompanypurchasepayload.doc.html)) - The payload returned after a successful creation.
```

--------------------------------

### Download Document PDF using cURL

Source: https://github.com/idwell/finance-api/blob/master/README.md

This command downloads a specific document's PDF file using a GET request. Ensure you replace the placeholder UUID with the actual document ID and provide your API key.

```sh
curl \
  -H "Authorization: Bearer ${IDWELL_API_KEY}" \
  --fail \
  --remote-name \
  https://idwell.ai/api/public/document/00000000-0000-0000-0000-000000000000.pdf
```

--------------------------------

### CreateClientCompanyProjectInput

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/createclientcompanyprojectinput.doc.html

This input object defines the parameters required for the `createClientCompanyProject` mutation.

```APIDOC
## CreateClientCompanyProjectInput

### Description

All input for the `createClientCompanyProject` mutation.

### GraphQL Schema definition

```graphql
input CreateClientCompanyProjectInput {
  # An arbitrary string value with no semantic meaning. Will be included in the
  # payload verbatim. May be used to track mutations by the client.
  clientMutationId: String
  clientCompanyRowId: UUID!
  name: NonEmptyText!
}
```

### Fields

*   **clientMutationId** (String) - Optional - An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
*   **clientCompanyRowId** (UUID!) - Required - The unique identifier for the client company.
*   **name** (NonEmptyText!) - Required - The name of the project.
```

--------------------------------

### allClientCompanies

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `ClientCompany`. Supports filtering, sorting, and cursor-based pagination.

```APIDOC
## allClientCompanies

### Description
Reads and enables pagination through a set of `ClientCompany`. Supports filtering, sorting, and cursor-based pagination.

### Arguments
* **first** ([Int]): Only read the first `n` values of the set.
* **last** ([Int]): Only read the last `n` values of the set.
* **offset** ([Int]): Skip the first `n` values from our `after` cursor, an alternative to cursor-based pagination. May not be used with `last`.
* **before** ([Cursor]): Read all values in the set before (above) this cursor.
* **after** ([Cursor]): Read all values in the set after (below) this cursor.
* **orderBy** ([[ClientCompaniesOrderBy]!]): The method to use when ordering `ClientCompany`.
* **condition** ([ClientCompanyCondition]): A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompaniesConnection]
```

--------------------------------

### CreateClientCompanyTagInput

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/createclientcompanytaginput.doc.html

This input object defines the parameters required for the `createClientCompanyTag` mutation. It includes an optional `clientMutationId` for tracking and a mandatory `name` for the tag.

```APIDOC
## CreateClientCompanyTagInput

### Description

This input object defines the parameters required for the `createClientCompanyTag` mutation. It includes an optional `clientMutationId` for tracking and a mandatory `name` for the tag.

### GraphQL Schema Definition

```graphql
input CreateClientCompanyTagInput {
  # An arbitrary string value with no semantic meaning. Will be included in the
  # payload verbatim. May be used to track mutations by the client.
  clientMutationId: String
  name: String!
}
```

### Fields

#### `clientMutationId`

- **Type**: String
- **Required**: Optional
- **Description**: An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.

#### `name`

- **Type**: String
- **Required**: Required
- **Description**: The name of the tag to be created.
```

--------------------------------

### allClientCompanyCostCenters

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `ClientCompanyCostCenter`. Supports filtering, sorting, and cursor-based pagination.

```APIDOC
## allClientCompanyCostCenters

### Description
Reads and enables pagination through a set of `ClientCompanyCostCenter`. Supports filtering, sorting, and cursor-based pagination.

### Arguments
* **first** ([Int]): Only read the first `n` values of the set.
* **last** ([Int]): Only read the last `n` values of the set.
* **offset** ([Int]): Skip the first `n` values from our `after` cursor, an alternative to cursor-based pagination. May not be used with `last`.
* **before** ([Cursor]): Read all values in the set before (above) this cursor.
* **after** ([Cursor]): Read all values in the set after (below) this cursor.
* **orderBy** ([[ClientCompanyCostCentersOrderBy]!]): The method to use when ordering `ClientCompanyCostCenter`.
* **condition** ([ClientCompanyCostCenterCondition]): A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompanyCostCentersConnection]
```

--------------------------------

### allAccountingInstructions

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of AccountingInstruction entities. Supports filtering, ordering, and cursor-based pagination.

```APIDOC
## allAccountingInstructions

### Description
Reads and enables pagination through a set of `AccountingInstruction`.

### Arguments
*   **first** (Int) - Optional - Only read the first `n` values of the set.
*   **last** (Int) - Optional - Only read the last `n` values of the set.
*   **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
*   **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
*   **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
*   **orderBy** ([[AccountingInstructionsOrderBy]!]) - Optional - The method to use when ordering `AccountingInstruction`.
*   **condition** (AccountingInstructionCondition) - Optional - A condition to be used in determining which values should be returned by the collection.

### Returns
[AccountingInstructionsConnection](accountinginstructionsconnection.doc.html)
```

--------------------------------

### allObjectInstances

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `ObjectInstance`. Supports filtering and ordering.

```APIDOC
## allObjectInstances

### Description
Reads and enables pagination through a set of `ObjectInstance`. Supports filtering and ordering.

### Method
QUERY

### Endpoint
/graphql

### Arguments
* **first** (Int) - Optional - Only read the first `n` values of the set.
* **last** (Int) - Optional - Only read the last `n` values of the set.
* **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
* **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
* **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
* **orderBy** ([ObjectInstancesOrderBy]!) - Optional - The method to use when ordering `ObjectInstance`.
* **condition** (ObjectInstanceCondition) - Optional - A condition to be used in determining which values should be returned by the collection.

### Response
* **ObjectInstancesConnection** - Connection object for ObjectInstances.
```

--------------------------------

### allClientCompanyTags

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of ClientCompanyTag. Supports filtering and ordering.

```APIDOC
## allClientCompanyTags

### Description
Reads and enables pagination through a set of `ClientCompanyTag`.

### Arguments
*   **first** (Int) - Optional - Only read the first `n` values of the set.
*   **last** (Int) - Optional - Only read the last `n` values of the set.
*   **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
*   **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
*   **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
*   **orderBy** ([[ClientCompanyTagsOrderBy]!]) - Optional - The method to use when ordering `ClientCompanyTag`.
*   **condition** ([ClientCompanyTagCondition]) - Optional - A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompanyTagsConnection]
```

--------------------------------

### allClientCompanyPurchases

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of ClientCompanyPurchase. Supports filtering and ordering.

```APIDOC
## allClientCompanyPurchases

### Description
Reads and enables pagination through a set of `ClientCompanyPurchase`.

### Arguments
*   **first** (Int) - Optional - Only read the first `n` values of the set.
*   **last** (Int) - Optional - Only read the last `n` values of the set.
*   **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
*   **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
*   **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
*   **orderBy** ([[ClientCompanyPurchasesOrderBy]!]) - Optional - The method to use when ordering `ClientCompanyPurchase`.
*   **condition** ([ClientCompanyPurchaseCondition]) - Optional - A condition to be used in determining which values should be returned by the collection.

### Returns
[ClientCompanyPurchasesConnection]
```

--------------------------------

### allPartnerCompanies

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `PartnerCompany`. Supports filtering and ordering.

```APIDOC
## allPartnerCompanies

### Description
Reads and enables pagination through a set of `PartnerCompany`. Supports filtering and ordering.

### Method
QUERY

### Endpoint
/graphql

### Arguments
* **first** (Int) - Optional - Only read the first `n` values of the set.
* **last** (Int) - Optional - Only read the last `n` values of the set.
* **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
* **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
* **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
* **orderBy** ([PartnerCompaniesOrderBy]!) - Optional - The method to use when ordering `PartnerCompany`.
* **condition** (PartnerCompanyCondition) - Optional - A condition to be used in determining which values should be returned by the collection.

### Response
* **PartnerCompaniesConnection** - Connection object for PartnerCompanies.
```

--------------------------------

### allPartnerCompanies

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of PartnerCompanies. Supports filtering, ordering, and cursor-based pagination.

```APIDOC
## allPartnerCompanies

### Description
Reads and enables pagination through a set of `PartnerCompanies`. Supports filtering, ordering, and cursor-based pagination.

### Method
Query

### Endpoint
allPartnerCompanies

### Parameters
#### Query Parameters
- **first** (Int) - Optional - Only read the first `n` values of the set.
- **last** (Int) - Optional - Only read the last `n` values of the set.
- **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
- **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
- **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
- **orderBy** (Array of PartnerCompaniesOrderBy) - Optional - The method to use when ordering `PartnerCompanies`.
- **condition** (PartnerCompanyCondition) - Optional - A condition to be used in determining which values should be returned by the collection.

### Response
#### Success Response (200)
- **PartnerCompaniesConnection** - The connection object for PartnerCompanies.
```

--------------------------------

### allRealEstateObjects

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of `RealEstateObject`. Supports filtering, ordering, and cursor-based pagination.

```APIDOC
## allRealEstateObjects

### Description
Reads and enables pagination through a set of `RealEstateObject`. Supports filtering, ordering, and cursor-based pagination.

### Method
Query

### Endpoint
allRealEstateObjects

### Parameters
#### Query Parameters
- **first** (Int) - Optional - Only read the first `n` values of the set.
- **last** (Int) - Optional - Only read the last `n` values of the set.
- **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
- **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
- **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
- **orderBy** (Array of RealEstateObjectsOrderBy) - Optional - The method to use when ordering `RealEstateObject`.
- **condition** (RealEstateObjectCondition) - Optional - A condition to be used in determining which values should be returned by the collection.

### Response
#### Success Response (200)
- **RealEstateObjectsConnection** - The connection object for RealEstateObjects.
```

--------------------------------

### CreateClientCompanyPurchaseInput

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/createclientcompanypurchaseinput.doc.html

This input object is used for the `createClientCompanyPurchase` mutation. It allows clients to specify a mutation ID for tracking and the name of the purchase.

```APIDOC
## CreateClientCompanyPurchaseInput

### Description

This input object is used for the `createClientCompanyPurchase` mutation. It allows clients to specify a mutation ID for tracking and the name of the purchase.

### GraphQL Schema Definition

```graphql
input CreateClientCompanyPurchaseInput {
  # An arbitrary string value with no semantic meaning. Will be included in the
  # payload verbatim. May be used to track mutations by the client.
  clientMutationId: String
  # The name of the purchase.
  name: NonEmptyText!
}
```

### Fields

#### clientMutationId

- **Type**: String
- **Description**: An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.
- **Required**: Optional

#### name

- **Type**: NonEmptyText
- **Description**: The name of the purchase.
- **Required**: Required
```

--------------------------------

### accountingInstruction

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Retrieves a single accounting instruction by its ID.

```APIDOC
## accountingInstruction

### Description
Retrieves a single `AccountingInstruction` using its globally unique `ID`.

### Arguments
- **id** (ID) - The globally unique `ID` of the accounting instruction.

### Returns
[AccountingInstruction]
```

--------------------------------

### allCompanyLocations

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/query.doc.html

Reads and enables pagination through a set of CompanyLocation. Supports filtering and ordering.

```APIDOC
## allCompanyLocations

### Description
Reads and enables pagination through a set of `CompanyLocation`.

### Arguments
*   **first** (Int) - Optional - Only read the first `n` values of the set.
*   **last** (Int) - Optional - Only read the last `n` values of the set.
*   **offset** (Int) - Optional - Skip the first `n` values from our `after` cursor, an alternative to cursor based pagination. May not be used with `last`.
*   **before** (Cursor) - Optional - Read all values in the set before (above) this cursor.
*   **after** (Cursor) - Optional - Read all values in the set after (below) this cursor.
*   **orderBy** ([[CompanyLocationsOrderBy]!]) - Optional - The method to use when ordering `CompanyLocation`.
*   **condition** ([CompanyLocationCondition]) - Optional - A condition to be used in determining which values should be returned by the collection.

### Returns
[CompanyLocationsConnection]
```

--------------------------------

### GraphQL Schema Definition

Source: https://github.com/idwell/finance-api/blob/master/doc/schema/createclientcompanyprojectpayload.doc.html

This snippet shows the GraphQL schema definition for the CreateClientCompanyProjectPayload type. It outlines the fields available in the mutation output and their types.

```graphql
type CreateClientCompanyProjectPayload {
  clientMutationId: String
  clientCompanyProject: ClientCompanyProject
  query: Query
  clientCompanyByClientCompanyRowId: ClientCompany!
  clientCompanyProjectEdge(
    orderBy: [ClientCompanyProjectsOrderBy]!
  ): ClientCompanyProjectsEdge
}
```