Quickbooks Ruby

https://www.rubydoc.info/gems/quickbooks-ruby
Admin
Quickbooks Ruby is a Ruby library that provides comprehensive API bindings for integrating with...
Tokens:119,278
Snippets:964
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Model Initialization with Line Items

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/HasLineItems%3Ainitialize

Demonstrates the initialization of a model that includes line items, ensuring proper setup.

```APIDOC
## initialize /websites/rubydoc_info_gems_quickbooks-ruby

### Description
Initializes a model, ensuring that line items are properly set up before calling the superclass initializer.

### Method
`initialize`

### Parameters
- `*args`: Variable number of arguments passed to the initializer.

### Request Example
```ruby
# Example usage within a class inheriting from a base model
class MyModel
  include Quickbooks::Model::HasLineItems

  def initialize(*args)
    ensure_line_items_initialization
    super
  end
end

model = MyModel.new
```

### Response
This method does not return a value directly but initializes the object's state.
```

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

### Deposit Line Detail Setup

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/DepositLineItem%3Adeposit_line_detail%21

This snippet demonstrates how to initialize and configure a deposit line detail using the `deposit_line_detail!` method. It allows for setting the detail type and optionally configuring the `DepositLineDetail` object via a block.

```APIDOC
## deposit_line_detail!

### Description
Initializes and configures the deposit line detail for a deposit.

### Method
`deposit_line_detail!`

### Parameters
This method accepts an optional block for configuring the `DepositLineDetail` object.

### Request Example
```ruby
line_item.deposit_line_detail! do |detail|
  detail.account_id = '123'
  detail.amount = 100.00
  detail.entity_ref = { type: 'Customer', type_id: '456' }
end
```

### Response
This method does not return a value directly but modifies the current object by setting the `detail_type` and initializing `deposit_line_detail`.
```

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

### GET /query

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ServiceCrud%3Aquery

Executes a query against the Quickbooks API using the ServiceCrud service.

```APIDOC
## GET /query

### Description
Executes a query against the Quickbooks API to retrieve specific objects based on the provided query string.

### Method
GET

### Parameters
#### Query Parameters
- **object_query** (String) - Optional - The query string to filter results.
- **options** (Hash) - Optional - Additional configuration options for the query execution.

### Response
#### Success Response (200)
- **Object** - Returns the result set matching the query.
```

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

### GET /company_info/offering_sku

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Aoffering_sku

Retrieves the offering SKU for the company information model.

```APIDOC
## GET /company_info/offering_sku

### Description
Retrieves the offering SKU associated with the CompanyInfo model.

### Method
GET

### Endpoint
/company_info/offering_sku

### Response
#### Success Response (200)
- **offering_sku** (Object) - The SKU object for the company offering.
```

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

### GET /query

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ServiceCrud%3Aquery

Retrieves a collection of QuickBooks objects based on the provided query and options.

```APIDOC
## GET /query

### Description
Fetches a collection of QuickBooks objects using an optional query string and configuration options.

### Method
GET

### Endpoint
/query

### Parameters
#### Query Parameters
- **object_query** (string) - Optional - The query string to filter the collection.
- **options** (hash) - Optional - Additional configuration options for the fetch operation.

### Response
#### Success Response (200)
- **collection** (array) - The list of objects returned by the service.
```

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

### GET /all

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ServiceCrud%3Aall

Retrieves all entries for a specific object type by executing queries in batches.

```APIDOC
## GET /all

### Description
Retrieves a collection of objects by performing batch queries. It flattens the results from multiple batches into a single array.

### Method
GET

### Parameters
#### Query Parameters
- **object_query** (string) - Optional - The query string used to filter the objects.
- **options** (hash) - Optional - Configuration options for the batch query process.

### Response
#### Success Response (200)
- **collection** (array) - A flattened list of all entries retrieved from the service.
```

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

### Get Start Position Attribute

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection

Returns the value of the 'start_position' attribute. This is an attribute for v3.

```ruby
def start_position
  @start_position
end
```

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

### Initialize QuickBooks BaseService

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/BaseService%3Ainitialize

Configures the base URI based on the sandbox mode and assigns provided attributes to the instance.

```ruby
def initialize(attributes = {})
  domain = Quickbooks.sandbox_mode ? SANDBOX_DOMAIN : BASE_DOMAIN
  @base_uri = "https://#{domain}/v3/company"
  attributes.each {|key, value| public_send("#{key}=", value) }
end
```

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

### GET #body

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Responses/Methods

Retrieves the body of the service response.

```APIDOC
## GET #body

### Description
Retrieves the body content of the service response. Note that this method currently requires implementation.

### Method
GET

### Endpoint
#body

### Response
- **Object** - The body of the response.
```

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

### Quickbooks::Model::Line#initialize

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Line%3Ainitialize

Initializes a new instance of the Line class.

```APIDOC
## Quickbooks::Model::Line#initialize

### Description
Initializes a new instance of the Line class.

### Method
initialize

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### GET /quickbooks/service/base_service/oauth

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/BaseService%3Aoauth

Retrieves the OAuth attribute from the BaseService.

```APIDOC
## GET /quickbooks/service/base_service/oauth

### Description
Returns the value of the oauth attribute associated with the BaseService.

### Method
GET

### Endpoint
/quickbooks/service/base_service/oauth

### Response
#### Success Response (200)
- **oauth** (Object) - The OAuth configuration or token object.
```

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

### Initialize BaseService

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/BaseService

Initializes a new instance of the BaseService, setting up the base URI based on the sandbox or production environment.

```APIDOC
## POST /initialize

### Description
Creates a new instance of the BaseService class. It configures the base URI for API requests based on whether the SDK is in sandbox mode.

### Method
POST

### Parameters
#### Request Body
- **attributes** (Hash) - Optional - A hash of attributes to set on the service instance, such as company_id or oauth credentials.
```

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

### GET #code

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Responses/Methods

Retrieves the status code of the service response.

```APIDOC
## GET #code

### Description
Retrieves the status code associated with the service response. Note that this method currently requires implementation.

### Method
GET

### Endpoint
#code

### Response
- **Object** - The status code of the response.
```

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

### GET /refund_receipt/pdf

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/RefundReceipt

Retrieves the PDF representation of a refund receipt.

```APIDOC
## GET /refund_receipt/pdf

### Description
Fetches the PDF content for a specific refund receipt by its ID.

### Method
GET

### Parameters
#### Request Body
- **refund_receipt** (Object) - Required - The refund receipt object containing the ID.
```

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

### Quickbooks::Model::AttachableRef#initialize

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/AttachableRef%3Ainitialize

Initializes a new instance of the AttachableRef model.

```APIDOC
## AttachableRef#initialize

### Description
Initializes a new instance of the AttachableRef model.

### Method
initialize

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Quickbooks::Model::EmailAddress#initialize

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/EmailAddress%3Ainitialize

Initializes a new instance of the EmailAddress model.

```APIDOC
## initialize

### Description
Returns a new instance of EmailAddress.

### Parameters
- **email_address** (String) - Optional - The email address string to initialize the model with.

### Response
- **EmailAddress** (Object) - A new instance of the EmailAddress model.
```

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

### GET #url_for_query

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ChangeDataCapture

Constructs the URL for the CDC query endpoint.

```APIDOC
## GET #url_for_query

### Description
Generates the full URL string for querying the CDC endpoint with a specific list of entities and optional query parameters.

### Method
GET

### Parameters
#### Path Parameters
- **entity_list** (Array) - Required - List of entities to include in the query.
- **query** (String) - Optional - Additional query string parameters to append to the URL.
```

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

### Quickbooks::Model::BaseModel#initialize

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/BaseModel%3Ainitialize

Initializes a new instance of a BaseModel with optional attributes.

```APIDOC
## BaseModel#initialize

### Description
Returns a new instance of BaseModel.

### Method
initialize

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
# No specific request body example for initializer
```

### Response
#### Success Response (200)
- **BaseModel** (object) - A new instance of BaseModel.

#### Response Example
```json
{
  "example": "new BaseModel instance"
}
```
```

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

### GET /reports/all_rows

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Report%3Aall_rows

Retrieves all rows from a generated Quickbooks report.

```APIDOC
## GET /reports/all_rows

### Description
Retrieves all rows from a generated Quickbooks report object.

### Method
GET

### Endpoint
/reports/all_rows

### Response
#### Success Response (200)
- **rows** (Object) - The collection of rows contained within the report.
```

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

### Get Offering SKU - Quickbooks Ruby

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Aoffering_sku

Retrieves the OfferingSku for the company. This method is part of the CompanyInfo model.

```ruby
def offering_sku
  find_name_value("OfferingSku")
end
```

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

### GET /quickbooks/model/report/xml

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Report%3Axml

Retrieves the XML representation of a report model.

```APIDOC
## GET /quickbooks/model/report/xml

### Description
Returns the XML attribute value associated with a report model instance.

### Method
GET

### Endpoint
/quickbooks/model/report/xml

### Response
#### Success Response (200)
- **xml** (Object) - The XML data associated with the report.
```

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

### GET #attributes

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/BaseModel%3Aattributes

Retrieves the attributes of a Quickbooks model instance.

```APIDOC
## GET #attributes

### Description
Retrieves the attributes defined for a specific Quickbooks model instance.

### Method
GET

### Endpoint
Quickbooks::Model::BaseModel#attributes

### Response
#### Success Response (200)
- **attributes** (Object) - The collection of attributes associated with the model.
```

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

### Service Configuration and Initialization

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/CreditMemoChange

Configuration attributes and initialization methods for Quickbooks services.

```APIDOC
## Configuration Attributes

### Attributes
- **company_id**: The ID of the company being accessed.
- **oauth**: OAuth configuration object.
- **base_uri**: The base URI for API requests.
- **realm_id**: The realm ID for the connection.

### Initialization
- **initialize**: Inherited from BaseService to set up the service instance.
```

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

### GET /sandbox_mode

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks.sandbox_mode

Retrieves the current sandbox mode status for the Quickbooks Ruby SDK configuration.

```APIDOC
## GET /sandbox_mode

### Description
Returns the current state of the sandbox mode configuration.

### Method
GET

### Endpoint
Quickbooks.sandbox_mode

### Response
#### Success Response (200)
- **sandbox_mode** (Object) - The current sandbox mode status.
```

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

### GET /payment_method/fetch_by_name

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/PaymentMethod

Retrieves a single payment method entity by its name.

```APIDOC
## GET /payment_method/fetch_by_name

### Description
Queries the PaymentMethod resource to find an entry matching the provided name.

### Method
GET

### Parameters
#### Query Parameters
- **name** (String) - Required - The name of the payment method to search for.
```

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

### Item Initialization

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Item

Details on how to initialize a new Item object.

```APIDOC
## Constructor Details

### permalink #**initialize**(*args) ⇒ `Item`

Returns a new instance of Item.

[View source]
```ruby
def initialize(*args)
  self.type = INVENTORY_TYPE
  super
end
```
```

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

### GET /item/:id

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Item

Fetches a specific item by its unique identifier.

```APIDOC
## GET /item/:id

### Description
Fetches a specific item by its unique identifier.

### Method
GET

### Endpoint
/item/:id

### Parameters
#### Path Parameters
- **id** (String/Integer) - Required - The unique identifier of the item.

#### Query Parameters
- **params** (Hash) - Optional - Additional query parameters for the request.
```

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

### Initialize Quickbooks Item Model

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Item%3Ainitialize

This endpoint or method documentation describes how to create a new instance of the Item model within the Quickbooks Ruby gem.

```APIDOC
## Initialize Item Model

### Description
Creates a new instance of the Quickbooks Item model.

### Method
initialize

### Parameters
- **args** (Array) - Optional - Arguments to initialize the Item model instance.

### Response
- **Item** (Object) - Returns a new instance of the Item model.
```

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

### Instance Method Summary

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection

Summary of instance methods for collections.

```APIDOC
## Instance Method Summary
  * #**each**(*args, &block) ⇒ Object
```

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

### GET /estimate/{id}/pdf

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Estimate

Retrieves the PDF representation of an estimate.

```APIDOC
## GET /estimate/{id}/pdf

### Description
Fetches the PDF content for a specific estimate by its ID.

### Method
GET

### Parameters
#### Path Parameters
- **estimate** (Object) - Required - The estimate object containing the ID.

### Response
#### Success Response (200)
- **body** (String) - The raw PDF binary data.
```

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

### GET /quickbooks/service/estimate/pdf

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Estimate%3Apdf

Generates a PDF representation of a specific estimate object.

```APIDOC
## GET /quickbooks/service/estimate/pdf

### Description
Generates a PDF document for a given estimate object using the Quickbooks service.

### Method
GET

### Endpoint
Quickbooks::Service::Estimate#pdf

### Parameters
#### Request Body
- **estimate** (Object) - Required - The estimate object to be converted to PDF.

### Response
#### Success Response (200)
- **Object** - The generated PDF content.
```

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

### Constructor Details

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/ExchangeRate

Information about the constructor for classes within the Quickbooks-Ruby gem.

```APIDOC
## Constructor Details

This class inherits a constructor from Quickbooks::Model::BaseModel
```

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

### Get Subscription Status

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Asubscription_status

Retrieves the subscription status of the QuickBooks company.

```APIDOC
## GET /company_info/subscription_status

### Description
Retrieves the subscription status of the QuickBooks company.

### Method
GET

### Endpoint
/company_info/subscription_status

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **subscription_status** (string) - The current subscription status (e.g., "Active", "Trialing").

#### Response Example
{
  "subscription_status": "Active"
}
```

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

### POST /quickbooks/service/responses/oauth2_http_response/initialize

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Responses/OAuth2HttpResponse%3Ainitialize

Initializes a new OAuth2HttpResponse object using a Faraday response object.

```APIDOC
## POST /quickbooks/service/responses/oauth2_http_response/initialize

### Description
Initializes a new instance of the OAuth2HttpResponse class, which handles OAuth2 responses from the Quickbooks API.

### Method
POST

### Parameters
#### Request Body
- **response** (Faraday response) - Required - The Faraday response object received from the API request.

### Response
#### Success Response (200)
- **OAuth2HttpResponse** (Object) - Returns an initialized instance of OAuth2HttpResponse.
```

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

### Constructor Details

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/RefundReceiptChange

Information about the class constructor.

```APIDOC
## Constructor Details

This class inherits a constructor from `Quickbooks::Model::BaseModel`.
```

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

### Quickbooks::Model::TaxService Initialization

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/TaxService%3Ainitialize

Details on how to initialize the TaxService model.

```APIDOC
## Quickbooks::Model::TaxService#initialize

### Description
Returns a new instance of TaxService.

### Method
initialize

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **options** (Hash) - Optional - Options hash for initialization.

### Request Example
```json
{
  "example": "options = {}"
}
```

### Response
#### Success Response (200)
- **TaxService** (Object) - A new instance of TaxService.

#### Response Example
```json
{
  "example": "#<Quickbooks::Model::TaxService:0x00007f8b1c8b4a00>"
}
```
```

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

### Get Company Type

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Acompany_type

Retrieves the company type from the QuickBooks API.

```APIDOC
## GET /company_info

### Description
Retrieves the company type associated with the QuickBooks account.

### Method
GET

### Endpoint
/company_info

### Parameters
This endpoint does not have any path or query parameters.

### Request Body
This endpoint does not accept a request body.

### Request Example
This endpoint does not have a request example.

### Response
#### Success Response (200)
- **company_type** (string) - The type of the company (e.g., "Client", "SoleProprietor").

#### Response Example
```json
{
  "company_type": "Client"
}
```
```

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

### GET /company_info/company_type

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Acompany_type

Retrieves the company type information from the CompanyInfo model.

```APIDOC
## GET /company_info/company_type

### Description
Retrieves the company type attribute from the CompanyInfo model.

### Method
GET

### Endpoint
/company_info/company_type

### Response
#### Success Response (200)
- **company_type** (Object) - The type of the company as defined in the Quickbooks model.
```

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

### Deposit Line Item Instance Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/DepositLineItem

Provides documentation for the instance methods `deposit_line_detail!` and `deposit_line_detail?` of the Deposit Line Item class.

```APIDOC
## Instance Method: deposit_line_detail!

### Description
Sets the detail type to DEPOSIT_LINE_DETAIL and initializes a new DepositLineDetail object. It also yields the new DepositLineDetail object for further configuration if a block is provided.

### Method
`deposit_line_detail!`

### Parameters
None

### Request Example
```ruby
line_item.deposit_line_detail! do |detail|
  detail.amount = 100.00
  detail.account_id = '123'
end
```

### Response
#### Success Response (Object)
Returns the modified Deposit Line Item object.

### Instance Method: deposit_line_detail?

### Description
Checks if the current line item's detail type is DEPOSIT_LINE_DETAIL.

### Method
`deposit_line_detail?`

### Parameters
None

### Response
#### Success Response (Boolean)
Returns `true` if the detail type is DEPOSIT_LINE_DETAIL, `false` otherwise.
```

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

### BaseService Configuration

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Budget

Configuration attributes and initialization methods for the Quickbooks service.

```APIDOC
## BaseService Configuration

### Attributes
- **company_id**: The ID of the Quickbooks company.
- **oauth**: The OAuth configuration object.
- **base_uri**: The base URI for API requests.

### Methods
- **initialize**: Initializes the service with necessary credentials.
- **access_token=**: Sets the OAuth access token.
- **realm_id=**: Sets the realm ID for the connection.
- **rebuild_connection!**: Forces a rebuild of the API connection.
```

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

### GET /company_info/accountant_feature

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Aaccountant_feature

Retrieves the accountant feature status from the CompanyInfo model.

```APIDOC
## GET /company_info/accountant_feature

### Description
Retrieves the accountant feature status associated with the company information.

### Method
GET

### Endpoint
/company_info/accountant_feature

### Response
#### Success Response (200)
- **result** (Object) - The accountant feature object.
```

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

### GET journal_line_entry_tax

Source: https://www.rubydoc.info/gems/quickbooks-ruby/NameEntity/Quality%3Ajournal_line_entry_tax

Retrieves the tax information for a journal line entry.

```APIDOC
## GET journal_line_entry_tax

### Description
Retrieves the tax details associated with a specific journal line entry.

### Method
GET

### Endpoint
NameEntity::Quality#journal_line_entry_tax
```

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

### Initialize BaseService

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/BaseService%3Ainitialize

Initializes a new instance of the BaseService class, which acts as the base for all Quickbooks service operations.

```APIDOC
## initialize

### Description
Returns a new instance of BaseService.

### Method
initialize(attributes = {})

### Parameters
#### Request Body
- **attributes** (Hash) - Optional - A hash of attributes to initialize the service with.
```

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

### Instance Method Details: each

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection

Details for the 'each' instance method.

```APIDOC
### permalink #**each**(*args, &block) ⇒ `Object`
[View source]
```

# File 'lib/quickbooks/util/collection.rb', line 14

def each(*args, &block)
  (entries || []).each *args, &block
end
```
```

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

### GET /reports/query

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Reports%3Aquery

Retrieves financial reports from Quickbooks using the Reports service.

```APIDOC
## GET /reports/query

### Description
Queries financial reports from the Quickbooks API. The method allows specifying the report type, date range, and additional options.

### Method
GET

### Parameters
#### Query Parameters
- **object_query** (String) - Optional - The type of report to retrieve (default: 'BalanceSheet')
- **date_macro** (String) - Optional - The date range macro (default: 'This Fiscal Year-to-date')
- **options** (Hash) - Optional - Additional query options

### Response
#### Success Response (200)
- **Object** - The report data returned by the Quickbooks API.
```

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

### Initialize Quickbooks Line Model

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Line%3Ainitialize

Creates a new instance of the Line model. This method is defined in lib/quickbooks/model/line.rb.

```ruby
30
31
32
33
```

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

### GET /refund_receipts/:id/pdf

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/RefundReceipt%3Apdf

Retrieves the PDF representation of a specific Refund Receipt.

```APIDOC
## GET /refund_receipts/:id/pdf

### Description
Generates or retrieves the PDF document for a given Refund Receipt object.

### Method
GET

### Endpoint
/refund_receipts/:id/pdf

### Parameters
#### Path Parameters
- **refund_receipt** (Object) - Required - The Refund Receipt object or ID to generate the PDF for.

### Response
#### Success Response (200)
- **Object** - The PDF file content or stream.
```

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

### Instance Attribute Details: start_position

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection

Details for the 'start_position' instance attribute.

```APIDOC
### permalink #**start_position** ⇒ `Object`
v3 Attributes
```

# File 'lib/quickbooks/util/collection.rb', line 12

def start_position
  @start_position
end
```
```

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

### Customer Instance Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Customer

Instance methods available for customer objects in the quickbooks-ruby gem.

```APIDOC
## Instance Methods

### #bill_with_parent?

- **Description**: Checks if the customer is set to bill with a parent.
- **Returns**: `Boolean`

### #job?

- **Description**: Checks if the customer is a job.
- **Returns**: `Boolean`

### #taxable?

- **Description**: Checks if the customer is taxable.
- **Returns**: `Boolean`
```

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

### GET /payment_methods/search

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/PaymentMethod%3Afetch_by_name

Retrieves a single payment method entity by searching for its name.

```APIDOC
## GET /payment_methods/search

### Description
Fetches a payment method record from QuickBooks based on the provided name.

### Method
GET

### Endpoint
/payment_methods/search

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the payment method to search for.

### Response
#### Success Response (200)
- **PaymentMethod** (object) - The first matching payment method entity found.
```

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

### GET /invoices/{id}/pdf

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Invoice%3Apdf

Retrieves the PDF representation of a specific invoice.

```APIDOC
## GET /invoices/{id}/pdf

### Description
Retrieves the PDF document for a given invoice ID.

### Method
GET

### Endpoint
/invoices/{id}/pdf

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the invoice to retrieve the PDF for.

### Request Example
```ruby
# Assuming 'qb' is an authenticated Quickbooks client and 'invoice' is an Invoice object
pdf_data = qb.pdf(invoice)
```

### Response
#### Success Response (200)
- **application/pdf** - The binary content of the invoice PDF.
```

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

### Quickbooks::Model::BaseModel Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/AccountBasedExpenseLineDetail

Overview of methods available to models inheriting from BaseModel, including serialization and initialization.

```APIDOC
## BaseModel Methods

### Description
Methods inherited from Quickbooks::Model::BaseModel for handling model attributes, JSON/XML serialization, and initialization.

### Methods
- **as_json**: Returns the model as a JSON hash.
- **attribute_names**: Returns a list of defined attribute names.
- **attributes**: Returns the hash of model attributes.
- **initialize**: Constructor for the model instance.
- **inspect**: Returns a string representation of the object.
- **to_xml_inject_ns**: Injects namespaces into XML output.
- **to_xml_ns**: Returns XML with namespace support.
```

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

### Constructor Details

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/InvoiceChange

Information about the constructor for the service class.

```APIDOC
## Constructor Details

This class inherits a constructor from Quickbooks::Service::BaseService
```

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

### GET /cdc (since)

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ChangeService

Queries for entities that have changed since a specific timestamp.

```APIDOC
## GET /cdc (since)

### Description
Queries for entities that have changed since the provided timestamp using the changedSince parameter.

### Method
GET

### Parameters
#### Request Body
- **timestamp** (DateTime) - Required - The ISO8601 formatted timestamp to query changes from.
```

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

### Initialize QueryBuilder

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Util/QueryBuilder

Creates a new instance of the QueryBuilder class.

```ruby
def initialize
end
```

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

### GET #since

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ChangeDataCapture

Retrieves a list of entities that have changed since a specific timestamp.

```APIDOC
## GET #since

### Description
Retrieves entities from the QuickBooks CDC endpoint that have been modified since the provided timestamp.

### Method
GET

### Parameters
#### Path Parameters
- **entity_list** (Array) - Required - A list of entity names to check for changes.
- **timestamp** (Time) - Required - The ISO8601 formatted timestamp to check changes from.

### Response
#### Success Response (200)
- **model** (Object) - Returns a new model instance populated with the XML response from the CDC service.
```

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

### GET /changedSince

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ChangeService%3Asince

Retrieves a list of entities that have been modified since a specific timestamp.

```APIDOC
## GET /changedSince

### Description
Retrieves entities that have been modified since the provided timestamp.

### Method
GET

### Endpoint
/changedSince

### Parameters
#### Query Parameters
- **changedSince** (string) - Required - The ISO8601 formatted timestamp to check for changes.

### Response
#### Success Response (200)
- **entities** (array) - A list of entities that have changed since the specified timestamp.
```

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

### NameEntity::Quality Module Instance Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/NameEntity/Quality

This section details the instance methods available within the NameEntity::Quality module, covering validation logic and data handling for various QuickBooks entities.

```APIDOC
## Instance Method: billable_status_is_valid

### Description
Validates the billable status, ensuring it is one of 'Billable', 'NotBillable', or 'HasBeenBilled'. Adds an error if the status is invalid.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
N/A (Modifies internal error state if validation fails)

#### Success Response (200)
N/A

#### Response Example
N/A
```

```APIDOC
## Instance Method: email_address

### Description
Retrieves the primary email address associated with the entity.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
Returns the primary email address.

#### Success Response (200)
- **primary_email_address** (Quickbooks::Model::EmailAddress) - The primary email address.

#### Response Example
```ruby
# Assuming an instance of a class that includes NameEntity::Quality
entity.email_address
```
```

```APIDOC
## Instance Method: email_address=

### Description
Sets the primary email address for the entity. It expects an email address string and creates a new Quickbooks::Model::EmailAddress object.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
* **email_address** (String) - The email address to set.

### Request Example
```ruby
# Assuming an instance of a class that includes NameEntity::Quality
entity.email_address = "test@example.com"
```

### Response
N/A (Sets an attribute on the instance)

#### Success Response (200)
N/A

#### Response Example
N/A
```

```APIDOC
## Instance Method: email_address_is_valid

### Description
Validates the format of the primary email address, checking for the presence of '@' and '.' characters. Adds an error if the format is invalid.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
Returns `false` if the email address is empty or invalid, otherwise performs validation and potentially adds errors.

#### Success Response (200)
N/A

#### Response Example
```ruby
# Assuming an instance of a class that includes NameEntity::Quality
if entity.primary_email_address
  entity.email_address_is_valid
end
```
```

```APIDOC
## Instance Method: entity_type_is_valid

### Description
Validates the entity type, ensuring it is either 'Customer' or 'Vendor'. Adds an error if the entity type is invalid.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
N/A (Modifies internal error state if validation fails)

#### Success Response (200)
N/A

#### Response Example
N/A
```

```APIDOC
## Instance Method: journal_line_entry_tax

### Description
Validates tax-related fields for journal line entries. Ensures that `tax_applicable_on` and `tax_amount` are set when `tax_code_ref` is present. Adds errors if these conditions are not met.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
N/A (Modifies internal error state if validation fails)

#### Success Response (200)
N/A

#### Response Example
N/A
```

```APIDOC
## Instance Method: names_cannot_contain_invalid_characters

### Description
Validates several name-related fields (name, display_name, given_name, middle_name, family_name, print_on_check_name) to ensure they do not contain a colon (:). Adds an error for each field that violates this rule.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
N/A (Modifies internal error state if validation fails)

#### Success Response (200)
N/A

#### Response Example
```ruby
# Assuming an instance of a class that includes NameEntity::Quality
entity.name = "My:Name"
entity.names_cannot_contain_invalid_characters
# This would add an error to the entity's errors collection.
```
```

```APIDOC
## Instance Method: posting_type_is_valid

### Description
Validates the posting type, ensuring it is either 'Debit' or 'Credit'. Adds an error if the posting type is invalid.

### Method
Instance Method

### Endpoint
N/A (Instance method within a Ruby module)

### Parameters
None

### Request Example
N/A

### Response
N/A (Modifies internal error state if validation fails)

#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Method Summary

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Bill

Details the methods available in the quickbooks-ruby gem.

```APIDOC
### Methods included from HasLineItems
#ensure_line_items_initialization, #initialize
```

```APIDOC
### Methods inherited from BaseModel
#as_json, attribute_names, #attributes, attrs_with_types, #initialize, inspect, #inspect, reference_attrs, reference_setters, resource_for_collection, resource_for_singular, to_xml_big_decimal, #to_xml_inject_ns, #to_xml_ns
```

```APIDOC
### Methods included from Validator
#line_item_size
```

```APIDOC
### Methods included from Definition
included, #is_name_list_entity?, #is_transaction_entity?
```

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

### GET /cdc

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ChangeDataCapture%3Asince

Retrieves a list of entities that have been modified since the provided timestamp.

```APIDOC
## GET /cdc

### Description
Retrieves entities that have changed since a specified timestamp.

### Method
GET

### Endpoint
/cdc

### Parameters
#### Query Parameters
- **entity_list** (string) - Required - The list of entities to query.
- **changedSince** (string) - Required - The ISO8601 formatted timestamp to filter changes.

### Response
#### Success Response (200)
- **model** (object) - Returns a model instance populated with the XML response.
```

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

### GET /report/find_row

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Report%3Afind_row

Retrieves a specific row from a report based on the provided label.

```APIDOC
## GET /report/find_row

### Description
Searches for a specific row within a report object using the provided label.

### Method
GET

### Parameters
#### Query Parameters
- **label** (String) - Required - The label identifier to search for within the report.

### Response
#### Success Response (200)
- **Object** - The row data matching the provided label.
```

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

### BaseService Class Overview

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/PaymentChange

Details constants, instance attributes, and methods inherited or included in the BaseService class and its related services.

```APIDOC
## Constants inherited from BaseService
BaseService::BASE_DOMAIN, BaseService::HTTP_ACCEPT, BaseService::HTTP_ACCEPT_ENCODING, BaseService::HTTP_CONTENT_TYPE, BaseService::SANDBOX_DOMAIN, BaseService::XML_NS

## Instance Attribute Summary
### Attributes inherited from BaseService
#after_request, #around_request, #base_uri, #before_request, #company_id, #last_response_intuit_tid, #last_response_xml, #oauth

### Attributes included from Util::Logging
#log

## Method Summary
### Methods inherited from ChangeService
#since, #url_for_query

### Methods inherited from BaseService
#access_token=, #default_model_query, #initialize, #is_json?, #is_pdf?, #realm_id=, #rebuild_connection!, #url_for_base, #url_for_query, #url_for_resource

### Methods included from ServiceCrud
#all, #create, #delete, #delete_by_query_string, #exists?, #fetch_by_id, #find_by, #query, #query_in_batches

### Methods included from Util::Logging
#condense_logs?, #log?, #log_multiple, #log_xml

## Constructor Details
This class inherits a constructor from Quickbooks::Service::BaseService
```

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

### Initialize Sales Item Line Detail

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Line%3Asales_item%21

Sets the detail type to sales item and yields the detail object for configuration if a block is provided.

```ruby
def sales_item!
  self.detail_type = SALES_ITEM_LINE_DETAIL
  self.sales_item_line_detail = SalesItemLineDetail.new

  yield self.sales_item_line_detail if block_given?
end
```

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

### GET #all_rows

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Report%3Aall_rows

Retrieves all rows from a report by parsing the underlying XML structure.

```APIDOC
## GET #all_rows

### Description
Parses the report XML to extract all row data. It specifically targets the first child of 'ColData' elements to identify and map individual rows.

### Method
GET

### Response
- **Array** (Object) - A collection of parsed row objects derived from the report XML.
```

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

### Line Model Constructor

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Line

Details the constructor for the Line model, explaining how to initialize a new instance.

```APIDOC
## Constructor

### `initialize(*args)`

Initializes a new instance of the `Line` class. Sets `linked_transactions` to an empty array if not already present.
```

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

### GET /quickbooks/model/physical_address/have_lat?

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/PhysicalAddress%3Ahave_lat%3F

Checks if the physical address model has latitude information available.

```APIDOC
## GET /quickbooks/model/physical_address/have_lat?

### Description
Returns a boolean indicating whether the physical address model contains latitude data.

### Method
GET

### Response
#### Success Response (200)
- **Boolean** - Returns true if latitude is present, false otherwise.
```

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

### GET #value

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CustomField

Retrieves the value of the custom field based on its defined type.

```APIDOC
## GET #value

### Description
Returns the value of the custom field. The return type is determined by the 'type' attribute of the model (BooleanType, StringType, DateType, or NumberType).

### Response
- **value** (Object) - The value of the field, cast to the appropriate Ruby type.
```

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

### Connection and Configuration

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/CompanyInfo

Methods and attributes for managing the Quickbooks API connection.

```APIDOC
## Connection Management

### Attributes
- **company_id**: The ID of the Quickbooks company.
- **oauth**: OAuth configuration object.
- **base_uri**: The base URI for API requests.

### Methods
- **rebuild_connection!**: Forces a rebuild of the connection instance.
- **url_for_resource**: Generates the URL for a specific resource path.
```

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

### GET /company_info/industry_code

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CompanyInfo%3Aindustry_code

Retrieves the industry code associated with the company information model.

```APIDOC
## GET /company_info/industry_code

### Description
Retrieves the industry code from the CompanyInfo model.

### Method
GET

### Endpoint
/company_info/industry_code

### Response
#### Success Response (200)
- **industry_code** (Object) - The industry code associated with the company.
```

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

### Generate Resource URL in QuickBooks Ruby

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/BaseService%3Aurl_for_resource

Constructs a full URL for a given resource by appending it to the base service URL.

```ruby
def url_for_resource(resource)
  "#{url_for_base}/#{resource}"
end
```

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

### GET /util/collection#max_results

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection%3Amax_results

Retrieves the maximum number of results configured for a collection.

```APIDOC
## GET /util/collection#max_results

### Description
Returns the value of the @max_results attribute for a collection instance.

### Method
GET

### Endpoint
lib/quickbooks/util/collection.rb

### Response
#### Success Response (200)
- **max_results** (Object) - The maximum number of results defined in the collection.
```

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

### Line Model Instance Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Line

Provides documentation for instance methods available on the Line model, including setters for linked transaction IDs and methods for creating specific line item types.

```APIDOC
## Instance Methods

### `credit_memo_id=(id)`

Sets the credit memo ID for the line item and updates linked transactions.

### `discount!`

Creates a discount line item. Yields a `DiscountLineDetail` object.

### `group_line!`

Creates a group line item. Yields a `GroupLineDetail` object.

### `invoice_id=(id)`

Sets the invoice ID for the line item and updates linked transactions.

### `journal_entry!`

Creates a journal entry line item. Yields a `JournalEntryLineDetail` object.

### `payment!`

Creates a payment line item. Yields a `PaymentLineDetail` object.

### `sales_item!`

Creates a sales item line item. Yields a `SalesItemLineDetail` object.

### `sub_total!`

Creates a subtotal line item. Yields a `SubTotalLineDetail` object.
```

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

### GET /download/:uploadId

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Upload

Downloads a file from Quickbooks using the specified upload ID.

```APIDOC
## GET /download/:uploadId

### Description
Downloads a file associated with the provided upload ID.

### Method
GET

### Endpoint
/download/:uploadId

### Parameters
#### Path Parameters
- **uploadId** (String) - Required - The unique identifier of the file to download.
```

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

### POST /batch

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Batch

The `make_request` method is used to send batch requests to the Quickbooks API. It constructs the XML document from the provided entity and sends a POST request to the batch endpoint.

```APIDOC
## POST /batch

### Description
This endpoint allows for sending multiple operations in a single request to the Quickbooks API. The `make_request` method handles the construction of the batch request and parsing of the response.

### Method
POST

### Endpoint
/batch

### Parameters
#### Query Parameters
- **options** (Hash) - Optional - Options for the request, such as query parameters.

#### Request Body
- **entity** (Quickbooks::Model::Batch) - Required - An object representing the batch request, typically containing multiple operations.

### Request Example
```ruby
# Assuming 'qb' is an authenticated Quickbooks::AuthClient instance
# and 'batch_request' is a Quickbooks::Model::Batch object
response = qb.make_request(batch_request)
```

### Response
#### Success Response (200)
- **Quickbooks::Model::BatchResponse** - An object representing the response to the batch request, containing results for each operation.

#### Response Example
```json
{
  "BatchItemResponse": [
    {
      "Account": {
        "Id": "1",
        "Name": "Bank Account"
      }
    },
    {
      "errors": [
        {
          "code": 1000,
          "message": "Invalid input"
        }
      ]
    }
  ]
}
```
```

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

### Quickbooks::Collection#each Method

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Collection%3Aeach

Documentation for the `each` method of the `Quickbooks::Collection` class.

```APIDOC
## Quickbooks::Collection#each Method

### Description
Iterates over the elements of a collection, yielding each element to a block.

### Method
`each`

### Endpoint
N/A (Instance Method)

### Parameters
- `*args` - Variable number of arguments.
- `&block` - A block of code to execute for each element.

### Request Example
```ruby
collection.each do |element|
  # Process element
end
```

### Response
#### Success Response (Object)
- Returns the collection itself after iteration.

#### Response Example
```ruby
# Returns the collection object
```
```

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

### Constructor Details

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/BatchResponse

Information about the constructor inherited from BaseModel.

```APIDOC
## Constructor Details

### Description
This class inherits its constructor from `Quickbooks::Model::BaseModel`.
```

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

### GET /service_crud/all

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/ServiceCrud%3Aall

Fetches all records for a given service, returning an array of model objects.

```APIDOC
## GET /service_crud/all

### Description
Fetches all records for the specified service. This method returns an array of model objects representing the retrieved data.

### Method
GET

### Parameters
#### Query Parameters
- **object_query** (String) - Optional - A query string to filter the results.
- **options** (Hash) - Optional - Additional configuration options for the request.

### Response
#### Success Response (200)
- **Array<Object>** - An array of model objects retrieved from the service.
```

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

### Method Summary

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/Transfer

This section outlines the methods available, including those inherited from BaseModel and included from other modules.

```APIDOC
## Method Summary

### Methods inherited from BaseModel

- `#as_json`
- `#attribute_names`
- `#attributes`
- `attrs_with_types`
- `#initialize`
- `inspect`
- `#inspect`
- `reference_attrs`
- `reference_setters`
- `resource_for_collection`
- `resource_for_singular`
- `to_xml_big_decimal`
- `#to_xml_inject_ns`
- `#to_xml_ns

### Methods included from Validator

- `#line_item_size

### Methods included from Definition

- `included`
- `#is_name_list_entity?`
- `#is_transaction_entity?`
```

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

### Quickbooks-Ruby Constructor Details

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/NameValue

Information about the constructor for classes within the Quickbooks-Ruby gem.

```APIDOC
## Constructor Details

### Description
Classes in this gem inherit their constructor from `Quickbooks::Model::BaseModel`.

### Constructor
- `initialize`: Initializes a new instance of the model object, typically accepting attributes as a hash.
```

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

### GET /quickbooks/service/responses/oauth2_http_response#version

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Responses/OAuth2HttpResponse%3Aversion

Retrieves the version information from the OAuth2 HTTP response object.

```APIDOC
## GET /quickbooks/service/responses/oauth2_http_response#version

### Description
Retrieves the version information from the OAuth2 HTTP response object.

### Method
GET

### Endpoint
Quickbooks::Service::Responses::OAuth2HttpResponse#version

### Response
#### Success Response (200)
- **version** (Object) - The version object associated with the OAuth2 response.
```

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

### Credit Memo Instance Methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CreditMemo

Details on instance methods for the Credit Memo object.

```APIDOC
## Instance Method: `#email=`

### Description

Sets the email address for the credit memo. Internally, this maps to the `bill_email` attribute.

### Method

`POST`

### Endpoint

`/websites/rubydoc_info_gems_quickbooks-ruby/lib/quickbooks/model/credit_memo.rb`

### Parameters

#### Request Body

- **email** (String) - Required - The email address to set for the credit memo.

### Response

#### Success Response (200)

- **Object** - Returns the object itself after setting the email.

### Request Example

```ruby
credit_memo.email = "test@example.com"
```

### Response Example

```ruby
#<Quickbooks::Model::CreditMemo:0x00007f8b1c8e4a08 @bill_email=#<Quickbooks::Model::EmailAddress:0x00007f8b1c8e4a30 @address="test@example.com">>
```
```

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

### GET /service/responses/methods

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Service/Responses/Methods

Methods for accessing the body and status code of a Quickbooks service response.

```APIDOC
## Instance Methods

### #body
Returns the body content of the Quickbooks service response.

### #code
Returns the HTTP status code of the Quickbooks service response.
```

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

### CreditMemo email= Method

Source: https://www.rubydoc.info/gems/quickbooks-ruby/Quickbooks/Model/CreditMemo

Sets the billing email address for the credit memo by initializing a new EmailAddress object.

```ruby
# File 'lib/quickbooks/model/credit_memo.rb', line 54

def email=(email)
  self.bill_email = EmailAddress.new(email)
end
```
Tokens:
Raw