Skip to content
This repository was archived by the owner on Jun 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1222,6 +1222,7 @@ _WebhookApi_ | [**webhooks_update**](docs/apis/WebhookApi.md#webhooks_update) |
- [CustomField](docs/models/CustomField.md)
- [CustomFieldFinder](docs/models/CustomFieldFinder.md)
- [CustomMapping](docs/models/CustomMapping.md)
- [CustomMappings](docs/models/CustomMappings.md)
- [Customer](docs/models/Customer.md)
- [CustomersFilter](docs/models/CustomersFilter.md)
- [CustomersSort](docs/models/CustomersSort.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/models/AccountingDepartment.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**status** | **str** | Based on the status some functionality is enabled or disabled. | [optional]
**subsidiaries** | [**[SubsidiaryReference]**](SubsidiaryReference.md) | | [optional]
**code** | **str** | The code of the department. | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/AccountingLocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**status** | **str** | Based on the status some functionality is enabled or disabled. | [optional]
**addresses** | [**[Address]**](Address.md) | | [optional]
**subsidiaries** | [**[SubsidiaryReference]**](SubsidiaryReference.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Name | Type | Description | Notes
**video_conference_id** | **str, none_type** | The ID of the video conference | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | Custom fields of the activity | [optional]
**attendees** | [**[ActivityAttendee]**](ActivityAttendee.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the activity | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the activity | [optional] [readonly]
**updated_at** | **str, none_type** | The date and time when the activity was last updated | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Applicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Name | Type | Description | Notes
**cv_url** | **str** | | [optional] [readonly]
**record_url** | **str, none_type** | | [optional]
**rejected_at** | **datetime, none_type** | | [optional] [readonly]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**deleted** | **bool, none_type** | Flag to indicate if the object is deleted. | [optional]
**deleted_by** | **str, none_type** | The user who deleted the object. | [optional] [readonly]
**deleted_at** | **datetime, none_type** | The time at which the object was deleted. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
**status** | **str, none_type** | | [optional]
**stage** | [**ApplicationStage**](ApplicationStage.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/AtsActivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/BalanceSheetReports.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**start_date** | **str** | The start date of the report | [optional]
**currency** | [**Currency**](Currency.md) | | [optional]
**net_assets** | **float** | The net assets of the balance sheet | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/BankFeedAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
**feed_status** | **str** | Current status of the bank feed. | [optional]
**country** | **str, none_type** | Country code according to ISO 3166-1 alpha-2. | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Bill.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Name | Type | Description | Notes
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**pass_through** | [**PassThroughBody**](PassThroughBody.md) | | [optional]
**accounting_period** | **str, none_type** | Accounting period | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/models/BillPayment.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Name | Type | Description | Notes
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**display_id** | **str, none_type** | Id to be displayed. | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**type** | **str, none_type** | The collections's type | [optional]
**name** | **str, none_type** | Name of the collection | [optional]
**description** | **str, none_type** | Description of the collection | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]

Expand Down
2 changes: 1 addition & 1 deletion docs/models/CollectionTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str, none_type** | A unique identifier for an object. |
**name** | **str, none_type** | The name of the tag. | [optional] [readonly]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/models/CollectionTicketComment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
**body** | **str, none_type** | Body of the comment | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/CollectionUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**last_name** | **str, none_type** | Last name of the user | [optional]
**email** | **str, none_type** | Email address of the user | [optional]
**photo_url** | **str, none_type** | The URL of the photo of a person. | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]

Expand Down
2 changes: 1 addition & 1 deletion docs/models/Company.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Name | Type | Description | Notes
**deleted** | **bool** | Whether the company is deleted or not | [optional] [readonly]
**salutation** | **str, none_type** | A formal salutation for the person. For example, 'Mr', 'Mrs' | [optional]
**birthday** | **date, none_type** | The date of birth of the person. | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | Updated by user ID | [optional] [readonly]
**created_by** | **str, none_type** | Created by user ID | [optional] [readonly]
**updated_at** | **datetime, none_type** | Last updated date | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/CompanyInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Name | Type | Description | Notes
**addresses** | [**[Address]**](Address.md) | | [optional]
**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional]
**emails** | [**[Email]**](Email.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
Expand Down
4 changes: 2 additions & 2 deletions docs/models/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ Name | Type | Description | Notes
**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional]
**emails** | [**[Email]**](Email.md) | | [optional]
**email_domain** | **str, none_type** | | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**custom_fields** | [**[CustomField], none_type**](CustomField.md) | | [optional]
**tags** | [**Tags**](Tags.md) | | [optional]
**first_call_at** | **datetime, none_type** | The first call date of the contact. | [optional] [readonly]
**first_email_at** | **datetime, none_type** | The first email date of the contact. | [optional] [readonly]
**last_activity_at** | **datetime, none_type** | The last activity date of the contact. | [optional] [readonly]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_at** | **datetime, none_type** | The last update date of the contact. | [optional] [readonly]
**created_at** | **datetime, none_type** | The creation date of the contact. | [optional] [readonly]
**opportunity_ids** | **[str]** | The opportunity ids of the contact. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/CreditNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Name | Type | Description | Notes
**billing_address** | [**Address**](Address.md) | | [optional]
**shipping_address** | [**Address**](Address.md) | | [optional]
**tracking_categories** | [**LinkedTrackingCategories**](LinkedTrackingCategories.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
Expand Down
12 changes: 12 additions & 0 deletions docs/models/CustomMappings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CustomMappings

When custom mappings are configured on the resource, the result is included here.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)


2 changes: 1 addition & 1 deletion docs/models/Customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Name | Type | Description | Notes
**payment_method** | **str, none_type** | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | [optional]
**channel** | **str, none_type** | The channel through which the transaction is processed. | [optional]
**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Department.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **str, none_type** | Department name | [optional]
**code** | **str, none_type** | | [optional]
**description** | **str, none_type** | | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
2 changes: 1 addition & 1 deletion docs/models/Drive.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **str** | A unique identifier for an object. | [readonly]
**name** | **str** | The name of the drive |
**description** | **str, none_type** | A description of the object. | [optional]
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
**custom_mappings** | [**CustomMappings**](CustomMappings.md) | | [optional]
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
Expand Down
Loading
Loading