Skip to content
Open
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
12 changes: 11 additions & 1 deletion sync-for-payables/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,14 @@ Based on:
### Generated
- [python v9.1.0] sync-for-payables
### Releases
- [PyPI v9.1.0] https://pypi.org/project/codat-sync-for-payables/9.1.0 - sync-for-payables
- [PyPI v9.1.0] https://pypi.org/project/codat-sync-for-payables/9.1.0 - sync-for-payables

## 2026-08-07 11:55:26
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Payables.yaml
- codat sdk-codegen b5f25135143b1ccfb99c941df11a7a1596dbe31e https://github.com/codat-spikes/sdk-codegen
### Generated
- [python v9.1.1] sync-for-payables
### Releases
- [PyPI v9.1.1] https://pypi.org/project/codat-sync-for-payables/9.1.1 - sync-for-payables
104 changes: 52 additions & 52 deletions sync-for-payables/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared


with CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as codat_sync_payables:

res = codat_sync_payables.companies.list(request={
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
"tags": "region=uk && team=invoice-finance",
})

# Handle response
print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared

async def main():

async with CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as codat_sync_payables:

res = await codat_sync_payables.companies.list_async(request={
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
"tags": "region=uk && team=invoice-finance",
})

# Handle response
print(res)

asyncio.run(main())
```
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
with CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as codat_sync_payables:
res = codat_sync_payables.companies.list(request={
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
"tags": "region=uk && team=invoice-finance",
})
# Handle response
print(res)
```
</br>
The same SDK client can also be used to make asynchronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from codat_sync_for_payables import CodatSyncPayables
from codat_sync_for_payables.models import shared
async def main():
async with CodatSyncPayables(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as codat_sync_payables:
res = await codat_sync_payables.companies.list_async(request={
"query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
"order_by": "-modifiedDate",
"tags": "region=uk && team=invoice-finance",
})
# Handle response
print(res)
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
30 changes: 14 additions & 16 deletions sync-for-payables/docs/models/errors/errormessage.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# ErrorMessage

Your `query` parameter was not correctly formed


## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `validation` | [OptionalNullable[shared.ErrorValidation]](../../models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
# ErrorMessage


## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
| `validation` | [Optional[shared.ErrorValidation]](../../models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
Loading