Skip to content
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
49 changes: 31 additions & 18 deletions sync-for-payroll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pip install codat-sync-for-payroll

## Example Usage
<!-- Start SDK Example Usage -->


```python
import codatsyncpayroll
from codatsyncpayroll.models import operations, shared
Expand All @@ -33,86 +31,89 @@ req = operations.CreateAccountRequest(
current_balance=Decimal('0'),
description='Invoices the business has issued but has not yet collected payment on.',
fully_qualified_category='Asset.Current',
fully_qualified_name='Fixed Asset',
fully_qualified_name='Cash On Hand',
id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e',
is_bank_account=False,
metadata=shared.AccountMetadata(
is_deleted=False,
),
metadata=shared.AccountMetadata(),
modified_date='2022-10-23T00:00:00.000Z',
name='Accounts Receivable',
nominal_code='610',
source_modified_date='2022-10-23T00:00:00.000Z',
status=shared.AccountStatus.ACTIVE,
supplemental_data=shared.SupplementalData(
content={
"Money": {
"blue": 'shred',
},
},
),
type=shared.AccountType.ASSET,
valid_datatype_links=[
shared.AccountValidDataTypeLinks(
links=[
'unde',
'abnormally',
],
property='nulla',
),
],
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
)

res = s.accounts.create(req)

if res.create_account_response is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## Available Resources and Operations


### [Accounts](docs/sdks/accounts/README.md)
### [accounts](docs/sdks/accounts/README.md)

* [create](docs/sdks/accounts/README.md#create) - Create account
* [get](docs/sdks/accounts/README.md#get) - Get account
* [get_create_model](docs/sdks/accounts/README.md#get_create_model) - Get create account model
* [list](docs/sdks/accounts/README.md#list) - List accounts

### [Companies](docs/sdks/companies/README.md)
### [companies](docs/sdks/companies/README.md)

* [create](docs/sdks/companies/README.md#create) - Create company
* [delete](docs/sdks/companies/README.md#delete) - Delete a company
* [get](docs/sdks/companies/README.md#get) - Get company
* [list](docs/sdks/companies/README.md#list) - List companies
* [update](docs/sdks/companies/README.md#update) - Update company

### [CompanyInfo](docs/sdks/companyinfo/README.md)
### [company_info](docs/sdks/companyinfo/README.md)

* [get_accounting_profile](docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile

### [Connections](docs/sdks/connections/README.md)
### [connections](docs/sdks/connections/README.md)

* [create](docs/sdks/connections/README.md#create) - Create connection
* [delete](docs/sdks/connections/README.md#delete) - Delete connection
* [get](docs/sdks/connections/README.md#get) - Get connection
* [list](docs/sdks/connections/README.md#list) - List connections
* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection

### [JournalEntries](docs/sdks/journalentries/README.md)
### [journal_entries](docs/sdks/journalentries/README.md)

* [create](docs/sdks/journalentries/README.md#create) - Create journal entry
* [delete](docs/sdks/journalentries/README.md#delete) - Delete journal entry
* [get](docs/sdks/journalentries/README.md#get) - Get journal entry
* [get_create_model](docs/sdks/journalentries/README.md#get_create_model) - Get create journal entry model
* [list](docs/sdks/journalentries/README.md#list) - List journal entries

### [Journals](docs/sdks/journals/README.md)
### [journals](docs/sdks/journals/README.md)

* [create](docs/sdks/journals/README.md#create) - Create journal
* [get](docs/sdks/journals/README.md#get) - Get journal
* [get_create_model](docs/sdks/journals/README.md#get_create_model) - Get create journal model
* [list](docs/sdks/journals/README.md#list) - List journals

### [ManageData](docs/sdks/managedata/README.md)
### [manage_data](docs/sdks/managedata/README.md)

* [get_data_status](docs/sdks/managedata/README.md#get_data_status) - Get data status
* [get_pull_operation](docs/sdks/managedata/README.md#get_pull_operation) - Get pull operation
Expand All @@ -122,9 +123,21 @@ if res.create_account_response is not None:
* [refresh_all_data_types](docs/sdks/managedata/README.md#refresh_all_data_types) - Refresh all data
* [refresh_data_type](docs/sdks/managedata/README.md#refresh_data_type) - Refresh data type

### [TrackingCategories](docs/sdks/trackingcategories/README.md)
### [tracking_categories](docs/sdks/trackingcategories/README.md)

* [get](docs/sdks/trackingcategories/README.md#get) - Get tracking categories
* [list](docs/sdks/trackingcategories/README.md#list) - List tracking categories
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->



<!-- End Dev Containers -->

<!-- Placeholder for Future Speakeasy SDK Sections -->


### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
12 changes: 11 additions & 1 deletion sync-for-payroll/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,14 @@ Based on:
### Generated
- [python v1.1.0] sync-for-payroll
### Releases
- [PyPI v1.1.0] https://pypi.org/project/codat-sync-for-payroll/1.1.0 - sync-for-payroll
- [PyPI v1.1.0] https://pypi.org/project/codat-sync-for-payroll/1.1.0 - sync-for-payroll

## 2023-10-17 14:49:24
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Payroll.yaml
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.0.0] sync-for-payroll
### Releases
- [PyPI v2.0.0] https://pypi.org/project/codat-sync-for-payroll/2.0.0 - sync-for-payroll
19 changes: 11 additions & 8 deletions sync-for-payroll/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,35 +18,38 @@ req = operations.CreateAccountRequest(
current_balance=Decimal('0'),
description='Invoices the business has issued but has not yet collected payment on.',
fully_qualified_category='Asset.Current',
fully_qualified_name='Fixed Asset',
fully_qualified_name='Cash On Hand',
id='1b6266d1-1e44-46c5-8eb5-a8f98e03124e',
is_bank_account=False,
metadata=shared.AccountMetadata(
is_deleted=False,
),
metadata=shared.AccountMetadata(),
modified_date='2022-10-23T00:00:00.000Z',
name='Accounts Receivable',
nominal_code='610',
source_modified_date='2022-10-23T00:00:00.000Z',
status=shared.AccountStatus.ACTIVE,
supplemental_data=shared.SupplementalData(
content={
"Money": {
"blue": 'shred',
},
},
),
type=shared.AccountType.ASSET,
valid_datatype_links=[
shared.AccountValidDataTypeLinks(
links=[
'unde',
'abnormally',
],
property='nulla',
),
],
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
timeout_in_minutes=544883,
)

res = s.accounts.create(req)

if res.create_account_response is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->
13 changes: 7 additions & 6 deletions sync-for-payroll/docs/models/operations/createaccountrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@

## Fields

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `account` | [Optional[shared.Account]](../../models/shared/account.md) | :heavy_minus_sign: | N/A | |
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `account` | [Optional[shared.Account]](../../models/shared/account.md) | :heavy_minus_sign: | N/A | |
| `allow_sync_on_push_complete` | *Optional[bool]* | :heavy_minus_sign: | Allow a sync upon push completion. | |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | |
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | N/A |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `create_account_response` | [Optional[shared.CreateAccountResponse]](../../models/shared/createaccountresponse.md) | :heavy_minus_sign: | Success |
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `status_code` | *int* | :heavy_check_mark: | N/A |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK |
| `content_type` | *str* | :heavy_check_mark: | N/A |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `status_code` | *int* | :heavy_check_mark: | N/A |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
Loading