From da4cf6b795d17a1a7e3908a9dcc12b2336292ede Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 18 Nov 2024 11:31:25 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.440.1 --- .speakeasy/workflow.lock | 14 +-- lending/.speakeasy/gen.lock | 93 +++++++++++-------- lending/.speakeasy/gen.yaml | 3 +- lending/README.md | 47 ++-------- lending/RELEASES.md | 12 ++- .../models/shared/accountingbillcreditnote.md | 2 +- ...reatetransferresponseaccountingtransfer.md | 2 +- .../{recordref.md => accountingrecordref.md} | 2 +- .../docs/models/shared/accountingtransfer.md | 2 +- .../shared/accountsreceivabletracking.md | 2 +- lending/docs/models/shared/company.md | 2 + lending/docs/models/shared/recordreference.md | 13 --- lending/docs/models/shared/tracking.md | 2 +- lending/docs/models/shared/transferaccount.md | 2 +- lending/docs/sdks/transfers/README.md | 2 + lending/pyproject.toml | 2 +- lending/src/codat_lending/_version.py | 2 +- .../codat_lending/models/shared/__init__.py | 10 +- .../models/shared/accountingbillcreditnote.py | 7 +- .../accountingcreatetransferresponse.py | 7 +- .../{recordref.py => accountingrecordref.py} | 4 +- .../models/shared/accountingtransfer.py | 7 +- .../shared/accountsreceivabletracking.py | 30 +----- .../codat_lending/models/shared/company.py | 16 ++++ .../codat_lending/models/shared/tracking.py | 8 +- .../models/shared/transferaccount.py | 20 ++-- lending/src/codat_lending/sdkconfiguration.py | 6 +- 27 files changed, 151 insertions(+), 168 deletions(-) rename lending/docs/models/shared/{recordref.md => accountingrecordref.md} (98%) delete mode 100644 lending/docs/models/shared/recordreference.md rename lending/src/codat_lending/models/shared/{recordref.py => accountingrecordref.py} (93%) diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 7f9e7f517..36c4f2f27 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.431.0 +speakeasyVersion: 1.440.1 sources: accounting-source: sourceNamespace: accounting-source @@ -51,11 +51,11 @@ sources: - main lending-source: sourceNamespace: lending-source - sourceRevisionDigest: sha256:db9283292e52e0b11e1dc217a45a967819382b72943f82f071818621ef7b643b - sourceBlobDigest: sha256:4525ee073b57729cfcb4c57cd3715fd634d44b091eb42b011966d87654980fc2 + sourceRevisionDigest: sha256:0778d9e413245b5a14417b4796f06c28d282a1203ba7f8a48e147904a9787142 + sourceBlobDigest: sha256:0bb930c7190c9e61384e5af6224f76ea004ad9bc0788b264aaa35b9ebad5699f tags: - latest - - main + - speakeasy-sdk-regen-1731929356 sync-for-commerce-source: sourceNamespace: sync-for-commerce-source sourceRevisionDigest: sha256:6a62a3d9d65254b83a8e6afa5ea2e9d287076520c057bf8a1b60e42ebbdc815e @@ -116,8 +116,10 @@ targets: lending-library: source: lending-source sourceNamespace: lending-source - sourceRevisionDigest: sha256:db9283292e52e0b11e1dc217a45a967819382b72943f82f071818621ef7b643b - sourceBlobDigest: sha256:4525ee073b57729cfcb4c57cd3715fd634d44b091eb42b011966d87654980fc2 + sourceRevisionDigest: sha256:0778d9e413245b5a14417b4796f06c28d282a1203ba7f8a48e147904a9787142 + sourceBlobDigest: sha256:0bb930c7190c9e61384e5af6224f76ea004ad9bc0788b264aaa35b9ebad5699f + codeSamplesNamespace: lending-source-code-samples + codeSamplesRevisionDigest: sha256:2a3bee0a978a51571d6cbec79cdcf1073f22d5d7afe86b41d7bfff4cf53e6be8 sync-for-commerce-library: source: sync-for-commerce-source sourceNamespace: sync-for-commerce-source diff --git a/lending/.speakeasy/gen.lock b/lending/.speakeasy/gen.lock index 185b0b92f..a1503b69b 100755 --- a/lending/.speakeasy/gen.lock +++ b/lending/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: c22ee3eb-abe5-40e9-bcf6-8be944e72a7b management: - docChecksum: 47ce8d5f4793d0a11bb2be80992e2061 + docChecksum: c6d72895672a8c668a806b9c6b91e5b6 docVersion: 3.0.0 - speakeasyVersion: 1.431.0 - generationVersion: 2.451.0 - releaseVersion: 8.0.0 - configChecksum: d5b1b47da8eee6d8cda56ff6c11e7aaf + speakeasyVersion: 1.440.1 + generationVersion: 2.460.1 + releaseVersion: 9.0.0 + configChecksum: 28f80086bdf2a41d0291801388f498f0 repoURL: https://github.com/codatio/client-sdk-python.git repoSubDirectory: lending installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=lending @@ -14,8 +14,8 @@ management: features: python: additionalDependencies: 1.0.0 - constsAndDefaults: 1.0.4 - core: 5.6.4 + constsAndDefaults: 1.0.5 + core: 5.6.5 decimal: 1.0.0 defaultEnabledRetries: 0.2.0 deprecations: 3.0.0 @@ -275,6 +275,7 @@ generatedFiles: - docs/models/shared/accountingpaymentallocation.md - docs/models/shared/accountingpayments.md - docs/models/shared/accountingprofitandlossreport.md + - docs/models/shared/accountingrecordref.md - docs/models/shared/accountingsupplier.md - docs/models/shared/accountingsuppliers.md - docs/models/shared/accountingtransfer.md @@ -488,8 +489,6 @@ generatedFiles: - docs/models/shared/pushoptiontype.md - docs/models/shared/pushvalidationinfo.md - docs/models/shared/recordlinereference.md - - docs/models/shared/recordref.md - - docs/models/shared/recordreference.md - docs/models/shared/reportbasis.md - docs/models/shared/reportcomponentmeasure.md - docs/models/shared/reportgenerationpayload.md @@ -890,6 +889,7 @@ generatedFiles: - src/codat_lending/models/shared/accountingpaymentallocation.py - src/codat_lending/models/shared/accountingpayments.py - src/codat_lending/models/shared/accountingprofitandlossreport.py + - src/codat_lending/models/shared/accountingrecordref.py - src/codat_lending/models/shared/accountingsupplier.py - src/codat_lending/models/shared/accountingsuppliers.py - src/codat_lending/models/shared/accountingtransfer.py @@ -1082,7 +1082,6 @@ generatedFiles: - src/codat_lending/models/shared/pushoptionproperty.py - src/codat_lending/models/shared/pushoptiontype.py - src/codat_lending/models/shared/pushvalidationinfo.py - - src/codat_lending/models/shared/recordref.py - src/codat_lending/models/shared/reportbasis.py - src/codat_lending/models/shared/reportcomponentmeasure.py - src/codat_lending/models/shared/reportgenerationpayload.py @@ -1168,19 +1167,19 @@ examples: application/json: {"description": "Requested early access to the new financing scheme.", "name": "Technicalium"} responses: "200": - application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0"} + application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": []} With a description: requestBody: application/json: {"description": "Technology services, including web and app design and development", "name": "Technicalium"} responses: "200": - application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "Technology services, including web and app design and development", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0"} + application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "Technology services, including web and app design and development", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": []} With a tag: requestBody: application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} responses: "200": - application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "tags": {"region": "us"}} + application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [], "tags": {"region": "us"}} Malformed query: requestBody: application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} @@ -1202,7 +1201,7 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" responses: "200": - application/json: {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "My First Company", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0"} + application/json: {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores holdings", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": []} Unauthorized: parameters: path: @@ -1210,6 +1209,20 @@ examples: responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} + Parent multi-entity company: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [{"description": "Requested early access to the new financing scheme.", "id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}, "name": "Toft stores UK"}, {"description": "Requested early access to the new financing scheme.", "id": "db94eddc-9212-4568-9b5c-3eab0e325913", "links": {"portal": "https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary"}, "name": "Toft stores US"}]} + Subsidiary multi-entity company: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start", "platformName": "Oracle NetSuite", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "status": "Linked"}], "description": "", "id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}, "name": "Toft stores"}, "referenceSubsidiaryCompanies": []} list-companies: "": parameters: @@ -1220,7 +1233,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}, "self": {"href": "/companies/{id}/data/{dataType}"}}, "pageNumber": 1, "pageSize": 10, "results": [{"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739"}], "totalResults": 1} + application/json: {"_links": {"current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}, "self": {"href": "/companies/{id}/data/{dataType}"}}, "pageNumber": 1, "pageSize": 10, "results": [{"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [{"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}]}], "totalResults": 1} "400": {} One company: parameters: @@ -1231,7 +1244,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "My Test Company make testing software", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "name": "My Test Company", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "totalResults": 1} + application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "My Test Company make testing software", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "name": "My Test Company", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": []}], "totalResults": 1} List of Companies: parameters: query: @@ -1241,7 +1254,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "Technology services, including web and app design and development", "id": "d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002"}, {"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "a70bc148-dc21-46b2-a257-d9c58ac15cbb", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/096db70b-78de-4ff0-aa98-299cb5fe17a0/connections/a70bc148-dc21-46b2-a257-d9c58ac15cbb/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "A new digital agency with a passion for creating amazing digital experiences", "id": "096db70b-78de-4ff0-aa98-299cb5fe17a0", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Godata", "redirect": "https://link.codat.io/company/096db70b-78de-4ff0-aa98-299cb5fe17a0"}], "totalResults": 2} + application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "Technology services, including web and app design and development", "id": "d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": []}, {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "Requested early access to the new financing scheme.", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [{"description": "Requested early access to the new financing scheme.", "id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}, "name": "Toft stores UK"}, {"description": "Requested early access to the new financing scheme.", "id": "db94eddc-9212-4568-9b5c-3eab0e325913", "links": {"portal": "https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary"}, "name": "Toft stores US"}]}, {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start", "platformName": "Oracle NetSuite", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}, "name": "Toft stores"}, "referenceSubsidiaryCompanies": []}, {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start", "platformName": "Oracle NetSuite", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "db94eddc-9212-4568-9b5c-3eab0e325913", "lastSync": "2022-10-23T00:00:00Z", "name": "Toft stores US", "redirect": "https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}, "name": "Toft stores"}, "referenceSubsidiaryCompanies": []}], "totalResults": 3} Malformed query: parameters: query: @@ -1271,7 +1284,7 @@ examples: application/json: {"description": "Requested early access to the new financing scheme.", "name": "New Name"} responses: "200": - application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} "401": {} Update description: parameters: @@ -1281,7 +1294,7 @@ examples: application/json: {"description": "Additional documents required", "name": "Same name"} responses: "200": - application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "referenceParentCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}, "referenceSubsidiaryCompanies": [{"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} "401": {} Unauthorized: parameters: @@ -1948,7 +1961,7 @@ examples: transferId: "7110701885" responses: "200": - application/json: {"contactRef": {"dataType": "customers", "id": "e4baf949-cb1d-4341-8452-200a93baa3fa"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2"}], "description": "depositing 16531.08 into Current Account", "from": {"accountRef": {"id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 16531.08, "currency": "GBP"}, "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 16531.08, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"contactRef": {"dataType": "customers", "id": "e4baf949-cb1d-4341-8452-200a93baa3fa"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2"}], "description": "depositing 16531.08 into Current Account", "from": {"accountRef": {"dataType": "bankAccounts", "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 16531.08, "currency": "GBP"}, "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"dataType": "bankAccounts", "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 16531.08, "currency": "GBP"}, "trackingCategoryRefs": []} Dynamics 365 Business Central: parameters: path: @@ -1957,7 +1970,7 @@ examples: transferId: "7110701885" responses: "200": - application/json: {"date": "2020-11-26T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "id": "G00001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "to": {"accountRef": {"id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"date": "2020-11-26T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "id": "G00001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "trackingCategoryRefs": []} FreeAgent: parameters: path: @@ -1966,7 +1979,7 @@ examples: transferId: "7110701885" responses: "200": - application/json: {"date": "2018-06-14T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Savings Account to Freeagent Test12", "from": {"accountRef": {"id": "532100"}, "amount": 0.69, "currency": "GBP"}, "id": "307335275", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "to": {"accountRef": {"id": "708504"}, "amount": 0.69, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]} + application/json: {"date": "2018-06-14T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Savings Account to Freeagent Test12", "from": {"accountRef": {"dataType": "bankAccounts", "id": "532100"}, "amount": 0.69, "currency": "GBP"}, "id": "307335275", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "708504"}, "amount": 0.69, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]} Oracle NetSuite: parameters: path: @@ -1975,7 +1988,7 @@ examples: transferId: "7110701885" responses: "200": - application/json: {"contactRef": {"dataType": "customers", "id": "417"}, "date": "2021-03-10T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "428"}], "from": {"accountRef": {"id": "122"}, "amount": 90, "currency": "GBP"}, "id": "2-1", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47", "to": {"accountRef": {"id": "513"}, "amount": 90, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]} + application/json: {"contactRef": {"dataType": "customers", "id": "417"}, "date": "2021-03-10T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "428"}], "from": {"accountRef": {"dataType": "bankAccounts", "id": "122"}, "amount": 90, "currency": "GBP"}, "id": "2-1", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47", "to": {"accountRef": {"dataType": "bankAccounts", "id": "513"}, "amount": 90, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]} QuickBooks Desktop: parameters: path: @@ -1984,7 +1997,7 @@ examples: transferId: "EILBDVJVNUAGVKRQ" responses: "200": - application/json: {"date": "2024-10-14T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"id": "30000-933270541"}, "amount": 15000, "currency": "GBP"}, "id": "4B1-933288922", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "to": {"accountRef": {"id": "20000-933270541"}, "amount": 15000, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"date": "2024-10-14T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"dataType": "bankAccounts", "id": "30000-933270541"}, "amount": 15000, "currency": "GBP"}, "id": "4B1-933288922", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "to": {"accountRef": {"dataType": "bankAccounts", "id": "20000-933270541"}, "amount": 15000, "currency": "GBP"}, "trackingCategoryRefs": []} QuickBooks Online Sandbox: parameters: path: @@ -1993,7 +2006,7 @@ examples: transferId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"date": "2020-08-21T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "102"}, "amount": 73.41, "currency": "GBP"}, "id": "646", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "to": {"accountRef": {"id": "108"}, "amount": 73.41, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"date": "2020-08-21T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "102"}, "amount": 73.41, "currency": "GBP"}, "id": "646", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "108"}, "amount": 73.41, "currency": "GBP"}, "trackingCategoryRefs": []} QuickBooks Online: parameters: path: @@ -2002,7 +2015,7 @@ examples: transferId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"date": "2020-08-29T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "60"}, "amount": 86.19, "currency": "GBP"}, "id": "1881", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z", "to": {"accountRef": {"id": "61"}, "amount": 86.19, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"date": "2020-08-29T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "60"}, "amount": 86.19, "currency": "GBP"}, "id": "1881", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "61"}, "amount": 86.19, "currency": "GBP"}, "trackingCategoryRefs": []} Sage Business Cloud Accounting: parameters: path: @@ -2011,7 +2024,7 @@ examples: transferId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cheque", "from": {"accountRef": {"id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "id": "434bce57215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z", "to": {"accountRef": {"id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "trackingCategoryRefs": []} + application/json: {"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cheque", "from": {"accountRef": {"dataType": "bankAccounts", "id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "id": "434bce57215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "trackingCategoryRefs": []} Sage Intacct: parameters: path: @@ -2020,7 +2033,7 @@ examples: transferId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"date": "2022-03-10T00:00:00", "depositedRecordRefs": [], "description": "Description", "from": {"accountRef": {"id": "CHECKINGACCOUNT:12"}, "amount": 418.27, "currency": "ZAR"}, "id": "4844", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "to": {"accountRef": {"id": "CHECKINGACCOUNT:9"}, "amount": 35.45, "currency": "CAD"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]} + application/json: {"date": "2022-03-10T00:00:00", "depositedRecordRefs": [], "description": "Description", "from": {"accountRef": {"dataType": "bankAccounts", "id": "CHECKINGACCOUNT:12"}, "amount": 418.27, "currency": "ZAR"}, "id": "4844", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "to": {"accountRef": {"dataType": "bankAccounts", "id": "CHECKINGACCOUNT:9"}, "amount": 35.45, "currency": "CAD"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]} Unauthorized: parameters: path: @@ -2043,7 +2056,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}, "self": {"href": "/companies/{id}/data/{dataType}"}}, "pageNumber": 1, "pageSize": 10, "results": [{"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [{"dataType": "journalEntry"}, {"dataType": "journalEntry"}], "from": {"currency": "GBP"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"currency": "GBP"}}, {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [], "from": {"currency": "GBP"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"currency": "USD"}}, {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [], "from": {"currency": "USD"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"currency": "EUR"}}], "totalResults": 1} + application/json: {"_links": {"current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}, "self": {"href": "/companies/{id}/data/{dataType}"}}, "pageNumber": 1, "pageSize": 10, "results": [{"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [{"dataType": "journalEntry"}, {"dataType": "journalEntry"}], "from": {"accountRef": {"dataType": "transfer"}, "currency": "GBP"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"accountRef": {"dataType": "accountTransaction"}, "currency": "GBP"}}, {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "accountTransaction"}, "currency": "GBP"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"accountRef": {"dataType": "journalEntry"}, "currency": "USD"}}, {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "journalEntry"}, "currency": "USD"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"accountRef": {"dataType": "journalEntry"}, "currency": "EUR"}}], "totalResults": 1} "400": {} Clear Books: parameters: @@ -2057,7 +2070,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"contactRef": {"dataType": "customers", "id": "e4baf949-cb1d-4341-8452-200a93baa3fa"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2"}], "description": "depositing 16531.08 into Current Account", "from": {"accountRef": {"id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 16531.08, "currency": "GBP"}, "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 16531.08, "currency": "GBP"}, "trackingCategoryRefs": []}, {"contactRef": {"dataType": "customers", "id": "51f03576-f6b0-40d5-9fba-81a490411c03"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "38e8c917-0afc-4583-8ffe-1b53ad601197"}], "description": "depositing 188.33 into Current Account", "from": {"accountRef": {"id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 188.33, "currency": "GBP"}, "id": "78373000-29e1-4ef4-a2e6-9b573ed656e4", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 188.33, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 357} + application/json: {"_links": {"current": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"contactRef": {"dataType": "customers", "id": "e4baf949-cb1d-4341-8452-200a93baa3fa"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2"}], "description": "depositing 16531.08 into Current Account", "from": {"accountRef": {"dataType": "bankAccounts", "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 16531.08, "currency": "GBP"}, "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"dataType": "bankAccounts", "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 16531.08, "currency": "GBP"}, "trackingCategoryRefs": []}, {"contactRef": {"dataType": "customers", "id": "51f03576-f6b0-40d5-9fba-81a490411c03"}, "date": "2022-04-25T07:20:00", "depositedRecordRefs": [{"dataType": "directIncomes", "id": "38e8c917-0afc-4583-8ffe-1b53ad601197"}], "description": "depositing 188.33 into Current Account", "from": {"accountRef": {"dataType": "bankAccounts", "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3"}, "amount": 188.33, "currency": "GBP"}, "id": "78373000-29e1-4ef4-a2e6-9b573ed656e4", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "to": {"accountRef": {"dataType": "bankAccounts", "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918"}, "amount": 188.33, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 357} Dynamics 365 Business Central: parameters: path: @@ -2070,7 +2083,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-11-26T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "id": "G00001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "to": {"accountRef": {"id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2022-10-25T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "8277672c-b8e6-ec11-82f8-0022481a77f0"}, "amount": 3.6, "currency": "USD"}, "id": "TST-001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2022-10-25T15:47:48Z", "to": {"accountRef": {"id": "8982e7d8-cb19-eb11-bbf9-0022481ad2f4"}, "amount": 2.34, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 10} + application/json: {"_links": {"current": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-11-26T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "id": "G00001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185"}, "amount": 20, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2022-10-25T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "8277672c-b8e6-ec11-82f8-0022481a77f0"}, "amount": 3.6, "currency": "USD"}, "id": "TST-001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2022-10-25T15:47:48Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "8982e7d8-cb19-eb11-bbf9-0022481ad2f4"}, "amount": 2.34, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 10} FreeAgent: parameters: path: @@ -2083,7 +2096,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2018-06-14T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Savings Account to Freeagent Test12", "from": {"accountRef": {"id": "532100"}, "amount": 0.69, "currency": "GBP"}, "id": "307335275", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "to": {"accountRef": {"id": "708504"}, "amount": 0.69, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]}, {"date": "2019-12-23T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Business Current Account to Nic Test11", "from": {"accountRef": {"id": "469976"}, "amount": 250, "currency": "GBP"}, "id": "308682395", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-31T16:09:27Z", "to": {"accountRef": {"id": "691393"}, "amount": 250, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]}], "totalResults": 99} + application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2018-06-14T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Savings Account to Freeagent Test12", "from": {"accountRef": {"dataType": "bankAccounts", "id": "532100"}, "amount": 0.69, "currency": "GBP"}, "id": "307335275", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "708504"}, "amount": 0.69, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]}, {"date": "2019-12-23T00:00:00", "depositedRecordRefs": [], "description": "Transfer from Business Current Account to Nic Test11", "from": {"accountRef": {"dataType": "bankAccounts", "id": "469976"}, "amount": 250, "currency": "GBP"}, "id": "308682395", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-31T16:09:27Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "691393"}, "amount": 250, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "761"}]}], "totalResults": 99} Oracle NetSuite: parameters: path: @@ -2096,7 +2109,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"contactRef": {"dataType": "customers", "id": "417"}, "date": "2021-03-10T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "428"}], "from": {"accountRef": {"id": "122"}, "amount": 90, "currency": "GBP"}, "id": "2-1", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47", "to": {"accountRef": {"id": "513"}, "amount": 90, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]}, {"contactRef": {"dataType": "customers", "id": "417"}, "date": "2022-04-28T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "7526"}], "from": {"accountRef": {"id": "513"}, "amount": 1200, "currency": "GBP"}, "id": "2-11822", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T14:14:33", "to": {"accountRef": {"id": "122"}, "amount": 1200, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]}], "totalResults": 47} + application/json: {"_links": {"current": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"contactRef": {"dataType": "customers", "id": "417"}, "date": "2021-03-10T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "428"}], "from": {"accountRef": {"dataType": "bankAccounts", "id": "122"}, "amount": 90, "currency": "GBP"}, "id": "2-1", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47", "to": {"accountRef": {"dataType": "bankAccounts", "id": "513"}, "amount": 90, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]}, {"contactRef": {"dataType": "customers", "id": "417"}, "date": "2022-04-28T00:00:00", "depositedRecordRefs": [{"dataType": "payments", "id": "7526"}], "from": {"accountRef": {"dataType": "bankAccounts", "id": "513"}, "amount": 1200, "currency": "GBP"}, "id": "2-11822", "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T14:14:33", "to": {"accountRef": {"dataType": "bankAccounts", "id": "122"}, "amount": 1200, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "location-1"}]}], "totalResults": 47} QuickBooks Desktop: parameters: path: @@ -2109,7 +2122,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2024-10-14T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"id": "30000-933270541"}, "amount": 15000, "currency": "GBP"}, "id": "4B1-933288922", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "to": {"accountRef": {"id": "20000-933270541"}, "amount": 15000, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2024-11-25T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"id": "20000-933270541"}, "amount": 42300, "currency": "GBP"}, "id": "C2A-933780606", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:04:07", "to": {"accountRef": {"id": "30000-933270541"}, "amount": 42300, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 4} + application/json: {"_links": {"current": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2024-10-14T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"dataType": "bankAccounts", "id": "30000-933270541"}, "amount": 15000, "currency": "GBP"}, "id": "4B1-933288922", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "to": {"accountRef": {"dataType": "bankAccounts", "id": "20000-933270541"}, "amount": 15000, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2024-11-25T00:00:00", "depositedRecordRefs": [], "description": "Funds Transfer", "from": {"accountRef": {"dataType": "bankAccounts", "id": "20000-933270541"}, "amount": 42300, "currency": "GBP"}, "id": "C2A-933780606", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:04:07", "to": {"accountRef": {"dataType": "bankAccounts", "id": "30000-933270541"}, "amount": 42300, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 4} QuickBooks Online Sandbox: parameters: path: @@ -2122,7 +2135,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-08-21T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "102"}, "amount": 73.41, "currency": "GBP"}, "id": "646", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "to": {"accountRef": {"id": "108"}, "amount": 73.41, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2020-08-22T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "124"}, "amount": 66.66, "currency": "GBP"}, "id": "678", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-29T00:01:20Z", "to": {"accountRef": {"id": "109"}, "amount": 66.66, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 442} + application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-08-21T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "102"}, "amount": 73.41, "currency": "GBP"}, "id": "646", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "108"}, "amount": 73.41, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2020-08-22T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "124"}, "amount": 66.66, "currency": "GBP"}, "id": "678", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-29T00:01:20Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "109"}, "amount": 66.66, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 442} QuickBooks Online: parameters: path: @@ -2135,7 +2148,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-08-29T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "60"}, "amount": 86.19, "currency": "GBP"}, "id": "1881", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z", "to": {"accountRef": {"id": "61"}, "amount": 86.19, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2020-09-02T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"id": "60"}, "amount": 45.73, "currency": "GBP"}, "id": "1885", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:23:44Z", "to": {"accountRef": {"id": "61"}, "amount": 45.73, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 18} + application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2020-08-29T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "60"}, "amount": 86.19, "currency": "GBP"}, "id": "1881", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "61"}, "amount": 86.19, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2020-09-02T00:00:00", "depositedRecordRefs": [], "from": {"accountRef": {"dataType": "bankAccounts", "id": "60"}, "amount": 45.73, "currency": "GBP"}, "id": "1885", "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:23:44Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "61"}, "amount": 45.73, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 18} Sage Business Cloud Accounting: parameters: path: @@ -2148,7 +2161,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cheque", "from": {"accountRef": {"id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "id": "434bce57215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z", "to": {"accountRef": {"id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cash", "from": {"accountRef": {"id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 465, "currency": "GBP"}, "id": "73d909a4215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:21:40Z", "to": {"accountRef": {"id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 465, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 646} + application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cheque", "from": {"accountRef": {"dataType": "bankAccounts", "id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "id": "434bce57215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 1000, "currency": "GBP"}, "trackingCategoryRefs": []}, {"date": "2018-03-06T00:00:00", "depositedRecordRefs": [], "description": "Some cash", "from": {"accountRef": {"dataType": "bankAccounts", "id": "9a3f0ed6267a11e797950a57719b2edb"}, "amount": 465, "currency": "GBP"}, "id": "73d909a4215a11e8b45c025132dab352", "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:21:40Z", "to": {"accountRef": {"dataType": "bankAccounts", "id": "9a2c3770267a11e797950a57719b2edb"}, "amount": 465, "currency": "GBP"}, "trackingCategoryRefs": []}], "totalResults": 646} Sage Intacct: parameters: path: @@ -2161,7 +2174,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2"}, "self": {"href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2022-03-10T00:00:00", "depositedRecordRefs": [], "description": "Description", "from": {"accountRef": {"id": "CHECKINGACCOUNT:12"}, "amount": 418.27, "currency": "ZAR"}, "id": "4844", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "to": {"accountRef": {"id": "CHECKINGACCOUNT:9"}, "amount": 35.45, "currency": "CAD"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]}, {"date": "2022-10-05T00:00:00", "depositedRecordRefs": [], "description": "From bank account '700_CHK' to bank account 'Test Savings Account'", "from": {"accountRef": {"id": "CHECKINGACCOUNT:12"}, "amount": 4040.62, "currency": "ZAR"}, "id": "18828", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-10-05T15:28:15", "to": {"accountRef": {"id": "SAVINGSACCOUNT:17"}, "amount": 200, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]}], "totalResults": 2} + application/json: {"_links": {"current": {"href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2"}, "self": {"href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"date": "2022-03-10T00:00:00", "depositedRecordRefs": [], "description": "Description", "from": {"accountRef": {"dataType": "bankAccounts", "id": "CHECKINGACCOUNT:12"}, "amount": 418.27, "currency": "ZAR"}, "id": "4844", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "to": {"accountRef": {"dataType": "bankAccounts", "id": "CHECKINGACCOUNT:9"}, "amount": 35.45, "currency": "CAD"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]}, {"date": "2022-10-05T00:00:00", "depositedRecordRefs": [], "description": "From bank account '700_CHK' to bank account 'Test Savings Account'", "from": {"accountRef": {"dataType": "bankAccounts", "id": "CHECKINGACCOUNT:12"}, "amount": 4040.62, "currency": "ZAR"}, "id": "18828", "metadata": {"isDeleted": false}, "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-10-05T15:28:15", "to": {"accountRef": {"dataType": "bankAccounts", "id": "SAVINGSACCOUNT:17"}, "amount": 200, "currency": "GBP"}, "trackingCategoryRefs": [{"id": "LOCATION-10", "name": "South Africa"}]}], "totalResults": 2} Malformed query: parameters: path: @@ -9946,7 +9959,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" query: {} requestBody: - application/json: {"contactRef": {"dataType": "customers", "id": "80000028-167239230944"}, "date": "2023-01-26T11:51:18.104Z", "depositedRecordRefs": [{"dataType": "accountTransaction"}], "description": "test transfers push 20230126 12.08", "from": {"accountRef": {"id": "80000028-1671794219"}, "amount": 12, "currency": "USD"}, "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Unknown", "to": {"accountRef": {"id": "80000004-1671793811"}, "amount": 12, "currency": "EUR"}, "trackingCategoryRefs": [{"id": "80000001-1674553252", "name": "Class 1"}]} + application/json: {"contactRef": {"dataType": "customers", "id": "80000028-167239230944"}, "date": "2023-01-26T11:51:18.104Z", "depositedRecordRefs": [{"dataType": "accountTransaction"}], "description": "test transfers push 20230126 12.08", "from": {"accountRef": {"dataType": "bankAccounts", "id": "80000028-1671794219"}, "amount": 12, "currency": "USD"}, "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Unknown", "to": {"accountRef": {"dataType": "bankAccounts", "id": "80000004-1671793811"}, "amount": 12, "currency": "EUR"}, "trackingCategoryRefs": [{"id": "80000001-1674553252", "name": "Class 1"}]} responses: "200": application/json: {"changes": [{"recordRef": {"dataType": "invoices"}}, {"recordRef": {"dataType": "invoices"}}, {"recordRef": {"dataType": "invoices"}}], "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "completedOnUtc": "2022-10-23T00:00:00Z", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "dataType": "invoices", "pushOperationKey": "21cd9cf5-4033-4152-911a-509a3080a8e7", "requestedOnUtc": "2022-10-23T00:00:00Z", "status": "TimedOut", "statusCode": 137324} @@ -9958,7 +9971,7 @@ examples: connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" query: {} requestBody: - application/json: {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [{"dataType": "transfer"}, {"dataType": "transfer"}, {"dataType": "journalEntry"}], "from": {"currency": "USD"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"currency": "GBP"}} + application/json: {"date": "2022-10-23T00:00:00Z", "depositedRecordRefs": [{"dataType": "transfer"}, {"dataType": "transfer"}, {"dataType": "journalEntry"}], "from": {"accountRef": {"dataType": "invoice"}, "currency": "USD"}, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "to": {"accountRef": {"dataType": "accountTransaction"}, "currency": "GBP"}} responses: "400": application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400} diff --git a/lending/.speakeasy/gen.yaml b/lending/.speakeasy/gen.yaml index 9d0f9a8d9..c5dbaa7f9 100644 --- a/lending/.speakeasy/gen.yaml +++ b/lending/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: oAuth2PasswordEnabled: false telemetryEnabled: true python: - version: 8.0.0 + version: 9.0.0 additionalDependencies: dev: {} main: {} @@ -20,6 +20,7 @@ python: authors: - Speakeasy clientServerStatusCodesAsErrors: true + defaultErrorName: SDKError description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. enumFormat: enum fixFlags: diff --git a/lending/README.md b/lending/README.md index 22e1409cc..c89a5bb24 100644 --- a/lending/README.md +++ b/lending/README.md @@ -553,10 +553,10 @@ By default, an API error will raise a errors.SDKError exception, which has the f When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions: -| Error Type | Status Code | Content Type | -| --------------------------------- | --------------------------------- | --------------------------------- | -| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | -| errors.SDKError | 4XX, 5XX | \*/\* | +| Error Type | Status Code | Content Type | +| ------------------- | --------------------------------- | ---------------- | +| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | ### Example @@ -593,39 +593,6 @@ except errors.SDKError as e: ## Server Selection -### Select Server by Index - -You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: - -| # | Server | Variables | -| - | ------ | --------- | -| 0 | `https://api.codat.io` | None | - -#### Example - -```python -from codat_lending import CodatLending -from codat_lending.models import shared - -s = CodatLending( - server_idx=0, - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -res = s.companies.create(request={ - "name": "Technicalium", - "description": "Requested early access to the new financing scheme.", -}) - -if res is not None: - # handle response - pass - -``` - - ### Override Server URL Per-Client The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: @@ -740,9 +707,9 @@ s = CodatLending(async_client=CustomClient(httpx.AsyncClient())) This SDK supports the following security scheme globally: -| Name | Type | Scheme | -| ------------- | ------------- | ------------- | -| `auth_header` | apiKey | API key | +| Name | Type | Scheme | +| ------------- | ------ | ------- | +| `auth_header` | apiKey | API key | You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example: ```python diff --git a/lending/RELEASES.md b/lending/RELEASES.md index 23f178ada..c082eee68 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -138,4 +138,14 @@ Based on: ### Generated - [python v8.0.0] lending ### Releases -- [PyPI v8.0.0] https://pypi.org/project/codat-lending/8.0.0 - lending \ No newline at end of file +- [PyPI v8.0.0] https://pypi.org/project/codat-lending/8.0.0 - lending + +## 2024-11-18 11:29:08 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.440.1 (2.460.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v9.0.0] lending +### Releases +- [PyPI v9.0.0] https://pypi.org/project/codat-lending/9.0.0 - lending \ No newline at end of file diff --git a/lending/docs/models/shared/accountingbillcreditnote.md b/lending/docs/models/shared/accountingbillcreditnote.md index 80f0bc5a2..9f1d4122f 100644 --- a/lending/docs/models/shared/accountingbillcreditnote.md +++ b/lending/docs/models/shared/accountingbillcreditnote.md @@ -28,7 +28,7 @@ A bill credit note includes details of: | `total_tax_amount` | *Decimal* | :heavy_check_mark: | Amount of tax included in the bill credit note. | 0 | | `allocated_on_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `bill_credit_note_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Friendly reference for the bill credit note. | 91fe2a83-e161-4c21-929d-c5c10c4b07e5 | -| `created_from_refs` | List[[shared.RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | An array of records the credit note was created from. | | +| `created_from_refs` | List[[shared.AccountingRecordRef](../../models/shared/accountingrecordref.md)] | :heavy_minus_sign: | An array of records the credit note was created from. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | | `currency_rate` | *OptionalNullable[Decimal]* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `id` | *Optional[str]* | :heavy_minus_sign: | Identifier for the bill credit note that is unique to a company in the accounting software. | 1509398f-98e2-436d-8a5d-c042e0c74ffc | diff --git a/lending/docs/models/shared/accountingcreatetransferresponseaccountingtransfer.md b/lending/docs/models/shared/accountingcreatetransferresponseaccountingtransfer.md index 3169f2a9d..85305f939 100644 --- a/lending/docs/models/shared/accountingcreatetransferresponseaccountingtransfer.md +++ b/lending/docs/models/shared/accountingcreatetransferresponseaccountingtransfer.md @@ -11,7 +11,7 @@ A transfer records the movement of money between two bank accounts, or between a | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contact_ref` | [Optional[shared.ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | N/A | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `deposited_record_refs` | List[[shared.RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | +| `deposited_record_refs` | List[[shared.AccountingRecordRef](../../models/shared/accountingrecordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the transfer. | | | `from_` | [Optional[shared.TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the transfer. | | diff --git a/lending/docs/models/shared/recordref.md b/lending/docs/models/shared/accountingrecordref.md similarity index 98% rename from lending/docs/models/shared/recordref.md rename to lending/docs/models/shared/accountingrecordref.md index 02d0111a7..d1e9cf8e0 100644 --- a/lending/docs/models/shared/recordref.md +++ b/lending/docs/models/shared/accountingrecordref.md @@ -1,4 +1,4 @@ -# RecordRef +# AccountingRecordRef Links the current record to the underlying record or data type that created it. diff --git a/lending/docs/models/shared/accountingtransfer.md b/lending/docs/models/shared/accountingtransfer.md index a43dd072a..313e84823 100644 --- a/lending/docs/models/shared/accountingtransfer.md +++ b/lending/docs/models/shared/accountingtransfer.md @@ -9,7 +9,7 @@ A transfer records the movement of money between two bank accounts, or between a | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contact_ref` | [Optional[shared.ContactRef]](../../models/shared/contactref.md) | :heavy_minus_sign: | N/A | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `deposited_record_refs` | List[[shared.RecordRef](../../models/shared/recordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | +| `deposited_record_refs` | List[[shared.AccountingRecordRef](../../models/shared/accountingrecordref.md)] | :heavy_minus_sign: | List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. | | | `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the transfer. | | | `from_` | [Optional[shared.TransferAccount]](../../models/shared/transferaccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the transfer. | | diff --git a/lending/docs/models/shared/accountsreceivabletracking.md b/lending/docs/models/shared/accountsreceivabletracking.md index 42a9f6746..1aa884e11 100644 --- a/lending/docs/models/shared/accountsreceivabletracking.md +++ b/lending/docs/models/shared/accountsreceivabletracking.md @@ -12,4 +12,4 @@ Categories, and a project and customer, against which the item is tracked. | `is_rebilled_to` | [shared.BilledToType1](../../models/shared/billedtotype1.md) | :heavy_check_mark: | Defines if the bill or bill credit note is billed/rebilled to a project. | | `customer_ref` | [Optional[shared.AccountingCustomerRef]](../../models/shared/accountingcustomerref.md) | :heavy_minus_sign: | N/A | | `project_ref` | [Optional[shared.ProjectRef]](../../models/shared/projectref.md) | :heavy_minus_sign: | N/A | -| `record_ref` | [Optional[shared.RecordReference]](../../models/shared/recordreference.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file +| `record_ref` | [Optional[shared.AccountingRecordRef]](../../models/shared/accountingrecordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file diff --git a/lending/docs/models/shared/company.md b/lending/docs/models/shared/company.md index 1c03dfcdd..0f84b0518 100644 --- a/lending/docs/models/shared/company.md +++ b/lending/docs/models/shared/company.md @@ -20,4 +20,6 @@ When you create a company, you can specify a `name` and we will automatically ge | `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `last_sync` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `products` | List[*str*] | :heavy_minus_sign: | An array of products that are currently enabled for the company. | | +| `reference_parent_company` | [Optional[shared.CompanyReference]](../../models/shared/companyreference.md) | :heavy_minus_sign: | N/A | | +| `reference_subsidiary_companies` | List[[shared.CompanyReference](../../models/shared/companyreference.md)] | :heavy_minus_sign: | A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. | | | `tags` | Dict[str, *str*] | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file diff --git a/lending/docs/models/shared/recordreference.md b/lending/docs/models/shared/recordreference.md deleted file mode 100644 index e586fb3ba..000000000 --- a/lending/docs/models/shared/recordreference.md +++ /dev/null @@ -1,13 +0,0 @@ -# RecordReference - -Links the current record to the underlying record or data type that created it. - -For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Allowed name of the 'dataType'. | journalEntry | -| `id` | *Optional[str]* | :heavy_minus_sign: | 'id' of the underlying record or data type. | | \ No newline at end of file diff --git a/lending/docs/models/shared/tracking.md b/lending/docs/models/shared/tracking.md index d89eca137..6e2fe9501 100644 --- a/lending/docs/models/shared/tracking.md +++ b/lending/docs/models/shared/tracking.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `record_refs` | List[[shared.TrackingRecordRef](../../models/shared/trackingrecordref.md)] | :heavy_check_mark: | N/A | -| `invoice_to` | [Optional[shared.RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file +| `invoice_to` | [Optional[shared.AccountingRecordRef]](../../models/shared/accountingrecordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | \ No newline at end of file diff --git a/lending/docs/models/shared/transferaccount.md b/lending/docs/models/shared/transferaccount.md index 239cee664..95c3ac0c0 100644 --- a/lending/docs/models/shared/transferaccount.md +++ b/lending/docs/models/shared/transferaccount.md @@ -7,6 +7,6 @@ Account details of the account sending or receiving the transfer. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_ref` | [Optional[shared.AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | | +| `account_ref` | [Optional[shared.AccountingRecordRef]](../../models/shared/accountingrecordref.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The amount transferred between accounts. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | \ No newline at end of file diff --git a/lending/docs/sdks/transfers/README.md b/lending/docs/sdks/transfers/README.md index a5f5f2026..5a42c3bf6 100644 --- a/lending/docs/sdks/transfers/README.md +++ b/lending/docs/sdks/transfers/README.md @@ -48,6 +48,7 @@ res = s.loan_writeback.transfers.create(request={ "description": "test transfers push 20230126 12.08", "from_": { "account_ref": { + "data_type": "bankAccounts", "id": "80000028-1671794219", }, "amount": Decimal("12"), @@ -61,6 +62,7 @@ res = s.loan_writeback.transfers.create(request={ "status": shared.AccountingTransferStatus.UNKNOWN, "to": { "account_ref": { + "data_type": "bankAccounts", "id": "80000004-1671793811", }, "amount": Decimal("12"), diff --git a/lending/pyproject.toml b/lending/pyproject.toml index db42b4e6f..169a2cac1 100644 --- a/lending/pyproject.toml +++ b/lending/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "codat-lending" -version = "8.0.0" +version = "9.0.0" description = "Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features." authors = ["Speakeasy",] readme = "README-PYPI.md" diff --git a/lending/src/codat_lending/_version.py b/lending/src/codat_lending/_version.py index 55bfa7e12..4fd600736 100644 --- a/lending/src/codat_lending/_version.py +++ b/lending/src/codat_lending/_version.py @@ -3,7 +3,7 @@ import importlib.metadata __title__: str = "codat-lending" -__version__: str = "8.0.0" +__version__: str = "9.0.0" try: if __package__ is not None: diff --git a/lending/src/codat_lending/models/shared/__init__.py b/lending/src/codat_lending/models/shared/__init__.py index 304d7481e..830f3651c 100644 --- a/lending/src/codat_lending/models/shared/__init__.py +++ b/lending/src/codat_lending/models/shared/__init__.py @@ -180,6 +180,7 @@ AccountingProfitAndLossReport, AccountingProfitAndLossReportTypedDict, ) +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .accountingsupplier import AccountingSupplier, AccountingSupplierTypedDict from .accountingsuppliers import AccountingSuppliers, AccountingSuppliersTypedDict from .accountingtransfer import ( @@ -209,8 +210,6 @@ from .accountsreceivabletracking import ( AccountsReceivableTracking, AccountsReceivableTrackingTypedDict, - RecordReference, - RecordReferenceTypedDict, ) from .accountstatus import AccountStatus from .accounttransactionline import ( @@ -549,7 +548,6 @@ from .pushoptionproperty import PushOptionProperty, PushOptionPropertyTypedDict from .pushoptiontype import PushOptionType from .pushvalidationinfo import PushValidationInfo, PushValidationInfoTypedDict -from .recordref import RecordRef, RecordRefTypedDict from .reportbasis import ReportBasis from .reportcomponentmeasure import ( ReportComponentMeasure, @@ -770,6 +768,8 @@ "AccountingPaymentsTypedDict", "AccountingProfitAndLossReport", "AccountingProfitAndLossReportTypedDict", + "AccountingRecordRef", + "AccountingRecordRefTypedDict", "AccountingSupplier", "AccountingSupplierTypedDict", "AccountingSuppliers", @@ -1139,10 +1139,6 @@ "PushValidationInfoTypedDict", "RecordLineReference", "RecordLineReferenceTypedDict", - "RecordRef", - "RecordRefTypedDict", - "RecordReference", - "RecordReferenceTypedDict", "ReportBasis", "ReportComponentMeasure", "ReportComponentMeasureTypedDict", diff --git a/lending/src/codat_lending/models/shared/accountingbillcreditnote.py b/lending/src/codat_lending/models/shared/accountingbillcreditnote.py index 88e696891..71efe15e3 100644 --- a/lending/src/codat_lending/models/shared/accountingbillcreditnote.py +++ b/lending/src/codat_lending/models/shared/accountingbillcreditnote.py @@ -5,6 +5,7 @@ AccountingPaymentAllocation, AccountingPaymentAllocationTypedDict, ) +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .billcreditnotelineitem import ( BillCreditNoteLineItem, BillCreditNoteLineItemTypedDict, @@ -12,7 +13,6 @@ from .billcreditnotestatus import BillCreditNoteStatus from .items import Items, ItemsTypedDict from .metadata import Metadata, MetadataTypedDict -from .recordref import RecordRef, RecordRefTypedDict from .supplementaldata import SupplementalData, SupplementalDataTypedDict from .supplierref import SupplierRef, SupplierRefTypedDict from codat_lending.types import ( @@ -84,7 +84,7 @@ class AccountingBillCreditNoteTypedDict(TypedDict): """ bill_credit_note_number: NotRequired[Nullable[str]] r"""Friendly reference for the bill credit note.""" - created_from_refs: NotRequired[Nullable[List[RecordRefTypedDict]]] + created_from_refs: NotRequired[Nullable[List[AccountingRecordRefTypedDict]]] r"""An array of records the credit note was created from.""" currency: NotRequired[str] r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. @@ -275,7 +275,8 @@ class AccountingBillCreditNote(BaseModel): r"""Friendly reference for the bill credit note.""" created_from_refs: Annotated[ - OptionalNullable[List[RecordRef]], pydantic.Field(alias="createdFromRefs") + OptionalNullable[List[AccountingRecordRef]], + pydantic.Field(alias="createdFromRefs"), ] = UNSET r"""An array of records the credit note was created from.""" diff --git a/lending/src/codat_lending/models/shared/accountingcreatetransferresponse.py b/lending/src/codat_lending/models/shared/accountingcreatetransferresponse.py index fe374ff5f..7869f3f27 100644 --- a/lending/src/codat_lending/models/shared/accountingcreatetransferresponse.py +++ b/lending/src/codat_lending/models/shared/accountingcreatetransferresponse.py @@ -1,12 +1,12 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .contactref import ContactRef, ContactRefTypedDict from .datatype import DataType from .metadata import Metadata, MetadataTypedDict from .pushoperationchange import PushOperationChange, PushOperationChangeTypedDict from .pushoperationstatus import PushOperationStatus -from .recordref import RecordRef, RecordRefTypedDict from .supplementaldata import SupplementalData, SupplementalDataTypedDict from .trackingcategoryref import TrackingCategoryRef, TrackingCategoryRefTypedDict from .transferaccount import TransferAccount, TransferAccountTypedDict @@ -62,7 +62,7 @@ class AccountingCreateTransferResponseAccountingTransferTypedDict(TypedDict): > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - deposited_record_refs: NotRequired[Nullable[List[RecordRefTypedDict]]] + deposited_record_refs: NotRequired[Nullable[List[AccountingRecordRefTypedDict]]] r"""List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.""" description: NotRequired[Nullable[str]] r"""Description of the transfer.""" @@ -119,7 +119,8 @@ class AccountingCreateTransferResponseAccountingTransfer(BaseModel): """ deposited_record_refs: Annotated[ - OptionalNullable[List[RecordRef]], pydantic.Field(alias="depositedRecordRefs") + OptionalNullable[List[AccountingRecordRef]], + pydantic.Field(alias="depositedRecordRefs"), ] = UNSET r"""List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.""" diff --git a/lending/src/codat_lending/models/shared/recordref.py b/lending/src/codat_lending/models/shared/accountingrecordref.py similarity index 93% rename from lending/src/codat_lending/models/shared/recordref.py rename to lending/src/codat_lending/models/shared/accountingrecordref.py index 24802aeb5..0c0b1a526 100644 --- a/lending/src/codat_lending/models/shared/recordref.py +++ b/lending/src/codat_lending/models/shared/accountingrecordref.py @@ -7,7 +7,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict -class RecordRefTypedDict(TypedDict): +class AccountingRecordRefTypedDict(TypedDict): r"""Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. @@ -19,7 +19,7 @@ class RecordRefTypedDict(TypedDict): r"""'id' of the underlying record or data type.""" -class RecordRef(BaseModel): +class AccountingRecordRef(BaseModel): r"""Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. diff --git a/lending/src/codat_lending/models/shared/accountingtransfer.py b/lending/src/codat_lending/models/shared/accountingtransfer.py index b296da4ba..05abc7931 100644 --- a/lending/src/codat_lending/models/shared/accountingtransfer.py +++ b/lending/src/codat_lending/models/shared/accountingtransfer.py @@ -1,9 +1,9 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .contactref import ContactRef, ContactRefTypedDict from .metadata import Metadata, MetadataTypedDict -from .recordref import RecordRef, RecordRefTypedDict from .supplementaldata import SupplementalData, SupplementalDataTypedDict from .trackingcategoryref import TrackingCategoryRef, TrackingCategoryRefTypedDict from .transferaccount import TransferAccount, TransferAccountTypedDict @@ -55,7 +55,7 @@ class AccountingTransferTypedDict(TypedDict): > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - deposited_record_refs: NotRequired[Nullable[List[RecordRefTypedDict]]] + deposited_record_refs: NotRequired[Nullable[List[AccountingRecordRefTypedDict]]] r"""List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.""" description: NotRequired[Nullable[str]] r"""Description of the transfer.""" @@ -109,7 +109,8 @@ class AccountingTransfer(BaseModel): """ deposited_record_refs: Annotated[ - OptionalNullable[List[RecordRef]], pydantic.Field(alias="depositedRecordRefs") + OptionalNullable[List[AccountingRecordRef]], + pydantic.Field(alias="depositedRecordRefs"), ] = UNSET r"""List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.""" diff --git a/lending/src/codat_lending/models/shared/accountsreceivabletracking.py b/lending/src/codat_lending/models/shared/accountsreceivabletracking.py index 0bd1296f5..4eed0c87c 100644 --- a/lending/src/codat_lending/models/shared/accountsreceivabletracking.py +++ b/lending/src/codat_lending/models/shared/accountsreceivabletracking.py @@ -2,6 +2,7 @@ from __future__ import annotations from .accountingcustomerref import AccountingCustomerRef, AccountingCustomerRefTypedDict +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .billedtotype1 import BilledToType1 from .projectref import ProjectRef, ProjectRefTypedDict from .trackingcategoryref import TrackingCategoryRef, TrackingCategoryRefTypedDict @@ -11,31 +12,6 @@ from typing_extensions import Annotated, NotRequired, TypedDict -class RecordReferenceTypedDict(TypedDict): - r"""Links the current record to the underlying record or data type that created it. - - For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - """ - - data_type: NotRequired[str] - r"""Allowed name of the 'dataType'.""" - id: NotRequired[str] - r"""'id' of the underlying record or data type.""" - - -class RecordReference(BaseModel): - r"""Links the current record to the underlying record or data type that created it. - - For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. - """ - - data_type: Annotated[Optional[str], pydantic.Field(alias="dataType")] = None - r"""Allowed name of the 'dataType'.""" - - id: Optional[str] = None - r"""'id' of the underlying record or data type.""" - - class AccountsReceivableTrackingTypedDict(TypedDict): r"""Categories, and a project and customer, against which the item is tracked.""" @@ -46,7 +22,7 @@ class AccountsReceivableTrackingTypedDict(TypedDict): r"""Defines if the bill or bill credit note is billed/rebilled to a project.""" customer_ref: NotRequired[AccountingCustomerRefTypedDict] project_ref: NotRequired[ProjectRefTypedDict] - record_ref: NotRequired[RecordReferenceTypedDict] + record_ref: NotRequired[AccountingRecordRefTypedDict] r"""Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. @@ -75,7 +51,7 @@ class AccountsReceivableTracking(BaseModel): ) record_ref: Annotated[ - Optional[RecordReference], pydantic.Field(alias="recordRef") + Optional[AccountingRecordRef], pydantic.Field(alias="recordRef") ] = None r"""Links the current record to the underlying record or data type that created it. diff --git a/lending/src/codat_lending/models/shared/company.py b/lending/src/codat_lending/models/shared/company.py index d1140fea2..9576aa439 100644 --- a/lending/src/codat_lending/models/shared/company.py +++ b/lending/src/codat_lending/models/shared/company.py @@ -1,6 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .companyreference import CompanyReference, CompanyReferenceTypedDict from .connection import Connection, ConnectionTypedDict from codat_lending.types import ( BaseModel, @@ -78,6 +79,9 @@ class CompanyTypedDict(TypedDict): """ products: NotRequired[List[str]] r"""An array of products that are currently enabled for the company.""" + reference_parent_company: NotRequired[CompanyReferenceTypedDict] + reference_subsidiary_companies: NotRequired[List[CompanyReferenceTypedDict]] + r"""A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children.""" tags: NotRequired[Dict[str, str]] r"""A collection of user-defined key-value pairs that store custom metadata against the company.""" @@ -158,6 +162,16 @@ class Company(BaseModel): products: Optional[List[str]] = None r"""An array of products that are currently enabled for the company.""" + reference_parent_company: Annotated[ + Optional[CompanyReference], pydantic.Field(alias="referenceParentCompany") + ] = None + + reference_subsidiary_companies: Annotated[ + Optional[List[CompanyReference]], + pydantic.Field(alias="referenceSubsidiaryCompanies"), + ] = None + r"""A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children.""" + tags: Optional[Dict[str, str]] = None r"""A collection of user-defined key-value pairs that store custom metadata against the company.""" @@ -170,6 +184,8 @@ def serialize_model(self, handler): "description", "lastSync", "products", + "referenceParentCompany", + "referenceSubsidiaryCompanies", "tags", ] nullable_fields = ["createdByUserName"] diff --git a/lending/src/codat_lending/models/shared/tracking.py b/lending/src/codat_lending/models/shared/tracking.py index 6830b429e..639ee05d2 100644 --- a/lending/src/codat_lending/models/shared/tracking.py +++ b/lending/src/codat_lending/models/shared/tracking.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .recordref import RecordRef, RecordRefTypedDict +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from .trackingrecordref import TrackingRecordRef, TrackingRecordRefTypedDict from codat_lending.types import BaseModel import pydantic @@ -11,7 +11,7 @@ class TrackingTypedDict(TypedDict): record_refs: List[TrackingRecordRefTypedDict] - invoice_to: NotRequired[RecordRefTypedDict] + invoice_to: NotRequired[AccountingRecordRefTypedDict] r"""Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. @@ -21,7 +21,9 @@ class TrackingTypedDict(TypedDict): class Tracking(BaseModel): record_refs: Annotated[List[TrackingRecordRef], pydantic.Field(alias="recordRefs")] - invoice_to: Annotated[Optional[RecordRef], pydantic.Field(alias="invoiceTo")] = None + invoice_to: Annotated[ + Optional[AccountingRecordRef], pydantic.Field(alias="invoiceTo") + ] = None r"""Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. diff --git a/lending/src/codat_lending/models/shared/transferaccount.py b/lending/src/codat_lending/models/shared/transferaccount.py index baeb09504..a37a49c0d 100644 --- a/lending/src/codat_lending/models/shared/transferaccount.py +++ b/lending/src/codat_lending/models/shared/transferaccount.py @@ -1,7 +1,7 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations -from .accountref import AccountRef, AccountRefTypedDict +from .accountingrecordref import AccountingRecordRef, AccountingRecordRefTypedDict from codat_lending.types import BaseModel from codat_lending.utils import serialize_decimal, validate_decimal from decimal import Decimal @@ -15,8 +15,11 @@ class TransferAccountTypedDict(TypedDict): r"""Account details of the account sending or receiving the transfer.""" - account_ref: NotRequired[AccountRefTypedDict] - r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" + account_ref: NotRequired[AccountingRecordRefTypedDict] + r"""Links the current record to the underlying record or data type that created it. + + For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. + """ amount: NotRequired[Decimal] r"""The amount transferred between accounts.""" currency: NotRequired[str] @@ -33,10 +36,13 @@ class TransferAccountTypedDict(TypedDict): class TransferAccount(BaseModel): r"""Account details of the account sending or receiving the transfer.""" - account_ref: Annotated[Optional[AccountRef], pydantic.Field(alias="accountRef")] = ( - None - ) - r"""Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.""" + account_ref: Annotated[ + Optional[AccountingRecordRef], pydantic.Field(alias="accountRef") + ] = None + r"""Links the current record to the underlying record or data type that created it. + + For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. + """ amount: Annotated[ Optional[Decimal], diff --git a/lending/src/codat_lending/sdkconfiguration.py b/lending/src/codat_lending/sdkconfiguration.py index c81747ce2..d7e0784b3 100644 --- a/lending/src/codat_lending/sdkconfiguration.py +++ b/lending/src/codat_lending/sdkconfiguration.py @@ -27,9 +27,9 @@ class SDKConfiguration: server_idx: Optional[int] = 0 language: str = "python" openapi_doc_version: str = "3.0.0" - sdk_version: str = "8.0.0" - gen_version: str = "2.451.0" - user_agent: str = "speakeasy-sdk/python 8.0.0 2.451.0 3.0.0 codat-lending" + sdk_version: str = "9.0.0" + gen_version: str = "2.460.1" + user_agent: str = "speakeasy-sdk/python 9.0.0 2.460.1 3.0.0 codat-lending" retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) timeout_ms: Optional[int] = None