From 68f34e007452bd627e021e904ae2519ec6b3e282 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 26 Nov 2024 17:08:51 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.447.0 --- .speakeasy/workflow.lock | 13 +- sync-for-expenses/.speakeasy/gen.lock | 280 ++-- sync-for-expenses/.speakeasy/gen.yaml | 4 +- sync-for-expenses/README.md | 300 +--- sync-for-expenses/RELEASES.md | 12 +- sync-for-expenses/USAGE.md | 35 +- sync-for-expenses/build.gradle | 7 +- .../models/components/AccountMappingInfo.md | 21 +- .../models/components/AccountPrototype.md | 24 +- .../models/components/AccountingAccount.md | 34 +- .../models/components/AccountingAddress.md | 12 +- .../components/AccountingBankAccount.md | 38 +- .../models/components/AccountingCustomer.md | 30 +- .../models/components/AccountingSupplier.md | 28 +- .../components/AdjustmentTransactionLine.md | 6 +- .../AdjustmentTransactionRequest.md | 6 +- .../AdjustmentTransactionResponse.md | 2 +- .../docs/models/components/ApAccountRef.md | 8 + .../docs/models/components/Attachment.md | 6 +- .../docs/models/components/BankAccount.md | 38 +- .../models/components/BankAccountDetails.md | 2 +- .../models/components/BankAccountReference.md | 2 +- .../ClientRateLimitReachedWebhook.md | 14 +- .../ClientRateLimitReachedWebhookData.md | 4 +- .../components/ClientRateLimitResetWebhook.md | 14 +- .../ClientRateLimitResetWebhookData.md | 8 +- .../components/ClientRateLimitWebhook.md | 8 +- .../ClientRateLimitWebhookPayload.md | 6 +- .../docs/models/components/Companies.md | 2 +- .../docs/models/components/Company.md | 15 +- .../models/components/CompanyInformation.md | 27 + .../components/CompanyInformationType.md | 12 + .../models/components/CompanyReference.md | 12 + .../components/CompanyReferenceLinks.md | 10 + .../models/components/CompanyRequestBody.md | 6 +- .../models/components/CompanySyncStatus.md | 16 +- .../docs/models/components/Connection.md | 7 +- .../docs/models/components/Connections.md | 2 +- .../docs/models/components/Contact.md | 10 +- .../components/CreateAccountResponse.md | 16 +- .../CreateAccountResponseMetadata.md | 2 +- ...CreateAccountResponseValidDataTypeLinks.md | 4 +- .../components/CreateBankAccountResponse.md | 16 +- .../components/CreateCustomerResponse.md | 16 +- ...CreateCustomerResponseAccountingAddress.md | 14 - .../components/CreateExpenseResponse.md | 2 +- .../CreateReimbursableExpenseResponse.md | 2 +- .../components/CreateSupplierResponse.md | 16 +- .../docs/models/components/Customer.md | 30 +- .../docs/models/components/CustomerDetails.md | 2 +- .../docs/models/components/Customers.md | 2 +- .../models/components/DataConnectionError.md | 12 +- .../docs/models/components/DataStatus.md | 4 +- .../docs/models/components/ErrorValidation.md | 8 +- .../models/components/ErrorValidationItem.md | 6 +- .../models/components/ExpenseContactRef.md | 8 +- .../models/components/ExpenseTransaction.md | 15 +- .../components/ExpenseTransactionLine.md | 12 +- .../models/components/ExpensesSyncWebhook.md | 11 + .../components/ExpensesSyncWebhookPayload.md | 10 + .../docs/models/components/HalRef.md | 2 +- .../docs/models/components/InvoiceTo.md | 8 +- .../docs/models/components/ItemRef.md | 2 +- .../docs/models/components/Items.md | 12 +- .../docs/models/components/Links.md | 12 +- .../docs/models/components/MappingOptions.md | 12 +- .../docs/models/components/Metadata.md | 2 +- .../docs/models/components/Phone.md | 2 +- .../models/components/PhoneNumberItems.md | 9 + .../docs/models/components/PullOperation.md | 6 +- .../docs/models/components/PullOperations.md | 2 +- .../models/components/PushFieldValidation.md | 4 +- .../docs/models/components/PushOperation.md | 14 +- .../models/components/PushOperationChange.md | 10 +- .../models/components/PushOperationRef.md | 8 +- .../docs/models/components/PushOperations.md | 2 +- .../docs/models/components/PushOption.md | 18 +- .../models/components/PushOptionChoice.md | 14 +- .../models/components/PushOptionProperty.md | 18 +- .../models/components/PushValidationInfo.md | 8 +- .../docs/models/components/RecordRef.md | 2 +- .../ReimbursableExpenseTransaction.md | 9 +- .../ReimbursableExpenseTransactionLine.md | 14 +- .../models/components/SchemaTransaction.md | 11 + .../models/components/SupplementalData.md | 6 +- .../docs/models/components/Supplier.md | 28 +- .../docs/models/components/SupplierDetails.md | 2 +- .../docs/models/components/Suppliers.md | 2 +- .../models/components/SyncCompleteWebhook.md | 16 +- .../components/SyncCompleteWebhookData.md | 4 +- .../models/components/SyncFailedWebhook.md | 16 +- .../components/SyncFailedWebhookData.md | 6 +- .../docs/models/components/Tags.md | 9 - .../models/components/TaxRateMappingInfo.md | 16 +- .../components/TrackingCategoryMappingInfo.md | 8 +- .../docs/models/components/TrackingRef.md | 4 +- .../TrackingRefAdjustmentTransaction.md | 4 +- .../docs/models/components/Transaction.md | 11 +- .../TransactionDefinitionsStatus.md | 14 + .../docs/models/components/Transactions.md | 2 +- .../components/TransferTransactionRequest.md | 2 +- .../components/TransferTransactionResponse.md | 2 +- .../components/UpdateCustomerResponse.md | 16 +- ...UpdateCustomerResponseAccountingAddress.md | 14 - ...pdateCustomerResponseAccountingCustomer.md | 30 +- .../models/components/UpdateExpenseRequest.md | 12 +- ...pdateExpenseRequestBankAccountReference.md | 2 +- .../components/UpdateExpenseResponse.md | 2 +- ...teReimbursableExpenseTransactionRequest.md | 9 +- .../components/UpdateSupplierResponse.md | 16 +- ...pdateSupplierResponseAccountingSupplier.md | 28 +- .../models/components/ValidDataTypeLinks.md | 4 +- .../docs/models/components/ValidFor.md | 14 + .../docs/models/components/Validation.md | 8 +- .../docs/models/components/ValidationItem.md | 6 +- .../docs/models/components/Weblink.md | 11 + .../docs/models/errors/ErrorMessage.md | 16 +- .../models/operations/CreateAccountRequest.md | 14 +- .../operations/CreateAccountResponse.md | 12 +- .../CreateAdjustmentTransactionRequest.md | 8 +- .../CreateAdjustmentTransactionResponse.md | 12 +- .../operations/CreateBankAccountRequest.md | 6 +- .../operations/CreateBankAccountResponse.md | 12 +- .../operations/CreateCompanyResponse.md | 4 +- .../operations/CreateConnectionRequest.md | 8 +- .../operations/CreateConnectionRequestBody.md | 2 +- .../operations/CreateConnectionResponse.md | 4 +- .../operations/CreateCustomerRequest.md | 6 +- .../operations/CreateCustomerResponse.md | 12 +- .../CreateExpenseTransactionRequest.md | 8 +- .../CreateExpenseTransactionResponse.md | 12 +- .../CreatePartnerExpenseConnectionResponse.md | 4 +- ...teReimbursableExpenseTransactionRequest.md | 8 +- ...eReimbursableExpenseTransactionResponse.md | 12 +- .../operations/CreateSupplierRequest.md | 6 +- .../operations/CreateSupplierResponse.md | 12 +- .../CreateTransferTransactionRequest.md | 10 +- .../CreateTransferTransactionResponse.md | 12 +- .../operations/DeleteCompanyResponse.md | 10 +- .../operations/DeleteConnectionResponse.md | 10 +- .../GetCompanyConfigurationResponse.md | 12 +- .../GetCompanyInfoRequest.md} | 4 +- .../operations/GetCompanyInfoResponse.md | 11 + .../models/operations/GetCompanyResponse.md | 4 +- .../operations/GetConnectionResponse.md | 4 +- .../GetCreateBankAccountsModelResponse.md | 12 +- .../GetCreateChartOfAccountsModelResponse.md | 12 +- .../models/operations/GetCustomerRequest.md | 2 +- .../models/operations/GetCustomerResponse.md | 12 +- .../operations/GetDataStatusDataStatuses.md | 86 +- .../operations/GetDataStatusResponse.md | 12 +- .../GetLastSuccessfulSyncResponse.md | 12 +- .../operations/GetLatestSyncResponse.md | 12 +- .../operations/GetMappingOptionsResponse.md | 12 +- .../operations/GetPullOperationResponse.md | 4 +- .../operations/GetPushOperationResponse.md | 12 +- .../models/operations/GetSupplierResponse.md | 4 +- .../models/operations/GetSyncByIdResponse.md | 12 +- .../operations/GetSyncTransactionResponse.md | 12 +- .../models/operations/ListCompaniesRequest.md | 8 +- .../operations/ListCompaniesResponse.md | 4 +- .../operations/ListConnectionsRequest.md | 8 +- .../operations/ListConnectionsResponse.md | 4 +- .../models/operations/ListCustomersRequest.md | 8 +- .../operations/ListCustomersResponse.md | 4 +- .../operations/ListPullOperationsRequest.md | 8 +- .../operations/ListPullOperationsResponse.md | 4 +- .../operations/ListPushOperationsRequest.md | 8 +- .../operations/ListPushOperationsResponse.md | 4 +- .../models/operations/ListSuppliersRequest.md | 8 +- .../operations/ListSuppliersResponse.md | 4 +- .../operations/ListSyncTransactionsRequest.md | 4 +- .../ListSyncTransactionsResponse.md | 4 +- .../models/operations/ListSyncsResponse.md | 12 +- .../operations/RefreshAllDataTypesResponse.md | 10 +- .../operations/RefreshDataTypeRequest.md | 2 +- .../operations/RefreshDataTypeResponse.md | 4 +- .../SetCompanyConfigurationRequest.md | 8 +- .../SetCompanyConfigurationResponse.md | 12 +- .../operations/UnlinkConnectionRequest.md | 10 +- .../operations/UnlinkConnectionResponse.md | 4 +- .../UnlinkConnectionUpdateConnection.md | 6 +- .../models/operations/UpdateCompanyRequest.md | 8 +- .../operations/UpdateCompanyResponse.md | 4 +- .../operations/UpdateCustomerRequest.md | 10 +- .../operations/UpdateCustomerResponse.md | 12 +- .../UpdateExpenseTransactionRequest.md | 10 +- .../UpdateExpenseTransactionResponse.md | 12 +- ...teReimbursableExpenseTransactionRequest.md | 10 +- ...eReimbursableExpenseTransactionResponse.md | 12 +- .../operations/UpdateSupplierRequest.md | 8 +- .../operations/UpdateSupplierResponse.md | 12 +- .../UploadExpenseAttachmentRequest.md | 12 +- .../UploadExpenseAttachmentResponse.md | 12 +- .../ClientRateLimitReachedResponse.md | 10 +- .../ClientRateLimitReachedResponse1.md | 10 +- .../webhooks/ClientRateLimitResetResponse.md | 10 +- .../webhooks/ClientRateLimitResetResponse1.md | 10 +- .../ExpensesSyncSuccessfulResponse.md | 10 + .../ExpensesSyncUnsuccessfulResponse.md | 10 + .../models/webhooks/SyncCompleteResponse.md | 10 - .../models/webhooks/SyncCompletedResponse.md | 10 + .../models/webhooks/SyncFailedResponse.md | 10 +- .../docs/sdks/accounts/README.md | 81 +- .../docs/sdks/adjustments/README.md | 41 +- .../docs/sdks/attachments/README.md | 53 +- .../docs/sdks/bankaccounts/README.md | 81 +- .../docs/sdks/codatsyncexpenses/README.md | 4 +- .../docs/sdks/companies/README.md | 202 +-- .../docs/sdks/companyinfo/README.md | 65 + .../docs/sdks/configuration/README.md | 75 +- .../docs/sdks/connections/README.md | 227 +-- .../docs/sdks/customers/README.md | 185 +-- .../docs/sdks/expenses/README.md | 157 +- .../docs/sdks/managedata/README.md | 189 +-- .../docs/sdks/mappingoptions/README.md | 37 +- .../docs/sdks/pushoperations/README.md | 77 +- .../docs/sdks/reimbursements/README.md | 161 ++- .../docs/sdks/suppliers/README.md | 238 +-- sync-for-expenses/docs/sdks/sync/README.md | 151 +- .../docs/sdks/transactionstatus/README.md | 75 +- .../docs/sdks/transfers/README.md | 39 +- .../java/io/codat/sync/expenses/Accounts.java | 26 +- .../io/codat/sync/expenses/Adjustments.java | 4 +- .../io/codat/sync/expenses/Attachments.java | 52 +- .../io/codat/sync/expenses/BankAccounts.java | 20 +- .../sync/expenses/CodatSyncExpenses.java | 16 +- .../io/codat/sync/expenses/Companies.java | 29 +- .../io/codat/sync/expenses/CompanyInfo.java | 217 +++ .../io/codat/sync/expenses/Configuration.java | 8 +- .../io/codat/sync/expenses/Connections.java | 30 +- .../io/codat/sync/expenses/Customers.java | 40 +- .../java/io/codat/sync/expenses/Expenses.java | 8 +- .../io/codat/sync/expenses/ManageData.java | 20 +- .../codat/sync/expenses/MappingOptions.java | 4 +- .../codat/sync/expenses/PushOperations.java | 8 +- .../codat/sync/expenses/Reimbursements.java | 11 +- .../codat/sync/expenses/SDKConfiguration.java | 13 +- .../io/codat/sync/expenses/Suppliers.java | 37 +- .../java/io/codat/sync/expenses/Sync.java | 16 +- .../sync/expenses/TransactionStatus.java | 14 +- .../io/codat/sync/expenses/Transfers.java | 4 +- .../models/components/AccountMappingInfo.java | 63 +- .../models/components/AccountingAccount.java | 2 - .../components/AccountingBankAccount.java | 4 +- .../models/components/AccountingCustomer.java | 22 +- .../models/components/AccountingSupplier.java | 4 +- ...{GroupReference.java => ApAccountRef.java} | 30 +- .../models/components/BankAccount.java | 4 +- .../expenses/models/components/Company.java | 186 ++- .../models/components/CompanyInformation.java | 1271 +++++++++++++++++ .../components/CompanyInformationType.java | 28 + .../models/components/CompanyReference.java | 371 +++++ .../components/CompanyReferenceLinks.java | 130 ++ .../models/components/CompanyRequestBody.java | 108 +- .../models/components/Connection.java | 83 +- .../expenses/models/components/Contact.java | 18 +- ...eateCustomerResponseAccountingAddress.java | 469 ------ .../expenses/models/components/Customer.java | 22 +- .../models/components/ExpenseTransaction.java | 62 +- .../components/ExpensesSyncWebhook.java | 399 ++++++ .../ExpensesSyncWebhookPayload.java | 215 +++ .../models/components/PhoneNumberItems.java | 169 +++ .../ReimbursableExpenseTransaction.java | 45 +- .../models/components/SchemaTransaction.java | 320 +++++ .../expenses/models/components/Supplier.java | 4 +- .../sync/expenses/models/components/Tags.java | 64 - .../models/components/Transaction.java | 238 ++- .../TransactionDefinitionsStatus.java | 30 + .../models/components/Transactions.java | 18 +- ...dateCustomerResponseAccountingAddress.java | 469 ------ ...ateCustomerResponseAccountingCustomer.java | 22 +- ...ReimbursableExpenseTransactionRequest.java | 45 +- ...ateSupplierResponseAccountingSupplier.java | 4 +- .../expenses/models/components/ValidFor.java | 29 + .../expenses/models/components/Weblink.java | 192 +++ .../expenses/models/errors/ErrorMessage.java | 3 +- .../CreateAccountRequestBuilder.java | 6 +- ...teAdjustmentTransactionRequestBuilder.java | 6 +- .../CreateBankAccountRequestBuilder.java | 6 +- .../CreateCompanyRequestBuilder.java | 8 +- .../CreateConnectionRequestBuilder.java | 6 +- .../CreateCustomerRequestBuilder.java | 6 +- ...reateExpenseTransactionRequestBuilder.java | 6 +- ...artnerExpenseConnectionRequestBuilder.java | 6 +- ...sableExpenseTransactionRequestBuilder.java | 6 +- .../CreateSupplierRequestBuilder.java | 6 +- ...eateTransferTransactionRequestBuilder.java | 6 +- .../DeleteCompanyRequestBuilder.java | 6 +- .../DeleteConnectionRequestBuilder.java | 6 +- ...GetCompanyConfigurationRequestBuilder.java | 6 +- .../operations/GetCompanyInfoRequest.java | 101 ++ .../GetCompanyInfoRequestBuilder.java | 48 + .../operations/GetCompanyInfoResponse.java | 252 ++++ .../operations/GetCompanyRequestBuilder.java | 6 +- .../GetConnectionRequestBuilder.java | 6 +- ...CreateBankAccountsModelRequestBuilder.java | 6 +- ...ateChartOfAccountsModelRequestBuilder.java | 6 +- .../operations/GetCustomerRequestBuilder.java | 6 +- .../GetDataStatusRequestBuilder.java | 6 +- .../GetLastSuccessfulSyncRequestBuilder.java | 6 +- .../GetLatestSyncRequestBuilder.java | 6 +- .../GetMappingOptionsRequestBuilder.java | 6 +- .../GetPullOperationRequestBuilder.java | 6 +- .../GetPushOperationRequestBuilder.java | 6 +- .../operations/GetSupplierRequestBuilder.java | 6 +- .../operations/GetSyncByIdRequestBuilder.java | 6 +- .../GetSyncTransactionRequestBuilder.java | 6 +- .../GetSyncTransactionResponse.java | 20 +- .../ListCompaniesRequestBuilder.java | 6 +- .../ListConnectionsRequestBuilder.java | 6 +- .../ListCustomersRequestBuilder.java | 6 +- .../ListPullOperationsRequestBuilder.java | 6 +- .../ListPushOperationsRequestBuilder.java | 6 +- .../ListSuppliersRequestBuilder.java | 6 +- .../ListSyncTransactionsRequestBuilder.java | 6 +- .../operations/ListSyncsRequestBuilder.java | 6 +- .../RefreshAllDataTypesRequestBuilder.java | 6 +- .../RefreshDataTypeRequestBuilder.java | 6 +- .../operations/SDKMethodInterfaces.java | 100 +- ...SetCompanyConfigurationRequestBuilder.java | 6 +- .../UnlinkConnectionRequestBuilder.java | 6 +- .../UpdateCompanyRequestBuilder.java | 6 +- .../UpdateCustomerRequestBuilder.java | 6 +- ...pdateExpenseTransactionRequestBuilder.java | 6 +- ...sableExpenseTransactionRequestBuilder.java | 6 +- .../UpdateSupplierRequestBuilder.java | 6 +- ...UploadExpenseAttachmentRequestBuilder.java | 6 +- .../ExpensesSyncSuccessfulResponse.java | 183 +++ .../ExpensesSyncUnsuccessfulResponse.java | 183 +++ ...sponse.java => SyncCompletedResponse.java} | 18 +- .../sync/expenses/utils/EventStream.java | 6 +- .../sync/expenses/utils/HTTPRequest.java | 68 +- .../expenses/utils/OneOfDeserializer.java | 2 +- .../io/codat/sync/expenses/utils/Options.java | 12 +- .../expenses/utils/PathParamsMetadata.java | 4 +- .../sync/expenses/utils/QueryParameter.java | 62 + .../sync/expenses/utils/QueryParameters.java | 66 +- .../expenses/utils/QueryParamsMetadata.java | 4 +- .../codat/sync/expenses/utils/Security.java | 12 +- .../sync/expenses/utils/TypedObject.java | 7 +- .../sync/expenses/utils/Utf8UrlEncoder.java | 117 ++ .../io/codat/sync/expenses/utils/Utils.java | 226 ++- 343 files changed, 7868 insertions(+), 4404 deletions(-) create mode 100644 sync-for-expenses/docs/models/components/ApAccountRef.md create mode 100644 sync-for-expenses/docs/models/components/CompanyInformation.md create mode 100644 sync-for-expenses/docs/models/components/CompanyInformationType.md create mode 100644 sync-for-expenses/docs/models/components/CompanyReference.md create mode 100644 sync-for-expenses/docs/models/components/CompanyReferenceLinks.md delete mode 100644 sync-for-expenses/docs/models/components/CreateCustomerResponseAccountingAddress.md create mode 100644 sync-for-expenses/docs/models/components/ExpensesSyncWebhook.md create mode 100644 sync-for-expenses/docs/models/components/ExpensesSyncWebhookPayload.md create mode 100644 sync-for-expenses/docs/models/components/PhoneNumberItems.md create mode 100644 sync-for-expenses/docs/models/components/SchemaTransaction.md delete mode 100644 sync-for-expenses/docs/models/components/Tags.md create mode 100644 sync-for-expenses/docs/models/components/TransactionDefinitionsStatus.md delete mode 100644 sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingAddress.md create mode 100644 sync-for-expenses/docs/models/components/ValidFor.md create mode 100644 sync-for-expenses/docs/models/components/Weblink.md rename sync-for-expenses/docs/models/{components/GroupReference.md => operations/GetCompanyInfoRequest.md} (65%) create mode 100644 sync-for-expenses/docs/models/operations/GetCompanyInfoResponse.md create mode 100644 sync-for-expenses/docs/models/webhooks/ExpensesSyncSuccessfulResponse.md create mode 100644 sync-for-expenses/docs/models/webhooks/ExpensesSyncUnsuccessfulResponse.md delete mode 100644 sync-for-expenses/docs/models/webhooks/SyncCompleteResponse.md create mode 100644 sync-for-expenses/docs/models/webhooks/SyncCompletedResponse.md create mode 100644 sync-for-expenses/docs/sdks/companyinfo/README.md create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/CompanyInfo.java rename sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/{GroupReference.java => ApAccountRef.java} (63%) create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformation.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformationType.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReference.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReferenceLinks.java delete mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponseAccountingAddress.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhook.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhookPayload.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/PhoneNumberItems.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/SchemaTransaction.java delete mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Tags.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/TransactionDefinitionsStatus.java delete mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingAddress.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ValidFor.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Weblink.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequest.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequestBuilder.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoResponse.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncSuccessfulResponse.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncUnsuccessfulResponse.java rename sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/{SyncCompleteResponse.java => SyncCompletedResponse.java} (89%) create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameter.java create mode 100644 sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utf8UrlEncoder.java diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 02c8022f..d5d1fab7 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -47,11 +47,12 @@ sources: - "1.1" sync-for-expenses-source: sourceNamespace: sync-for-expenses-source - sourceRevisionDigest: sha256:b5eb22d9cecae898f800d1dd163828079b3e370e151cb6dbf02122f0c8cff9cc - sourceBlobDigest: sha256:7f399328e7bf537a3e5ee884667234673d34c00e889182df4e2b0500bb91dcfd + sourceRevisionDigest: sha256:06a4c2d3485e1238d9bf03c430f1b9715fa3eacf75359d2dd6954ab9b88b9b5a + sourceBlobDigest: sha256:abe56a70fc7e5c5883c7e8a6bef59d69ceb2dc4eddbb3106ae06b6c5acb38408 tags: - latest - - main + - speakeasy-sdk-regen-1732640871 + - prealpha sync-for-payables-source: sourceNamespace: sync-for-payables-source sourceRevisionDigest: sha256:b7ab686758f0afcdfdea71a46fe64a0cc9e8e4ce32af1314372c9134dbb13ad6 @@ -108,8 +109,10 @@ targets: sync-for-expenses-library: source: sync-for-expenses-source sourceNamespace: sync-for-expenses-source - sourceRevisionDigest: sha256:b5eb22d9cecae898f800d1dd163828079b3e370e151cb6dbf02122f0c8cff9cc - sourceBlobDigest: sha256:7f399328e7bf537a3e5ee884667234673d34c00e889182df4e2b0500bb91dcfd + sourceRevisionDigest: sha256:06a4c2d3485e1238d9bf03c430f1b9715fa3eacf75359d2dd6954ab9b88b9b5a + sourceBlobDigest: sha256:abe56a70fc7e5c5883c7e8a6bef59d69ceb2dc4eddbb3106ae06b6c5acb38408 + codeSamplesNamespace: sync-for-expenses-source-code-samples + codeSamplesRevisionDigest: sha256:5ae3cf5f57fc94cd19a95ecc474bb42e81ddbeeab0de11529e19936155a99e52 sync-for-payables-library: source: sync-for-payables-source sourceNamespace: sync-for-payables-source diff --git a/sync-for-expenses/.speakeasy/gen.lock b/sync-for-expenses/.speakeasy/gen.lock index c8fbb3ab..a1cd9e9e 100755 --- a/sync-for-expenses/.speakeasy/gen.lock +++ b/sync-for-expenses/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 37c7760d-adec-45ec-9000-ca662e9c0068 management: - docChecksum: 05894ed5d629c7c3f5209e037a7061bc + docChecksum: c99953b67f6a5e5522a0340e273decdb docVersion: prealpha - speakeasyVersion: 1.396.7 - generationVersion: 2.415.6 - releaseVersion: 0.3.0 - configChecksum: 75b5ef209f6169d257e8b73ec3f070c0 + speakeasyVersion: 1.447.0 + generationVersion: 2.463.0 + releaseVersion: 1.0.0 + configChecksum: befa27571044b513991e7826b0521a1a repoURL: https://github.com/codatio/client-sdk-java.git repoSubDirectory: sync-for-expenses published: true @@ -14,7 +14,7 @@ features: java: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.1 - core: 3.29.7 + core: 3.32.2 decimal: 0.0.1 deprecations: 2.81.1 examples: 2.81.3 @@ -27,6 +27,7 @@ features: nullables: 0.1.0 retries: 0.1.1 sdkHooks: 0.1.0 + serverEventsSentinels: 0.2.0 webhooks: 1.0.0 generatedFiles: - .gitattributes @@ -48,6 +49,7 @@ generatedFiles: - docs/models/components/AdjustmentTransactionLine.md - docs/models/components/AdjustmentTransactionRequest.md - docs/models/components/AdjustmentTransactionResponse.md + - docs/models/components/ApAccountRef.md - docs/models/components/Attachment.md - docs/models/components/AttachmentUpload.md - docs/models/components/BankAccount.md @@ -65,6 +67,10 @@ generatedFiles: - docs/models/components/Companies.md - docs/models/components/Company.md - docs/models/components/CompanyConfiguration.md + - docs/models/components/CompanyInformation.md + - docs/models/components/CompanyInformationType.md + - docs/models/components/CompanyReference.md + - docs/models/components/CompanyReferenceLinks.md - docs/models/components/CompanyRequestBody.md - docs/models/components/CompanySyncStatus.md - docs/models/components/Connection.md @@ -76,7 +82,6 @@ generatedFiles: - docs/models/components/CreateBankAccountResponse.md - docs/models/components/CreateBankAccountResponseBankAccountType.md - docs/models/components/CreateCustomerResponse.md - - docs/models/components/CreateCustomerResponseAccountingAddress.md - docs/models/components/CreateExpenseResponse.md - docs/models/components/CreateReimbursableExpenseResponse.md - docs/models/components/CreateSupplierResponse.md @@ -97,8 +102,9 @@ generatedFiles: - docs/models/components/ExpenseTransaction.md - docs/models/components/ExpenseTransactionLine.md - docs/models/components/ExpenseTransactionType.md + - docs/models/components/ExpensesSyncWebhook.md + - docs/models/components/ExpensesSyncWebhookPayload.md - docs/models/components/From.md - - docs/models/components/GroupReference.md - docs/models/components/HalRef.md - docs/models/components/IntegrationType.md - docs/models/components/InvoiceTo.md @@ -109,6 +115,7 @@ generatedFiles: - docs/models/components/MappingOptions.md - docs/models/components/Metadata.md - docs/models/components/Phone.md + - docs/models/components/PhoneNumberItems.md - docs/models/components/PhoneNumberType.md - docs/models/components/PullOperation.md - docs/models/components/PullOperations.md @@ -129,6 +136,7 @@ generatedFiles: - docs/models/components/ReimbursableExpenseTransactionLine.md - docs/models/components/ReimbursementContactRef.md - docs/models/components/SchemaDataType.md + - docs/models/components/SchemaTransaction.md - docs/models/components/Security.md - docs/models/components/SourceType.md - docs/models/components/Status.md @@ -141,7 +149,6 @@ generatedFiles: - docs/models/components/SyncCompleteWebhookData.md - docs/models/components/SyncFailedWebhook.md - docs/models/components/SyncFailedWebhookData.md - - docs/models/components/Tags.md - docs/models/components/TaxRateMappingInfo.md - docs/models/components/To.md - docs/models/components/TrackingCategoryMappingInfo.md @@ -150,6 +157,7 @@ generatedFiles: - docs/models/components/TrackingRefAdjustmentTransactionDataType.md - docs/models/components/TrackingRefDataType.md - docs/models/components/Transaction.md + - docs/models/components/TransactionDefinitionsStatus.md - docs/models/components/TransactionStatus.md - docs/models/components/Transactions.md - docs/models/components/TransferTransactionRequest.md @@ -157,7 +165,6 @@ generatedFiles: - docs/models/components/TransferTransactionResponse.md - docs/models/components/Type.md - docs/models/components/UpdateCustomerResponse.md - - docs/models/components/UpdateCustomerResponseAccountingAddress.md - docs/models/components/UpdateCustomerResponseAccountingCustomer.md - docs/models/components/UpdateExpenseRequest.md - docs/models/components/UpdateExpenseRequestBankAccountReference.md @@ -167,9 +174,11 @@ generatedFiles: - docs/models/components/UpdateSupplierResponse.md - docs/models/components/UpdateSupplierResponseAccountingSupplier.md - docs/models/components/ValidDataTypeLinks.md + - docs/models/components/ValidFor.md - docs/models/components/ValidTransactionTypes.md - docs/models/components/Validation.md - docs/models/components/ValidationItem.md + - docs/models/components/Weblink.md - docs/models/errors/ErrorMessage.md - docs/models/operations/CreateAccountRequest.md - docs/models/operations/CreateAccountResponse.md @@ -199,6 +208,8 @@ generatedFiles: - docs/models/operations/DeleteConnectionResponse.md - docs/models/operations/GetCompanyConfigurationRequest.md - docs/models/operations/GetCompanyConfigurationResponse.md + - docs/models/operations/GetCompanyInfoRequest.md + - docs/models/operations/GetCompanyInfoResponse.md - docs/models/operations/GetCompanyRequest.md - docs/models/operations/GetCompanyResponse.md - docs/models/operations/GetConnectionRequest.md @@ -269,7 +280,9 @@ generatedFiles: - docs/models/webhooks/ClientRateLimitReachedResponse1.md - docs/models/webhooks/ClientRateLimitResetResponse.md - docs/models/webhooks/ClientRateLimitResetResponse1.md - - docs/models/webhooks/SyncCompleteResponse.md + - docs/models/webhooks/ExpensesSyncSuccessfulResponse.md + - docs/models/webhooks/ExpensesSyncUnsuccessfulResponse.md + - docs/models/webhooks/SyncCompletedResponse.md - docs/models/webhooks/SyncFailedResponse.md - docs/sdks/accounts/README.md - docs/sdks/adjustments/README.md @@ -277,6 +290,7 @@ generatedFiles: - docs/sdks/bankaccounts/README.md - docs/sdks/codatsyncexpenses/README.md - docs/sdks/companies/README.md + - docs/sdks/companyinfo/README.md - docs/sdks/configuration/README.md - docs/sdks/connections/README.md - docs/sdks/customers/README.md @@ -300,6 +314,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/BankAccounts.java - src/main/java/io/codat/sync/expenses/CodatSyncExpenses.java - src/main/java/io/codat/sync/expenses/Companies.java + - src/main/java/io/codat/sync/expenses/CompanyInfo.java - src/main/java/io/codat/sync/expenses/Configuration.java - src/main/java/io/codat/sync/expenses/Connections.java - src/main/java/io/codat/sync/expenses/Customers.java @@ -329,6 +344,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/AdjustmentTransactionLine.java - src/main/java/io/codat/sync/expenses/models/components/AdjustmentTransactionRequest.java - src/main/java/io/codat/sync/expenses/models/components/AdjustmentTransactionResponse.java + - src/main/java/io/codat/sync/expenses/models/components/ApAccountRef.java - src/main/java/io/codat/sync/expenses/models/components/Attachment.java - src/main/java/io/codat/sync/expenses/models/components/AttachmentUpload.java - src/main/java/io/codat/sync/expenses/models/components/BankAccount.java @@ -346,6 +362,10 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/Companies.java - src/main/java/io/codat/sync/expenses/models/components/Company.java - src/main/java/io/codat/sync/expenses/models/components/CompanyConfiguration.java + - src/main/java/io/codat/sync/expenses/models/components/CompanyInformation.java + - src/main/java/io/codat/sync/expenses/models/components/CompanyInformationType.java + - src/main/java/io/codat/sync/expenses/models/components/CompanyReference.java + - src/main/java/io/codat/sync/expenses/models/components/CompanyReferenceLinks.java - src/main/java/io/codat/sync/expenses/models/components/CompanyRequestBody.java - src/main/java/io/codat/sync/expenses/models/components/CompanySyncStatus.java - src/main/java/io/codat/sync/expenses/models/components/Connection.java @@ -357,7 +377,6 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/CreateBankAccountResponse.java - src/main/java/io/codat/sync/expenses/models/components/CreateBankAccountResponseBankAccountType.java - src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponse.java - - src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponseAccountingAddress.java - src/main/java/io/codat/sync/expenses/models/components/CreateExpenseResponse.java - src/main/java/io/codat/sync/expenses/models/components/CreateReimbursableExpenseResponse.java - src/main/java/io/codat/sync/expenses/models/components/CreateSupplierResponse.java @@ -378,8 +397,9 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/ExpenseTransaction.java - src/main/java/io/codat/sync/expenses/models/components/ExpenseTransactionLine.java - src/main/java/io/codat/sync/expenses/models/components/ExpenseTransactionType.java + - src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhook.java + - src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhookPayload.java - src/main/java/io/codat/sync/expenses/models/components/From.java - - src/main/java/io/codat/sync/expenses/models/components/GroupReference.java - src/main/java/io/codat/sync/expenses/models/components/HalRef.java - src/main/java/io/codat/sync/expenses/models/components/IntegrationType.java - src/main/java/io/codat/sync/expenses/models/components/InvoiceTo.java @@ -390,6 +410,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/MappingOptions.java - src/main/java/io/codat/sync/expenses/models/components/Metadata.java - src/main/java/io/codat/sync/expenses/models/components/Phone.java + - src/main/java/io/codat/sync/expenses/models/components/PhoneNumberItems.java - src/main/java/io/codat/sync/expenses/models/components/PhoneNumberType.java - src/main/java/io/codat/sync/expenses/models/components/PullOperation.java - src/main/java/io/codat/sync/expenses/models/components/PullOperations.java @@ -410,6 +431,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/ReimbursableExpenseTransactionLine.java - src/main/java/io/codat/sync/expenses/models/components/ReimbursementContactRef.java - src/main/java/io/codat/sync/expenses/models/components/SchemaDataType.java + - src/main/java/io/codat/sync/expenses/models/components/SchemaTransaction.java - src/main/java/io/codat/sync/expenses/models/components/Security.java - src/main/java/io/codat/sync/expenses/models/components/SourceType.java - src/main/java/io/codat/sync/expenses/models/components/Status.java @@ -422,7 +444,6 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/SyncCompleteWebhookData.java - src/main/java/io/codat/sync/expenses/models/components/SyncFailedWebhook.java - src/main/java/io/codat/sync/expenses/models/components/SyncFailedWebhookData.java - - src/main/java/io/codat/sync/expenses/models/components/Tags.java - src/main/java/io/codat/sync/expenses/models/components/TaxRateMappingInfo.java - src/main/java/io/codat/sync/expenses/models/components/To.java - src/main/java/io/codat/sync/expenses/models/components/TrackingCategoryMappingInfo.java @@ -431,6 +452,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/TrackingRefAdjustmentTransactionDataType.java - src/main/java/io/codat/sync/expenses/models/components/TrackingRefDataType.java - src/main/java/io/codat/sync/expenses/models/components/Transaction.java + - src/main/java/io/codat/sync/expenses/models/components/TransactionDefinitionsStatus.java - src/main/java/io/codat/sync/expenses/models/components/TransactionStatus.java - src/main/java/io/codat/sync/expenses/models/components/Transactions.java - src/main/java/io/codat/sync/expenses/models/components/TransferTransactionRequest.java @@ -438,7 +460,6 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/TransferTransactionResponse.java - src/main/java/io/codat/sync/expenses/models/components/Type.java - src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponse.java - - src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingAddress.java - src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingCustomer.java - src/main/java/io/codat/sync/expenses/models/components/UpdateExpenseRequest.java - src/main/java/io/codat/sync/expenses/models/components/UpdateExpenseRequestBankAccountReference.java @@ -448,9 +469,11 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponse.java - src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponseAccountingSupplier.java - src/main/java/io/codat/sync/expenses/models/components/ValidDataTypeLinks.java + - src/main/java/io/codat/sync/expenses/models/components/ValidFor.java - src/main/java/io/codat/sync/expenses/models/components/ValidTransactionTypes.java - src/main/java/io/codat/sync/expenses/models/components/Validation.java - src/main/java/io/codat/sync/expenses/models/components/ValidationItem.java + - src/main/java/io/codat/sync/expenses/models/components/Weblink.java - src/main/java/io/codat/sync/expenses/models/errors/AuthException.java - src/main/java/io/codat/sync/expenses/models/errors/ErrorMessage.java - src/main/java/io/codat/sync/expenses/models/errors/SDKError.java @@ -496,6 +519,9 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequest.java - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequestBuilder.java - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationResponse.java + - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequest.java + - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequestBuilder.java + - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoResponse.java - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequest.java - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequestBuilder.java - src/main/java/io/codat/sync/expenses/models/operations/GetCompanyResponse.java @@ -599,7 +625,9 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/models/webhooks/ClientRateLimitReachedResponse1.java - src/main/java/io/codat/sync/expenses/models/webhooks/ClientRateLimitResetResponse.java - src/main/java/io/codat/sync/expenses/models/webhooks/ClientRateLimitResetResponse1.java - - src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompleteResponse.java + - src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncSuccessfulResponse.java + - src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncUnsuccessfulResponse.java + - src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompletedResponse.java - src/main/java/io/codat/sync/expenses/models/webhooks/SyncFailedResponse.java - src/main/java/io/codat/sync/expenses/utils/BackoffStrategy.java - src/main/java/io/codat/sync/expenses/utils/BigDecimalString.java @@ -623,6 +651,7 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/utils/OneOfDeserializer.java - src/main/java/io/codat/sync/expenses/utils/Options.java - src/main/java/io/codat/sync/expenses/utils/PathParamsMetadata.java + - src/main/java/io/codat/sync/expenses/utils/QueryParameter.java - src/main/java/io/codat/sync/expenses/utils/QueryParameters.java - src/main/java/io/codat/sync/expenses/utils/QueryParamsMetadata.java - src/main/java/io/codat/sync/expenses/utils/RequestBody.java @@ -637,22 +666,23 @@ generatedFiles: - src/main/java/io/codat/sync/expenses/utils/SpeakeasyMetadata.java - src/main/java/io/codat/sync/expenses/utils/TypedObject.java - src/main/java/io/codat/sync/expenses/utils/Types.java + - src/main/java/io/codat/sync/expenses/utils/Utf8UrlEncoder.java - src/main/java/io/codat/sync/expenses/utils/Utils.java examples: create-company: With no description: requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Technicalium"} + 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", "referenceSubsidiaryCompanies": []} "400": {} With a description: requestBody: - application/json: {"description": "Technology services, including web and app design and development", "groups": [], "name": "Technicalium"} + 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", "referenceSubsidiaryCompanies": []} "400": {} With a group: requestBody: @@ -663,10 +693,16 @@ examples: "400": {} Malformed query: requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Bank of Dave"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} responses: "400": application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400} + 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", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceSubsidiaryCompanies": [], "tags": {"region": "us"}} delete-company: Unauthorized: parameters: @@ -682,7 +718,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", "referenceSubsidiaryCompanies": []} With groups: parameters: path: @@ -697,6 +733,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", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceSubsidiaryCompanies": [{"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}, "name": "Toft stores UK"}, {"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", "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", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "referenceParentCompany": {"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: @@ -718,7 +768,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": [], "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", "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", "referenceSubsidiaryCompanies": []}], "totalResults": 1} List of Companies: parameters: query: @@ -728,7 +778,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": [], "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": [], "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", "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", "referenceSubsidiaryCompanies": []}, {"created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "referenceSubsidiaryCompanies": [{"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}, "name": "Toft stores UK"}, {"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", "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"}], "id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "referenceParentCompany": {"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", "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"}], "id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "redirect": "https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913", "referenceParentCompany": {"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: @@ -755,27 +805,27 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "New Name"} + 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": [], "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"} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "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"}} "401": {} Update description: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Additional documents required", "groups": [], "name": "Same name"} + 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"} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "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"}} "401": {} Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Bank of Dave"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} @@ -857,7 +907,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "string"}, "next": {"href": "string"}, "previous": {"href": "string"}, "self": {"href": "string"}}, "pageNumber": 0, "pageSize": 0, "results": [{"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"}], "totalResults": 0} + application/json: {"_links": {"current": {"href": "string"}, "next": {"href": "string"}, "previous": {"href": "string"}, "self": {"href": "string"}}, "pageNumber": 0, "pageSize": 0, "results": [{"created": "2022-10-27T09:53:29Z", "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"}], "totalResults": 0} Malformed query: parameters: path: @@ -1137,23 +1187,23 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "7110701885" responses: "200": - application/json: {"addresses": [{"city": "Fernandohaven", "country": "United Kingdom", "line1": "Suite 214", "line2": "8439 Lueilwitz Passage", "postalCode": "JG04 7PV", "region": "Northern Ireland", "type": "Delivery"}, {"city": "Juliochester", "country": "United Kingdom", "line1": "Suite 096", "line2": "864 Halie Course", "postalCode": "DZ8 4BF", "region": "England", "type": "Delivery"}, {"city": "Naderborough", "country": "United Kingdom", "line1": "Suite 001", "line2": "416 Stokes Fords", "postalCode": "XG25 0XX", "region": "Wales", "type": "Delivery"}], "contactName": "Werner Langworth", "contacts": [{"address": {"city": "Hortenseville", "country": "United Kingdom", "line1": "Apt. 145", "line2": "317 Williamson Freeway", "postalCode": "CV4 2HR", "region": "Scotland", "type": "Delivery"}, "email": "Werner_Langworth@hotmail.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Werner Langworth", "phone": [], "status": "Active"}, {"address": {"city": "South Ali", "country": "United Kingdom", "line1": "Suite 075", "line2": "9921 Dickens Walk", "postalCode": "TI04 4OO", "region": "Scotland", "type": "Delivery"}, "email": "Belle51@yahoo.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Belle Glover", "phone": [], "status": "Active"}], "customerName": "Arjun Kuvalis", "defaultCurrency": "GBP", "emailAddress": "Arjun34@hotmail.com", "id": "c8180244-74ac-40cf-a5df-6d83661c44d7", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "014605 64820", "registrationNumber": "NI7JEJVM", "sourceModifiedDate": "2022-07-03T01:27:00", "status": "Active", "taxNumber": "7505220209.583549"} + application/json: {"addresses": [{"city": "Fernandohaven", "country": "United Kingdom", "line1": "Suite 214", "line2": "8439 Lueilwitz Passage", "postalCode": "JG04 7PV", "region": "Northern Ireland", "type": "Delivery"}, {"city": "Juliochester", "country": "United Kingdom", "line1": "Suite 096", "line2": "864 Halie Course", "postalCode": "DZ8 4BF", "region": "England", "type": "Delivery"}, {"city": "Naderborough", "country": "United Kingdom", "line1": "Suite 001", "line2": "416 Stokes Fords", "postalCode": "XG25 0XX", "region": "Wales", "type": "Delivery"}], "contactName": "Werner Langworth", "contacts": [{"address": {"city": "Hortenseville", "country": "United Kingdom", "line1": "Apt. 145", "line2": "317 Williamson Freeway", "postalCode": "CV4 2HR", "region": "Scotland", "type": "Delivery"}, "email": "Werner_Langworth@hotmail.com", "name": "Werner Langworth", "phone": [], "status": "Active"}, {"address": {"city": "South Ali", "country": "United Kingdom", "line1": "Suite 075", "line2": "9921 Dickens Walk", "postalCode": "TI04 4OO", "region": "Scotland", "type": "Delivery"}, "email": "Belle51@yahoo.com", "name": "Belle Glover", "phone": [], "status": "Active"}], "customerName": "Arjun Kuvalis", "defaultCurrency": "GBP", "emailAddress": "Arjun34@hotmail.com", "id": "c8180244-74ac-40cf-a5df-6d83661c44d7", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "014605 64820", "registrationNumber": "NI7JEJVM", "sourceModifiedDate": "2022-07-03T01:27:00", "status": "Active", "taxNumber": "7505220209.583549"} Dynamics 365 Business Central: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "7110701885" responses: "200": - application/json: {"addresses": [{"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0e2f7751-7696-ed11-bff5-6045bd0d2ad6", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2023-01-17T14:50:54Z", "status": "Active", "taxNumber": ""} + application/json: {"addresses": [{"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0e2f7751-7696-ed11-bff5-6045bd0d2ad6", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2023-01-17T14:50:54Z", "status": "Active", "taxNumber": ""} Exact (Netherlands): parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "7110701885" responses: "200": application/json: {"addresses": [{"country": "NL", "type": "Billing"}], "contacts": [], "customerName": "Ab Netherlands", "defaultCurrency": "EUR", "id": "555f8251-c65a-433a-a813-5dbe04321d1e", "modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2021-06-14T15:26:37Z", "status": "Active"} @@ -1161,7 +1211,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "7110701885" responses: "200": application/json: {"addresses": [{"city": "London", "country": "GB", "line1": "Ink Rooms", "postalCode": "WC1X 0BE", "type": "Billing"}], "contacts": [], "customerName": "Abdi 99", "defaultCurrency": "GBP", "emailAddress": "email@codat.io", "id": "5f20075a-a28e-434d-81a6-2db0dc170e87", "modifiedDate": "2022-10-26T13:33:08Z", "registrationNumber": "123456789", "sourceModifiedDate": "2020-02-26T11:23:50Z", "status": "Active", "taxNumber": "GB339 0727 47"} @@ -1169,31 +1219,31 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "EILBDVJVNUAGVKRQ" responses: "200": - application/json: {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "defaultCurrency": "USD", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "status": "Active"} + application/json: {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "defaultCurrency": "USD", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "status": "Active"} FreshBooks: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test14A@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test14B@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person2", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "987654321", "type": "Unknown"}], "status": "Active"}, {"email": "test14@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer 14 (updated)", "defaultCurrency": "GBP", "emailAddress": "test14@example.com", "id": "634509", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-18T09:23:56", "status": "Active"} + application/json: {"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test14A@example.com", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test14B@example.com", "name": "test person2", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "987654321", "type": "Unknown"}], "status": "Active"}, {"email": "test14@example.com", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer 14 (updated)", "defaultCurrency": "GBP", "emailAddress": "test14@example.com", "id": "634509", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-18T09:23:56", "status": "Active"} KashFlow: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"addresses": [], "contactName": "", "contacts": [{"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "", "phone": [], "status": "Active"}], "customerName": "Chekko Customer Test 01", "defaultCurrency": "EUR", "emailAddress": "", "id": "92227673", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "", "sourceModifiedDate": "0001-01-01T00:00:00", "status": "Active", "taxNumber": ""} + application/json: {"addresses": [], "contactName": "", "contacts": [{"email": "", "name": "", "phone": [], "status": "Active"}], "customerName": "Chekko Customer Test 01", "defaultCurrency": "EUR", "emailAddress": "", "id": "92227673", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "", "sourceModifiedDate": "0001-01-01T00:00:00", "status": "Active", "taxNumber": ""} Oracle NetSuite: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": application/json: {"addresses": [], "contactName": "Mr Test Customer", "contacts": [], "customerName": "119 Test Customer", "defaultCurrency": "GBP", "id": "773", "modifiedDate": "2023-01-30T14:48:02Z", "sourceModifiedDate": "2022-01-11T12:28:49", "status": "Active"} @@ -1201,39 +1251,39 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"addresses": [{"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Delivery"}, {"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"email": "kristy@samplename.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abercrombie, Kristy", "phone": [{"number": "415-555-6579", "type": "Primary"}], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Kristy Abercrombie", "phone": [], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Steve Darcangelo", "phone": [], "status": "Active"}], "customerName": "Abercrombie, Kristy", "defaultCurrency": "GBP", "emailAddress": "kristy@samplename.com", "id": "150000-933272658", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "415-555-6579", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"} + application/json: {"addresses": [{"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Delivery"}, {"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"email": "kristy@samplename.com", "name": "Abercrombie, Kristy", "phone": [{"number": "415-555-6579", "type": "Primary"}], "status": "Active"}, {"name": "Kristy Abercrombie", "phone": [], "status": "Active"}, {"name": "Steve Darcangelo", "phone": [], "status": "Active"}], "customerName": "Abercrombie, Kristy", "defaultCurrency": "GBP", "emailAddress": "kristy@samplename.com", "id": "150000-933272658", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "415-555-6579", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"} QuickBooks Online: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "EILBDVJVNUAGVKRQ" responses: "200": - application/json: {"addresses": [], "contactName": "Abraham's Company", "contacts": [{"email": "ab@email.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abe", "phone": [{"number": "01111111111", "type": "Mobile"}], "status": "Active"}], "customerName": "Abe", "defaultCurrency": "GBP", "emailAddress": "ab@email.com", "id": "9", "modifiedDate": "2023-01-18T11:02:35Z", "registrationNumber": "XXXX9900001", "sourceModifiedDate": "2022-12-08T15:42:59Z", "status": "Active", "taxNumber": "XXXX9900001"} + application/json: {"addresses": [], "contactName": "Abraham's Company", "contacts": [{"email": "ab@email.com", "name": "Abe", "phone": [{"number": "01111111111", "type": "Mobile"}], "status": "Active"}], "customerName": "Abe", "defaultCurrency": "GBP", "emailAddress": "ab@email.com", "id": "9", "modifiedDate": "2023-01-18T11:02:35Z", "registrationNumber": "XXXX9900001", "sourceModifiedDate": "2022-12-08T15:42:59Z", "status": "Active", "taxNumber": "XXXX9900001"} QuickBooks Online Sandbox: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"addresses": [{"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"address": {"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abercrombie International Group (deleted)", "phone": [], "status": "Archived"}], "customerName": "Abercrombie International Group", "defaultCurrency": "GBP", "id": "66", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "status": "Archived"} + application/json: {"addresses": [{"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"address": {"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}, "name": "Abercrombie International Group (deleted)", "phone": [], "status": "Archived"}], "customerName": "Abercrombie International Group", "defaultCurrency": "GBP", "id": "66", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "status": "Archived"} Sage 200cloud: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "EILBDVJVNUAGVKRQ" responses: "200": - application/json: {"addresses": [{"city": "Blackpool", "country": "", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Delivery"}, {"city": "Manchester", "country": "", "line1": "23a Union Street", "line2": "", "postalCode": "M2 6JK", "region": "", "type": "Delivery"}, {"city": "Blackpool", "country": "Great Britain", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A1 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D001", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2022-04-27T15:17:36Z", "status": "Active", "taxNumber": "GB238 3839 38"} + application/json: {"addresses": [{"city": "Blackpool", "country": "", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Delivery"}, {"city": "Manchester", "country": "", "line1": "23a Union Street", "line2": "", "postalCode": "M2 6JK", "region": "", "type": "Delivery"}, {"city": "Blackpool", "country": "Great Britain", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A1 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D001", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2022-04-27T15:17:36Z", "status": "Active", "taxNumber": "GB238 3839 38"} Sage 50 (UK): parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [{"city": "Blackpool", "country": "GB", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Delivery"}, {"city": "Manchester", "country": "GB", "line1": "23a Union Street", "line2": "", "postalCode": "M2 6JK", "region": "", "type": "Delivery"}, {"city": "Blackpool", "country": "GB", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Unknown"}], "contactName": "Ian Cairns", "contacts": [], "customerName": "A1 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-30T14:42:41Z", "phone": "01742 876 234", "sourceModifiedDate": "2022-11-25T09:43:54Z", "status": "Active", "taxNumber": "GB238 3839 38"} @@ -1241,23 +1291,23 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": - application/json: {"addresses": [{"city": "Aruba City", "country": "Aruba (AW)", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [{"modifiedDate": "2022-10-23T00:00:00Z", "phone": [{"number": "contact mobile number", "type": "Mobile"}, {"number": "contact fax number", "type": "Fax"}], "status": "Unknown"}], "customerName": "100 test name", "defaultCurrency": "GBP", "emailAddress": "email@codat.io", "id": "260f6a3f94a243738f2d5e08496a41a8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-05-10T16:31:51Z", "status": "Active"} + application/json: {"addresses": [{"city": "Aruba City", "country": "Aruba (AW)", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [{"phone": [{"number": "contact mobile number", "type": "Mobile"}, {"number": "contact fax number", "type": "Fax"}], "status": "Unknown"}], "customerName": "100 test name", "defaultCurrency": "GBP", "emailAddress": "email@codat.io", "id": "260f6a3f94a243738f2d5e08496a41a8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-05-10T16:31:51Z", "status": "Active"} Sage Intacct: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": - application/json: {"addresses": [{"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}], "contactName": "Yuna Conn", "contacts": [{"address": {"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Conn, Yuna", "phone": [{"number": "520-393-4468", "type": "Primary"}], "status": "Unknown"}], "customerName": "33Across", "defaultCurrency": "USD", "id": "188", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "520-393-4468", "sourceModifiedDate": "2022-09-06T12:58:27", "status": "Active", "taxNumber": ""} + application/json: {"addresses": [{"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}], "contactName": "Yuna Conn", "contacts": [{"address": {"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}, "name": "Conn, Yuna", "phone": [{"number": "520-393-4468", "type": "Primary"}], "status": "Unknown"}], "customerName": "33Across", "defaultCurrency": "USD", "id": "188", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "520-393-4468", "sourceModifiedDate": "2022-09-06T12:58:27", "status": "Active", "taxNumber": ""} Wave: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [], "contactName": "", "contacts": [], "customerName": "ABC Textiles", "defaultCurrency": "USD", "emailAddress": "c.taylor@codat.io", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2019-10-17T07:59:04Z", "status": "Active"} @@ -1265,7 +1315,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "7110701885" responses: "200": application/json: {"addresses": [], "contacts": [], "customerName": "24 Locks", "defaultCurrency": "USD", "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active"} @@ -1273,15 +1323,15 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "EILBDVJVNUAGVKRQ" responses: "200": - application/json: {"addresses": [], "contactName": "Contact (First Name) Contact (Last Name)", "contacts": [{"email": "contactperson@whateveryouwantidontcare12345.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Contact (First Name) Contact (Last Name)", "phone": [{"number": "Work Phone", "type": "Landline"}, {"number": "Mobile", "type": "Mobile"}], "status": "Active"}], "customerName": "A B", "defaultCurrency": "GBP", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "id": "104957000000032105", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "Work Phone", "sourceModifiedDate": "2022-06-09T14:36:47", "status": "Active"} + application/json: {"addresses": [], "contactName": "Contact (First Name) Contact (Last Name)", "contacts": [{"email": "contactperson@whateveryouwantidontcare12345.com", "name": "Contact (First Name) Contact (Last Name)", "phone": [{"number": "Work Phone", "type": "Landline"}, {"number": "Mobile", "type": "Mobile"}], "status": "Active"}], "customerName": "A B", "defaultCurrency": "GBP", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "id": "104957000000032105", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "Work Phone", "sourceModifiedDate": "2022-06-09T14:36:47", "status": "Active"} Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - customerId: "" + customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} @@ -1310,7 +1360,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Fernandohaven", "country": "United Kingdom", "line1": "Suite 214", "line2": "8439 Lueilwitz Passage", "postalCode": "JG04 7PV", "region": "Northern Ireland", "type": "Delivery"}, {"city": "Juliochester", "country": "United Kingdom", "line1": "Suite 096", "line2": "864 Halie Course", "postalCode": "DZ8 4BF", "region": "England", "type": "Delivery"}, {"city": "Naderborough", "country": "United Kingdom", "line1": "Suite 001", "line2": "416 Stokes Fords", "postalCode": "XG25 0XX", "region": "Wales", "type": "Delivery"}], "contactName": "Werner Langworth", "contacts": [{"address": {"city": "Hortenseville", "country": "United Kingdom", "line1": "Apt. 145", "line2": "317 Williamson Freeway", "postalCode": "CV4 2HR", "region": "Scotland", "type": "Delivery"}, "email": "Werner_Langworth@hotmail.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Werner Langworth", "phone": [], "status": "Active"}, {"address": {"city": "South Ali", "country": "United Kingdom", "line1": "Suite 075", "line2": "9921 Dickens Walk", "postalCode": "TI04 4OO", "region": "Scotland", "type": "Delivery"}, "email": "Belle51@yahoo.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Belle Glover", "phone": [], "status": "Active"}], "customerName": "Arjun Kuvalis", "defaultCurrency": "GBP", "emailAddress": "Arjun34@hotmail.com", "id": "c8180244-74ac-40cf-a5df-6d83661c44d7", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "014605 64820", "registrationNumber": "NI7JEJVM", "sourceModifiedDate": "2022-07-03T01:27:00", "status": "Active", "taxNumber": "7505220209.583549"}, {"addresses": [{"city": "East Khalid", "country": "United Kingdom", "line1": "Apt. 184", "line2": "60578 Louie Springs", "postalCode": "XW89 7NT", "region": "Wales", "type": "Billing"}], "contactName": "Miguel Hahn", "contacts": [{"address": {"city": "Reingerton", "country": "United Kingdom", "line1": "Suite 400", "line2": "21930 Milan Lane", "postalCode": "QG10 2DL", "region": "Wales", "type": "Delivery"}, "email": "Miguel.Hahn@gmail.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Miguel Hahn", "phone": [{"number": "018555 09614", "type": "Landline"}], "status": "Active"}], "customerName": "Breitenberg, Emard and Schiller", "defaultCurrency": "GBP", "emailAddress": "contact@BreitenbergEmardandSchiller.biz", "id": "6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "0800 445 6957", "registrationNumber": "KME0AMIL", "sourceModifiedDate": "2022-12-03T11:05:01", "status": "Archived", "taxNumber": "8560920952.553111"}], "totalResults": 20} + application/json: {"_links": {"current": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Fernandohaven", "country": "United Kingdom", "line1": "Suite 214", "line2": "8439 Lueilwitz Passage", "postalCode": "JG04 7PV", "region": "Northern Ireland", "type": "Delivery"}, {"city": "Juliochester", "country": "United Kingdom", "line1": "Suite 096", "line2": "864 Halie Course", "postalCode": "DZ8 4BF", "region": "England", "type": "Delivery"}, {"city": "Naderborough", "country": "United Kingdom", "line1": "Suite 001", "line2": "416 Stokes Fords", "postalCode": "XG25 0XX", "region": "Wales", "type": "Delivery"}], "contactName": "Werner Langworth", "contacts": [{"address": {"city": "Hortenseville", "country": "United Kingdom", "line1": "Apt. 145", "line2": "317 Williamson Freeway", "postalCode": "CV4 2HR", "region": "Scotland", "type": "Delivery"}, "email": "Werner_Langworth@hotmail.com", "name": "Werner Langworth", "phone": [], "status": "Active"}, {"address": {"city": "South Ali", "country": "United Kingdom", "line1": "Suite 075", "line2": "9921 Dickens Walk", "postalCode": "TI04 4OO", "region": "Scotland", "type": "Delivery"}, "email": "Belle51@yahoo.com", "name": "Belle Glover", "phone": [], "status": "Active"}], "customerName": "Arjun Kuvalis", "defaultCurrency": "GBP", "emailAddress": "Arjun34@hotmail.com", "id": "c8180244-74ac-40cf-a5df-6d83661c44d7", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "014605 64820", "registrationNumber": "NI7JEJVM", "sourceModifiedDate": "2022-07-03T01:27:00", "status": "Active", "taxNumber": "7505220209.583549"}, {"addresses": [{"city": "East Khalid", "country": "United Kingdom", "line1": "Apt. 184", "line2": "60578 Louie Springs", "postalCode": "XW89 7NT", "region": "Wales", "type": "Billing"}], "contactName": "Miguel Hahn", "contacts": [{"address": {"city": "Reingerton", "country": "United Kingdom", "line1": "Suite 400", "line2": "21930 Milan Lane", "postalCode": "QG10 2DL", "region": "Wales", "type": "Delivery"}, "email": "Miguel.Hahn@gmail.com", "name": "Miguel Hahn", "phone": [{"number": "018555 09614", "type": "Landline"}], "status": "Active"}], "customerName": "Breitenberg, Emard and Schiller", "defaultCurrency": "GBP", "emailAddress": "contact@BreitenbergEmardandSchiller.biz", "id": "6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T12:38:16Z", "phone": "0800 445 6957", "registrationNumber": "KME0AMIL", "sourceModifiedDate": "2022-12-03T11:05:01", "status": "Archived", "taxNumber": "8560920952.553111"}], "totalResults": 20} Dynamics 365 Business Central: parameters: path: @@ -1322,7 +1372,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0e2f7751-7696-ed11-bff5-6045bd0d2ad6", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2023-01-17T14:50:54Z", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "", "country": "GB", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "GB", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0ef95175-48c4-eb11-9f0a-0022481b4343", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2021-06-03T08:48:36Z", "status": "Active", "taxNumber": ""}], "totalResults": 42} + application/json: {"_links": {"current": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0e2f7751-7696-ed11-bff5-6045bd0d2ad6", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2023-01-17T14:50:54Z", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "", "country": "GB", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "contacts": [{"address": {"city": "", "country": "GB", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}, "email": "", "name": "", "phone": [], "status": "Active"}], "customerName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "0ef95175-48c4-eb11-9f0a-0022481b4343", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:25Z", "phone": "", "sourceModifiedDate": "2021-06-03T08:48:36Z", "status": "Active", "taxNumber": ""}], "totalResults": 42} Exact (Netherlands): parameters: path: @@ -1358,7 +1408,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "defaultCurrency": "GBP", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "status": "Active"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "defaultCurrency": "GBP", "id": "9677150", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-24T06:19:23Z", "status": "Active"}], "totalResults": 159} + application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-17T06:02:46Z", "status": "Active"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}, "name": "Test 1", "phone": [], "status": "Unknown"}], "customerName": "-", "id": "9677150", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:12Z", "sourceModifiedDate": "2023-04-24T06:19:23Z", "status": "Active"}], "totalResults": 159} FreshBooks: parameters: path: @@ -1370,7 +1420,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test14A@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test14B@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person2", "phone": [{"number": "1234 56789", "type": "Primary"}, {"number": "9876 54321", "type": "Unknown"}], "status": "Active"}, {"email": "test14@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer 14 (updated)", "defaultCurrency": "GBP", "emailAddress": "test14@example.com", "id": "634509", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-18T09:23:56", "status": "Active"}, {"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test9@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test10@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person2", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "987654321", "type": "Unknown"}], "status": "Active"}, {"email": "test8@example.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer name 2", "defaultCurrency": "GBP", "emailAddress": "test8@example.com", "id": "634486", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-11T11:39:58", "status": "Active"}], "totalResults": 39} + application/json: {"_links": {"current": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test14A@example.com", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test14B@example.com", "name": "test person2", "phone": [{"number": "1234 56789", "type": "Primary"}, {"number": "9876 54321", "type": "Unknown"}], "status": "Active"}, {"email": "test14@example.com", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer 14 (updated)", "defaultCurrency": "GBP", "emailAddress": "test14@example.com", "id": "634509", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-18T09:23:56", "status": "Active"}, {"addresses": [{"city": "Some city", "country": "Country 1", "line1": "Line 1", "line2": "Line 2", "postalCode": "SW1 2JQ", "region": "A region", "type": "Billing"}], "contactName": "test person name", "contacts": [{"email": "test9@example.com", "name": "test person1", "phone": [{"number": "24681012", "type": "Primary"}, {"number": "121086420", "type": "Unknown"}], "status": "Active"}, {"email": "test10@example.com", "name": "test person2", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "987654321", "type": "Unknown"}], "status": "Active"}, {"email": "test8@example.com", "name": "test person name", "phone": [{"number": "01876 541245", "type": "Unknown"}], "status": "Active"}], "customerName": "A test customer name 2", "defaultCurrency": "GBP", "emailAddress": "test8@example.com", "id": "634486", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:23Z", "phone": "01876 541245", "sourceModifiedDate": "2022-05-11T11:39:58", "status": "Active"}], "totalResults": 39} KashFlow: parameters: path: @@ -1382,7 +1432,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "contacts": [{"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "", "phone": [], "status": "Active"}], "customerName": "Chekko Customer Test 01", "defaultCurrency": "GBP", "emailAddress": "", "id": "92227673", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "", "sourceModifiedDate": "0001-01-01T00:00:00", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "Billing line 4", "country": "United Kingdom", "line1": "Billing Address", "line2": "Billing line 2 Billing line 3", "postalCode": "123321", "type": "Billing"}, {"city": "Delivery line4", "country": "United Kingdom", "line1": "Delivery Address", "line2": "Delivery line2 Delivery line3", "postalCode": "123321", "type": "Delivery"}], "contactName": "Mr Diogo Sousa", "contacts": [{"address": {"city": "Billing line 4", "country": "United Kingdom", "line1": "Billing Address", "line2": "Billing line 2 Billing line 3", "postalCode": "123321", "type": "Billing"}, "email": "diogomail@mail.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Mr Diogo Sousa", "phone": [{"number": "123123123", "type": "Landline"}, {"number": "321321321", "type": "Mobile"}], "status": "Active"}, {"address": {"city": "Delivery line4", "country": "United Kingdom", "line1": "Delivery Address", "line2": "Delivery line2 Delivery line3", "postalCode": "123321", "type": "Delivery"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Mr Diogo Sousa", "phone": [], "status": "Active"}], "customerName": "Diogo Sousa", "defaultCurrency": "EUR", "emailAddress": "diogomail@mail.com", "id": "88459410", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "123123123", "sourceModifiedDate": "2021-05-04T13:22:19", "status": "Active", "taxNumber": ""}], "totalResults": 10} + application/json: {"_links": {"current": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "contacts": [{"email": "", "name": "", "phone": [], "status": "Active"}], "customerName": "Chekko Customer Test 01", "emailAddress": "", "id": "92227673", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "", "sourceModifiedDate": "0001-01-01T00:00:00", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "Billing line 4", "country": "United Kingdom", "line1": "Billing Address", "line2": "Billing line 2 Billing line 3", "postalCode": "123321", "type": "Billing"}, {"city": "Delivery line4", "country": "United Kingdom", "line1": "Delivery Address", "line2": "Delivery line2 Delivery line3", "postalCode": "123321", "type": "Delivery"}], "contactName": "Mr Diogo Sousa", "contacts": [{"address": {"city": "Billing line 4", "country": "United Kingdom", "line1": "Billing Address", "line2": "Billing line 2 Billing line 3", "postalCode": "123321", "type": "Billing"}, "email": "diogomail@mail.com", "name": "Mr Diogo Sousa", "phone": [{"number": "123123123", "type": "Landline"}, {"number": "321321321", "type": "Mobile"}], "status": "Active"}, {"address": {"city": "Delivery line4", "country": "United Kingdom", "line1": "Delivery Address", "line2": "Delivery line2 Delivery line3", "postalCode": "123321", "type": "Delivery"}, "name": "Mr Diogo Sousa", "phone": [], "status": "Active"}], "customerName": "Diogo Sousa", "emailAddress": "diogomail@mail.com", "id": "88459410", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "123123123", "sourceModifiedDate": "2021-05-04T13:22:19", "status": "Active", "taxNumber": ""}], "totalResults": 10} Oracle NetSuite: parameters: path: @@ -1406,7 +1456,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Delivery"}, {"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"email": "kristy@samplename.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abercrombie, Kristy", "phone": [{"number": "415-555-6579", "type": "Primary"}], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Kristy Abercrombie", "phone": [], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Steve Darcangelo", "phone": [], "status": "Active"}], "customerName": "Abercrombie, Kristy", "defaultCurrency": "GBP", "emailAddress": "kristy@samplename.com", "id": "150000-933272658", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "415-555-6579", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"}, {"addresses": [{"city": "Millbrae", "line1": "Robert Allard", "line2": "92834 Chandler St.", "postalCode": "94030", "region": "CA", "type": "Delivery"}, {"city": "Millbrae", "line1": "Robert Allard", "line2": "92834 Chandler St.", "postalCode": "94030", "region": "CA", "type": "Billing"}], "contactName": "Amanda Roberts", "contacts": [{"email": "rallard@myemail.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Allard, Robert", "phone": [{"number": "650-555-3422", "type": "Primary"}, {"number": "650-555-9804", "type": "Fax"}, {"number": "650-555-8349", "type": "Unknown"}], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Robert Allard", "phone": [], "status": "Active"}, {"modifiedDate": "2022-10-23T00:00:00Z", "name": "Rachel Fisher", "phone": [], "status": "Active"}], "customerName": "Allard, Robert", "defaultCurrency": "GBP", "emailAddress": "rallard@myemail.com", "id": "800000D0-1182061376", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "650-555-3422", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"}], "totalResults": 64} + application/json: {"_links": {"current": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Delivery"}, {"city": "Bayshore", "line1": "Kristy Abercrombie", "line2": "5647 Cypress Hill Rd", "postalCode": "94326", "region": "CA", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"email": "kristy@samplename.com", "name": "Abercrombie, Kristy", "phone": [{"number": "415-555-6579", "type": "Primary"}], "status": "Active"}, {"name": "Kristy Abercrombie", "phone": [], "status": "Active"}, {"name": "Steve Darcangelo", "phone": [], "status": "Active"}], "customerName": "Abercrombie, Kristy", "defaultCurrency": "GBP", "emailAddress": "kristy@samplename.com", "id": "150000-933272658", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "415-555-6579", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"}, {"addresses": [{"city": "Millbrae", "line1": "Robert Allard", "line2": "92834 Chandler St.", "postalCode": "94030", "region": "CA", "type": "Delivery"}, {"city": "Millbrae", "line1": "Robert Allard", "line2": "92834 Chandler St.", "postalCode": "94030", "region": "CA", "type": "Billing"}], "contactName": "Amanda Roberts", "contacts": [{"email": "rallard@myemail.com", "name": "Allard, Robert", "phone": [{"number": "650-555-3422", "type": "Primary"}, {"number": "650-555-9804", "type": "Fax"}, {"number": "650-555-8349", "type": "Unknown"}], "status": "Active"}, {"name": "Robert Allard", "phone": [], "status": "Active"}, {"name": "Rachel Fisher", "phone": [], "status": "Active"}], "customerName": "Allard, Robert", "defaultCurrency": "GBP", "emailAddress": "rallard@myemail.com", "id": "800000D0-1182061376", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:07:55Z", "phone": "650-555-3422", "sourceModifiedDate": "2023-12-16T05:06:42", "status": "Active"}], "totalResults": 64} QuickBooks Online: parameters: path: @@ -1418,7 +1468,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "Abraham's Company", "contacts": [{"email": "ab@email.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abe", "phone": [{"number": "01111111111", "type": "Mobile"}], "status": "Active"}], "customerName": "Abe", "defaultCurrency": "GBP", "emailAddress": "ab@email.com", "id": "9", "modifiedDate": "2023-01-18T11:02:35Z", "registrationNumber": "XXXX9900001", "sourceModifiedDate": "2022-12-08T15:42:59Z", "status": "Active", "taxNumber": "XXXX9900001"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Billing"}, {"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Delivery"}], "contactName": "Adeel test", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Billing"}, "email": "adeel@adeel.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Adeel test", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "07546543216", "type": "Mobile"}], "status": "Active"}], "customerName": "adeel qbo child test", "defaultCurrency": "GBP", "emailAddress": "adeel@adeel.com", "id": "49", "modifiedDate": "2023-01-18T11:02:35Z", "phone": "123456789", "sourceModifiedDate": "2022-08-22T09:21:09Z", "status": "Active"}], "totalResults": 40} + application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "Abraham's Company", "contacts": [{"email": "ab@email.com", "name": "Abe", "phone": [{"number": "01111111111", "type": "Mobile"}], "status": "Active"}], "customerName": "Abe", "defaultCurrency": "GBP", "emailAddress": "ab@email.com", "id": "9", "modifiedDate": "2023-01-18T11:02:35Z", "registrationNumber": "XXXX9900001", "sourceModifiedDate": "2022-12-08T15:42:59Z", "status": "Active", "taxNumber": "XXXX9900001"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Billing"}, {"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Delivery"}], "contactName": "Adeel test", "contacts": [{"address": {"city": "London", "country": "United Kingdom", "line1": "4 Privet Drive", "postalCode": "WD25 7LR", "type": "Billing"}, "email": "adeel@adeel.com", "name": "Adeel test", "phone": [{"number": "123456789", "type": "Primary"}, {"number": "07546543216", "type": "Mobile"}], "status": "Active"}], "customerName": "adeel qbo child test", "defaultCurrency": "GBP", "emailAddress": "adeel@adeel.com", "id": "49", "modifiedDate": "2023-01-18T11:02:35Z", "phone": "123456789", "sourceModifiedDate": "2022-08-22T09:21:09Z", "status": "Active"}], "totalResults": 40} QuickBooks Online Sandbox: parameters: path: @@ -1430,7 +1480,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"address": {"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abercrombie International Group (deleted)", "phone": [], "status": "Archived"}], "customerName": "Abercrombie International Group", "defaultCurrency": "GBP", "id": "66", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "status": "Archived"}, {"addresses": [{"type": "Billing"}, {"type": "Delivery"}], "contactName": "Natalie Watts", "contacts": [{"address": {"type": "Billing"}, "email": "n.watts@google.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Abercrombie International Group", "phone": [], "status": "Active"}], "customerName": "Abercrombie International Group", "defaultCurrency": "USD", "emailAddress": "n.watts@google.com", "id": "67", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "registrationNumber": "XXXXVat123456", "sourceModifiedDate": "2023-03-29T01:12:55Z", "status": "Active", "taxNumber": "XXXXVat123456"}], "totalResults": 243} + application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}], "contactName": "Kristy Abercrombie", "contacts": [{"address": {"city": "New York, NY", "line1": "123 Main St", "type": "Billing"}, "name": "Abercrombie International Group (deleted)", "phone": [], "status": "Archived"}], "customerName": "Abercrombie International Group", "defaultCurrency": "GBP", "id": "66", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "status": "Archived"}, {"addresses": [{"type": "Billing"}, {"type": "Delivery"}], "contactName": "Natalie Watts", "contacts": [{"address": {"type": "Billing"}, "email": "n.watts@google.com", "name": "Abercrombie International Group", "phone": [], "status": "Active"}], "customerName": "Abercrombie International Group", "defaultCurrency": "USD", "emailAddress": "n.watts@google.com", "id": "67", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:56Z", "registrationNumber": "XXXXVat123456", "sourceModifiedDate": "2023-03-29T01:12:55Z", "status": "Active", "taxNumber": "XXXXVat123456"}], "totalResults": 243} Sage 200cloud: parameters: path: @@ -1442,7 +1492,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Blackpool", "country": "", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Delivery"}, {"city": "Manchester", "country": "", "line1": "23a Union Street", "line2": "", "postalCode": "M2 6JK", "region": "", "type": "Delivery"}, {"city": "Blackpool", "country": "Great Britain", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A1 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D001", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2022-04-27T15:17:36Z", "status": "Active", "taxNumber": "GB238 3839 38"}, {"addresses": [{"city": "Blackpool", "country": "Great Britain", "line1": "77a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A2 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D002", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2020-09-23T10:28:58Z", "status": "Active", "taxNumber": "GB238 3839 40"}], "totalResults": 43} + application/json: {"_links": {"current": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Blackpool", "country": "", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Delivery"}, {"city": "Manchester", "country": "", "line1": "23a Union Street", "line2": "", "postalCode": "M2 6JK", "region": "", "type": "Delivery"}, {"city": "Blackpool", "country": "Great Britain", "line1": "67a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A1 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D001", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2022-04-27T15:17:36Z", "status": "Active", "taxNumber": "GB238 3839 38"}, {"addresses": [{"city": "Blackpool", "country": "Great Britain", "line1": "77a Station Road", "line2": "", "postalCode": "BP12 7HT", "region": "Lancashire", "type": "Billing"}], "contactName": "Lee Dalkin", "contacts": [{"email": "newbusinessadvice@sage.com", "name": "Lee Dalkin", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Landline"}, {"number": "01742 876 236", "type": "Fax"}], "status": "Active"}, {"email": "", "name": "Malcolm Leverret", "phone": [], "status": "Active"}, {"email": "Jim@a1designservices.co.uk", "name": "Jim Thomas", "phone": [{"number": "01742 876 234", "type": "Landline"}, {"number": "01742 876 235", "type": "Fax"}], "status": "Active"}, {"email": "Jullian@a1designservices.co.uk", "name": "Jullian Plawsworth", "phone": [{"number": "0151 349 3939", "type": "Landline"}, {"number": "0151 349 3940", "type": "Fax"}], "status": "Active"}], "customerName": "A2 Design Services", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "A1D002", "modifiedDate": "2022-10-14T09:35:53Z", "phone": "01742 876 234", "registrationNumber": "", "sourceModifiedDate": "2020-09-23T10:28:58Z", "status": "Active", "taxNumber": "GB238 3839 40"}], "totalResults": 43} Sage 50 (UK): parameters: path: @@ -1466,7 +1516,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Aruba City", "country": "Aruba (AW)", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [{"modifiedDate": "2022-10-23T00:00:00Z", "phone": [{"number": "contact mobile number", "type": "Mobile"}, {"number": "contact fax number", "type": "Fax"}], "status": "Unknown"}], "customerName": "100 test name", "defaultCurrency": "GBP", "emailAddress": "email@codat.io", "id": "260f6a3f94a243738f2d5e08496a41a8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-05-10T16:31:51Z", "status": "Active"}, {"addresses": [{"city": "POST - Aruba City", "country": "Aruba (AW)", "line1": "POST - Aruba Address line 1", "line2": "POST - Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [], "customerName": "100 test name DS", "defaultCurrency": "GBP", "emailAddress": "DCemail@codat.io", "id": "44a5d9461d9e4f6d90a5ace251c5cf35", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-06-10T14:22:46Z", "status": "Active"}], "totalResults": 168} + application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Aruba City", "country": "Aruba (AW)", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [{"phone": [{"number": "contact mobile number", "type": "Mobile"}, {"number": "contact fax number", "type": "Fax"}], "status": "Unknown"}], "customerName": "100 test name", "defaultCurrency": "GBP", "emailAddress": "email@codat.io", "id": "260f6a3f94a243738f2d5e08496a41a8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-05-10T16:31:51Z", "status": "Active"}, {"addresses": [{"city": "POST - Aruba City", "country": "Aruba (AW)", "line1": "POST - Aruba Address line 1", "line2": "POST - Aruba Address line 2", "postalCode": "Aruba Post", "region": "Aruba Province", "type": "Billing"}], "contactName": "Main Contact", "contacts": [], "customerName": "100 test name DS", "defaultCurrency": "GBP", "emailAddress": "DCemail@codat.io", "id": "44a5d9461d9e4f6d90a5ace251c5cf35", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "contact phone number", "sourceModifiedDate": "2021-06-10T14:22:46Z", "status": "Active"}], "totalResults": 168} Sage Intacct: parameters: path: @@ -1478,7 +1528,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}], "contactName": "Yuna Conn", "contacts": [{"address": {"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "Conn, Yuna", "phone": [{"number": "520-393-4468", "type": "Primary"}], "status": "Unknown"}], "customerName": "33Across", "defaultCurrency": "USD", "id": "188", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "520-393-4468", "sourceModifiedDate": "2022-09-06T12:58:27", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "Sparwood", "country": "Canada", "line1": "7 Lerdahl Junction", "line2": "", "postalCode": "L4R", "region": "British Columbia", "type": "Unknown"}], "contactName": "Lauri O'Heagertie", "contacts": [{"address": {"city": "Sparwood", "country": "Canada", "line1": "7 Lerdahl Junction", "line2": "", "postalCode": "L4R", "region": "British Columbia", "type": "Unknown"}, "modifiedDate": "2022-10-23T00:00:00Z", "name": "O'Heagertie, Lauri", "phone": [{"number": "410-309-3976", "type": "Primary"}], "status": "Unknown"}], "customerName": "3Way International Logistics", "defaultCurrency": "CAD", "id": "324", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "410-309-3976", "sourceModifiedDate": "2020-10-20T05:01:49", "status": "Active", "taxNumber": ""}], "totalResults": 530} + application/json: {"_links": {"current": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}], "contactName": "Yuna Conn", "contacts": [{"address": {"city": "Albuquerque", "country": "United States", "line1": "155 Westend Point", "line2": "", "postalCode": "87140", "region": "NM", "type": "Unknown"}, "name": "Conn, Yuna", "phone": [{"number": "520-393-4468", "type": "Primary"}], "status": "Unknown"}], "customerName": "33Across", "defaultCurrency": "USD", "id": "188", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "520-393-4468", "sourceModifiedDate": "2022-09-06T12:58:27", "status": "Active", "taxNumber": ""}, {"addresses": [{"city": "Sparwood", "country": "Canada", "line1": "7 Lerdahl Junction", "line2": "", "postalCode": "L4R", "region": "British Columbia", "type": "Unknown"}], "contactName": "Lauri O'Heagertie", "contacts": [{"address": {"city": "Sparwood", "country": "Canada", "line1": "7 Lerdahl Junction", "line2": "", "postalCode": "L4R", "region": "British Columbia", "type": "Unknown"}, "name": "O'Heagertie, Lauri", "phone": [{"number": "410-309-3976", "type": "Primary"}], "status": "Unknown"}], "customerName": "3Way International Logistics", "defaultCurrency": "CAD", "id": "324", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-04T16:32:21Z", "phone": "410-309-3976", "sourceModifiedDate": "2020-10-20T05:01:49", "status": "Active", "taxNumber": ""}], "totalResults": 530} Wave: parameters: path: @@ -1490,7 +1540,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "contacts": [], "customerName": "ABC Textiles", "defaultCurrency": "USD", "emailAddress": "c.taylor@codat.io", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2019-10-17T07:59:04Z", "status": "Active"}, {"addresses": [{"city": "Coffee City", "country": "United Kingdom", "line1": "11 Coffee Lane", "line2": "Coffee Town", "postalCode": "CC1 1CC", "region": "Hampshire", "type": "Billing"}], "contactName": "Coffee Carl", "contacts": [{"modifiedDate": "2022-10-23T00:00:00Z", "name": "Coffee Carl", "phone": [{"number": "07733", "type": "Mobile"}], "status": "Active"}], "customerName": "Coffee Cart", "defaultCurrency": "GBP", "emailAddress": "coffee.cart@example.com", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2", "modifiedDate": "2022-11-16T18:15:30Z", "phone": "0201111", "sourceModifiedDate": "2020-03-17T19:12:39Z", "status": "Active"}], "totalResults": 10} + application/json: {"_links": {"current": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "contacts": [], "customerName": "ABC Textiles", "defaultCurrency": "USD", "emailAddress": "c.taylor@codat.io", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2019-10-17T07:59:04Z", "status": "Active"}, {"addresses": [{"city": "Coffee City", "country": "United Kingdom", "line1": "11 Coffee Lane", "line2": "Coffee Town", "postalCode": "CC1 1CC", "region": "Hampshire", "type": "Billing"}], "contactName": "Coffee Carl", "contacts": [{"name": "Coffee Carl", "phone": [{"number": "07733", "type": "Mobile"}], "status": "Active"}], "customerName": "Coffee Cart", "defaultCurrency": "GBP", "emailAddress": "coffee.cart@example.com", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2", "modifiedDate": "2022-11-16T18:15:30Z", "phone": "0201111", "sourceModifiedDate": "2020-03-17T19:12:39Z", "status": "Active"}], "totalResults": 10} Xero: parameters: path: @@ -1502,7 +1552,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contacts": [], "customerName": "24 Locks", "defaultCurrency": "USD", "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active"}, {"addresses": [], "contacts": [], "customerName": "7-Eleven", "defaultCurrency": "GBP", "emailAddress": "", "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active"}], "totalResults": 48} + application/json: {"_links": {"current": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contacts": [], "customerName": "24 Locks", "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active"}, {"addresses": [], "contacts": [], "customerName": "7-Eleven", "emailAddress": "", "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active"}], "totalResults": 48} Zoho Books: parameters: path: @@ -1514,7 +1564,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "Contact (First Name) Contact (Last Name)", "contacts": [{"email": "contactperson@whateveryouwantidontcare12345.com", "modifiedDate": "2022-10-23T00:00:00Z", "name": "Contact (First Name) Contact (Last Name)", "phone": [{"number": "Work Phone", "type": "Landline"}, {"number": "Mobile", "type": "Mobile"}], "status": "Active"}], "customerName": "A B", "defaultCurrency": "GBP", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "id": "104957000000032105", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "Work Phone", "sourceModifiedDate": "2022-06-09T14:36:47", "status": "Active"}, {"addresses": [], "contactName": "John Doe", "contacts": [{"email": "", "modifiedDate": "2022-10-23T00:00:00Z", "name": "John Doe", "phone": [], "status": "Active"}], "customerName": "Doe, John", "defaultCurrency": "GBP", "emailAddress": "", "id": "104957000000054050", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-28T15:09:22", "status": "Active"}], "totalResults": 14} + application/json: {"_links": {"current": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2"}, "next": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2"}, "self": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "Contact (First Name) Contact (Last Name)", "contacts": [{"email": "contactperson@whateveryouwantidontcare12345.com", "name": "Contact (First Name) Contact (Last Name)", "phone": [{"number": "Work Phone", "type": "Landline"}, {"number": "Mobile", "type": "Mobile"}], "status": "Active"}], "customerName": "A B", "defaultCurrency": "GBP", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "id": "104957000000032105", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "Work Phone", "sourceModifiedDate": "2022-06-09T14:36:47", "status": "Active"}, {"addresses": [], "contactName": "John Doe", "contacts": [{"email": "", "name": "John Doe", "phone": [], "status": "Active"}], "customerName": "Doe, John", "defaultCurrency": "GBP", "emailAddress": "", "id": "104957000000054050", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-28T15:09:22", "status": "Active"}], "totalResults": 14} Malformed query: parameters: path: @@ -1545,7 +1595,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - customerId: "" + customerId: "EILBDVJVNUAGVKRQ" query: {} requestBody: application/json: {"contacts": [], "defaultCurrency": "EUR", "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Unknown"} @@ -1589,7 +1639,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + supplierId: "7110701885" responses: "200": application/json: {"addresses": [{"city": "", "country": "GB", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Billing"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "78623f13-931e-eb11-bbf8-0022481b3585", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-27T14:21:12Z", "phone": "", "sourceModifiedDate": "2020-11-04T11:44:22Z", "status": "Active", "supplierName": "", "taxNumber": ""} @@ -1605,7 +1655,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "7110701885" responses: "200": application/json: {"addresses": [{"country": "GB", "type": "Billing"}], "defaultCurrency": "GBP", "id": "0185fea2-0298-445b-909a-0db685118a9e", "modifiedDate": "2022-10-26T13:33:13Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2017-08-02T10:58:54Z", "status": "Active", "supplierName": "a"} @@ -1613,7 +1663,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "EILBDVJVNUAGVKRQ" responses: "200": application/json: {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:08Z", "phone": "(877) 492-8687", "sourceModifiedDate": "2023-04-17T06:02:46", "status": "Active", "supplierName": "-"} @@ -1621,7 +1671,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": application/json: {"addresses": [], "id": "api vendor", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:25Z", "phone": "(877) 492-8687", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Active", "supplierName": "api vendor"} @@ -1629,7 +1679,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": application/json: {"addresses": [], "contactName": "", "emailAddress": "", "id": "6202387", "modifiedDate": "2022-09-30T10:29:15Z", "phone": "", "sourceModifiedDate": "2017-05-09T00:00:00", "status": "Unknown", "supplierName": "Dell", "taxNumber": ""} @@ -1637,7 +1687,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "200": application/json: {"addresses": [], "contactName": "Test Vendor", "defaultCurrency": "GBP", "emailAddress": "", "id": "779", "modifiedDate": "2023-01-30T14:47:02Z", "phone": "", "sourceModifiedDate": "2022-02-04T14:24:43", "status": "Active", "supplierName": "Test Vendor"} @@ -1645,7 +1695,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [{"city": "Berkeley", "line1": "A Cheung Limited, Angela Cheung", "line2": "3818 Bear Rd. West", "postalCode": "94688", "region": "CA", "type": "Billing"}], "contactName": "Angela Cheung", "defaultCurrency": "GBP", "emailAddress": "AC@CheungLimited.com", "id": "A60000-1197760912", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:09:03Z", "phone": "510 555 5723", "sourceModifiedDate": "2023-12-16T05:06:44", "status": "Active", "supplierName": "A Cheung Limited"} @@ -1669,7 +1719,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "7110701885" + supplierId: "EILBDVJVNUAGVKRQ" responses: "200": application/json: {"addresses": [{"city": "", "country": "Great Britain", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Unknown"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "776", "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-14T09:35:58Z", "phone": "", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Archived", "supplierName": "Aaren", "taxNumber": ""} @@ -1677,7 +1727,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [{"city": "Newcastle Upon Tyne", "country": "GB", "line1": "66 New Street", "line2": "Ridgeway", "postalCode": "NE1 4GF", "region": "", "type": "Delivery"}, {"city": "Newcastle upon Tyne", "country": "GB", "line1": "66 New Street", "line2": "Ridgeway", "postalCode": "NE1 4GF", "region": "", "type": "Unknown"}], "contactName": "Mark Ramsay", "defaultCurrency": "GBP", "emailAddress": "newbusinessadvice@sage.com", "id": "CON001", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-30T14:42:38Z", "phone": "0191 643 4343", "sourceModifiedDate": "2022-11-25T09:43:54Z", "status": "Active", "supplierName": "Concept Stationery Supplies", "taxNumber": "GB988 3453 23"} @@ -1685,7 +1735,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [{"country": "United Kingdom (GB)", "type": "Billing"}], "contactName": "Main Contact", "defaultCurrency": "GBP", "id": "65179671e9ef424caff8b9006cd111c8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "01224 658 999", "sourceModifiedDate": "2020-02-25T17:23:33Z", "status": "Active", "supplierName": "5555 Abdul's Test Name"} @@ -1701,7 +1751,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" responses: "200": application/json: {"addresses": [], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "modifiedDate": "2022-11-16T18:15:24Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2020-04-07T13:28:02Z", "status": "Active", "supplierName": "Computer Shop"} @@ -1709,7 +1759,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + supplierId: "7110701885" responses: "200": application/json: {"addresses": [], "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:36:09Z", "phone": "(877) 492-8687", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active", "supplierName": "24 Locks"} @@ -1717,7 +1767,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + supplierId: "EILBDVJVNUAGVKRQ" responses: "200": application/json: {"addresses": [], "defaultCurrency": "GBP", "emailAddress": "", "id": "104957000001494001", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2022-09-16T13:09:56", "status": "Active", "supplierName": "Acme Corporation"} @@ -1725,7 +1775,7 @@ examples: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" - supplierId: "EILBDVJVNUAGVKRQ" + supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} @@ -1790,7 +1840,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "GB", "type": "Billing"}], "defaultCurrency": "GBP", "id": "0185fea2-0298-445b-909a-0db685118a9e", "modifiedDate": "2022-10-26T13:33:13Z", "phone": "01224 658 999", "sourceModifiedDate": "2017-08-02T10:58:54Z", "status": "Active", "supplierName": "a"}, {"addresses": [{"country": "GB", "type": "Billing"}], "defaultCurrency": "GBP", "id": "64ae712f-4155-48bb-9fce-98232c51d979", "modifiedDate": "2022-10-26T13:33:13Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2020-05-01T14:05:46Z", "status": "Active", "supplierName": "aa"}], "totalResults": 118} + application/json: {"_links": {"current": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "GB", "type": "Billing"}], "defaultCurrency": "GBP", "id": "0185fea2-0298-445b-909a-0db685118a9e", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-08-02T10:58:54Z", "status": "Active", "supplierName": "a"}, {"addresses": [{"country": "GB", "type": "Billing"}], "defaultCurrency": "GBP", "id": "64ae712f-4155-48bb-9fce-98232c51d979", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2020-05-01T14:05:46Z", "status": "Active", "supplierName": "aa"}], "totalResults": 118} FreeAgent: parameters: path: @@ -1802,7 +1852,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:08Z", "phone": "(877) 492-8687", "sourceModifiedDate": "2023-04-17T06:02:46", "status": "Active", "supplierName": "-"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "id": "9677150", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:08Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2023-04-24T06:19:23", "status": "Active", "supplierName": "-"}], "totalResults": 159} + application/json: {"_links": {"current": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "id": "11526230", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-17T06:02:46", "status": "Active", "supplierName": "-"}, {"addresses": [{"city": "London", "country": "United Kingdom", "line1": "1 Place House", "line2": "", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Test 1", "id": "9677150", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-24T06:19:23", "status": "Active", "supplierName": "-"}], "totalResults": 159} FreshBooks: parameters: path: @@ -1814,7 +1864,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "id": "api vendor", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:25Z", "phone": "01224 658 999", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Active", "supplierName": "api vendor"}, {"addresses": [], "id": "DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA==", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:25Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Active", "supplierName": "Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez"}], "totalResults": 7} + application/json: {"_links": {"current": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "id": "api vendor", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:25Z", "status": "Active", "supplierName": "api vendor"}, {"addresses": [], "id": "DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA==", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-24T16:07:25Z", "status": "Active", "supplierName": "Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez"}], "totalResults": 7} KashFlow: parameters: path: @@ -1862,7 +1912,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "Djibouti", "line1": "test", "region": "string", "type": "Billing"}], "contactName": "AI Support", "defaultCurrency": "GBP", "id": "41", "modifiedDate": "2023-01-18T11:02:36Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2022-12-07T10:48:18Z", "status": "Active", "supplierName": "AI Support"}, {"addresses": [{"country": "DJ", "line1": "test", "region": "string", "type": "Billing"}], "contactName": "AI Support 2", "defaultCurrency": "GBP", "id": "42", "modifiedDate": "2023-01-18T11:02:36Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2021-08-31T08:45:02Z", "status": "Active", "supplierName": "AI Support 2"}], "totalResults": 23} + application/json: {"_links": {"current": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "Djibouti", "line1": "test", "region": "string", "type": "Billing"}], "contactName": "AI Support", "defaultCurrency": "GBP", "id": "41", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2022-12-07T10:48:18Z", "status": "Active", "supplierName": "AI Support"}, {"addresses": [{"country": "DJ", "line1": "test", "region": "string", "type": "Billing"}], "contactName": "AI Support 2", "defaultCurrency": "GBP", "id": "42", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2021-08-31T08:45:02Z", "status": "Active", "supplierName": "AI Support 2"}], "totalResults": 23} QuickBooks Online Sandbox: parameters: path: @@ -1874,7 +1924,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "England", "line1": "100 London Road", "line2": "Angel", "postalCode": "EC1M", "region": "Greater London", "type": "Billing"}], "contactName": "Miss Smith", "defaultCurrency": "GBP", "id": "129", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:55Z", "phone": "0728 38474", "sourceModifiedDate": "2023-04-13T01:51:08Z", "status": "Active", "supplierName": "Ally Johnson"}, {"addresses": [], "defaultCurrency": "GBP", "id": "88", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:55Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2022-07-06T15:55:28Z", "status": "Active", "supplierName": "Andrew Haberbosch"}], "totalResults": 64} + application/json: {"_links": {"current": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "London", "country": "England", "line1": "100 London Road", "line2": "Angel", "postalCode": "EC1M", "region": "Greater London", "type": "Billing"}], "contactName": "Miss Smith", "defaultCurrency": "GBP", "id": "129", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:55Z", "phone": "0728 38474", "sourceModifiedDate": "2023-04-13T01:51:08Z", "status": "Active", "supplierName": "Ally Johnson"}, {"addresses": [], "defaultCurrency": "GBP", "id": "88", "metadata": {"isDeleted": false}, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2022-07-06T15:55:28Z", "status": "Active", "supplierName": "Andrew Haberbosch"}], "totalResults": 64} Sage 200cloud: parameters: path: @@ -1886,7 +1936,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "", "country": "Great Britain", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Unknown"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "776", "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-14T09:35:58Z", "phone": "", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Archived", "supplierName": "Aaren", "taxNumber": ""}, {"addresses": [{"city": "", "country": "Great Britain", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Unknown"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "914", "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-14T09:35:58Z", "phone": "", "sourceModifiedDate": "2022-10-23T00:00:00Z", "status": "Archived", "supplierName": "Aaren", "taxNumber": ""}], "totalResults": 943} + application/json: {"_links": {"current": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"city": "", "country": "Great Britain", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Unknown"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "776", "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-14T09:35:58Z", "phone": "", "status": "Archived", "supplierName": "Aaren", "taxNumber": ""}, {"addresses": [{"city": "", "country": "Great Britain", "line1": "", "line2": "", "postalCode": "", "region": "", "type": "Unknown"}], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "914", "metadata": {"isDeleted": true}, "modifiedDate": "2022-10-14T09:35:58Z", "phone": "", "status": "Archived", "supplierName": "Aaren", "taxNumber": ""}], "totalResults": 943} Sage 50 (UK): parameters: path: @@ -1910,7 +1960,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "United Kingdom (GB)", "type": "Billing"}], "contactName": "Main Contact", "defaultCurrency": "GBP", "id": "65179671e9ef424caff8b9006cd111c8", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "01224 658 999", "sourceModifiedDate": "2020-02-25T17:23:33Z", "status": "Active", "supplierName": "5555 Abdul's Test Name"}, {"addresses": [{"city": "London", "country": "United Kingdom (GB)", "line1": "1 Place House", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Abdi", "defaultCurrency": "GBP", "emailAddress": "abdisupplier@company.com", "id": "cf7f44d693904944a6a7cf3de0887964", "modifiedDate": "2022-10-24T14:52:54Z", "phone": "(877) 492-8687", "sourceModifiedDate": "2020-02-13T10:38:19Z", "status": "Active", "supplierName": "Abdi Supplier"}], "totalResults": 64} + application/json: {"_links": {"current": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [{"country": "United Kingdom (GB)", "type": "Billing"}], "contactName": "Main Contact", "defaultCurrency": "GBP", "id": "65179671e9ef424caff8b9006cd111c8", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-25T17:23:33Z", "status": "Active", "supplierName": "5555 Abdul's Test Name"}, {"addresses": [{"city": "London", "country": "United Kingdom (GB)", "line1": "1 Place House", "postalCode": "WC1X 1AH", "type": "Billing"}], "contactName": "Abdi", "defaultCurrency": "GBP", "emailAddress": "abdisupplier@company.com", "id": "cf7f44d693904944a6a7cf3de0887964", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-13T10:38:19Z", "status": "Active", "supplierName": "Abdi Supplier"}], "totalResults": 64} Sage Intacct: parameters: path: @@ -1934,7 +1984,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "modifiedDate": "2022-11-16T18:15:24Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2020-04-07T13:28:02Z", "status": "Active", "supplierName": "Computer Shop"}, {"addresses": [], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx", "modifiedDate": "2022-11-16T18:15:24Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2020-04-07T13:12:40Z", "status": "Active", "supplierName": "Flour Mill"}], "totalResults": 9} + application/json: {"_links": {"current": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:28:02Z", "status": "Active", "supplierName": "Computer Shop"}, {"addresses": [], "contactName": "", "defaultCurrency": "GBP", "emailAddress": "", "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx", "modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:12:40Z", "status": "Active", "supplierName": "Flour Mill"}], "totalResults": 9} Xero: parameters: path: @@ -1946,7 +1996,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:36:09Z", "phone": "01224 658 999", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active", "supplierName": "24 Locks"}, {"addresses": [], "emailAddress": "", "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:36:09Z", "phone": "01224 658 999", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active", "supplierName": "7-Eleven"}], "totalResults": 48} + application/json: {"_links": {"current": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "emailAddress": "", "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active", "supplierName": "24 Locks"}, {"addresses": [], "emailAddress": "", "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "metadata": {"isDeleted": false}, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "status": "Active", "supplierName": "7-Eleven"}], "totalResults": 48} Zoho Books: parameters: path: @@ -1958,7 +2008,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "defaultCurrency": "GBP", "emailAddress": "", "id": "104957000001494001", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "01224 658 999", "sourceModifiedDate": "2022-09-16T13:09:56", "status": "Active", "supplierName": "Acme Corporation"}, {"addresses": [], "contactName": "Dre", "defaultCurrency": "CAD", "emailAddress": "", "id": "104957000000648001", "modifiedDate": "2022-10-03T08:40:37Z", "phone": "+44 25691 154789", "sourceModifiedDate": "2022-06-10T09:07:16", "status": "Active", "supplierName": "Cool company"}], "totalResults": 6} + application/json: {"_links": {"current": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2"}, "next": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2"}, "self": {"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers"}}, "pageNumber": 1, "pageSize": 2, "results": [{"addresses": [], "defaultCurrency": "GBP", "emailAddress": "", "id": "104957000001494001", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-16T13:09:56", "status": "Active", "supplierName": "Acme Corporation"}, {"addresses": [], "contactName": "Dre", "defaultCurrency": "CAD", "emailAddress": "", "id": "104957000000648001", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-10T09:07:16", "status": "Active", "supplierName": "Cool company"}], "totalResults": 6} Malformed query: parameters: path: @@ -2045,7 +2095,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2"}, "next": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2"}, "self": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history"}}, "pageNumber": 0, "pageSize": 0, "results": [{"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "completed": "2022-10-23T00:00:00Z", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "isCompleted": false, "isErrored": false, "progress": 10, "requested": "2022-11-14T11:18:37.2798351Z", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z"}], "totalResults": 0} + application/json: {"_links": {"current": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2"}, "next": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2"}, "self": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history"}}, "pageNumber": 0, "pageSize": 0, "results": [{"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "isCompleted": false, "isErrored": false, "progress": 10, "requested": "2022-11-14T11:18:37.2798351Z", "status": "Initial"}], "totalResults": 0} Malformed query: parameters: path: @@ -2141,7 +2191,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"currency": "USD", "currencyRate": 1, "date": "2024-05-21T00:00:00+00:00", "id": "3357b3df-5f2e-465d-b9ba-226519dbb8f1", "lines": [{"accountRef": {"id": "80000018-1671793811"}, "amount": 50, "description": "debit line", "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "80000003-1674553958"}]}, {"accountRef": {"id": "80000028-1671794219"}, "amount": -50, "description": "credit line", "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "80000003-1674553958"}]}], "reference": "test reference"}] + application/json: [{"currency": "USD", "currencyRate": 1, "date": "2024-05-21T00:00:00+00:00", "id": "3357b3df-5f2e-465d-b9ba-226519dbb8f1", "lines": [{"accountRef": {"id": "80000018-1671793811"}, "amount": 50, "description": "debit line", "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "80000003-1674553958"}]}, {"accountRef": {"id": "80000028-1671794219"}, "amount": -50, "description": "credit line", "trackingRefs": [{"dataType": "trackingCategories", "id": "80000003-1674553958"}]}], "reference": "test reference"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -2188,7 +2238,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "currencyRate": 1, "id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "issueDate": "2024-05-21T00:00:00+00:00", "lines": [{"accountRef": {"id": "35"}, "invoiceTo": {"id": "504", "type": "customer"}, "itemRef": {"id": "80000002-1675158984"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Payment"}] + application/json: [{"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "currencyRate": 1, "id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "issueDate": "2024-05-21T00:00:00+00:00", "lines": [{"accountRef": {"id": "35"}, "invoiceTo": {"id": "504", "type": "customer"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Payment"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -2198,7 +2248,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "id": "7008d3f2-aeb4-11ed-afa1-0242ac120002", "issueDate": "2024-02-17T00:00:00+00:00", "lines": [{"accountRef": {"id": "42"}, "invoiceTo": {"id": "80000002-1674552702", "type": "customer"}, "itemRef": {"id": "80000002-1675158984"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_6"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Refund"}] + application/json: [{"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "id": "7008d3f2-aeb4-11ed-afa1-0242ac120002", "issueDate": "2024-02-17T00:00:00+00:00", "lines": [{"accountRef": {"id": "42"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"id": "DEPARTMENT_6"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Refund"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -2228,7 +2278,7 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "currencyRate": 1, "issueDate": "2024-05-21T00:00:00+00:00", "lines": [{"accountRef": {"id": "35"}, "invoiceTo": {"id": "504", "type": "customer"}, "itemRef": {"id": "80000002-1675158984"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Payment"} + application/json: {"bankAccountRef": {"id": "97"}, "contactRef": {"id": "430", "type": "Supplier"}, "currency": "GBP", "currencyRate": 1, "issueDate": "2024-05-21T00:00:00+00:00", "lines": [{"accountRef": {"id": "35"}, "invoiceTo": {"id": "504", "type": "customer"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "merchantName": "Amazon UK", "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "type": "Payment"} Malformed query: parameters: path: @@ -2253,7 +2303,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: [{"contactRef": {"id": "752"}, "currency": "GBP", "currencyRate": 1, "dueDate": "2024-05-21", "id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "issueDate": "2024-05-21", "lines": [{"accountRef": {"id": "35"}, "description": "Hotel", "invoiceTo": {"id": "504", "type": "customer"}, "itemRef": {"id": "80000002-1675158984"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "reference": "expenses w/c 01/07"}] + application/json: [{"contactRef": {"id": "752"}, "currency": "GBP", "currencyRate": 1, "dueDate": "2024-05-21", "id": "4d7c6929-7770-412b-91bb-44d3bc71d111", "issueDate": "2024-05-21", "lines": [{"accountRef": {"id": "35"}, "description": "Hotel", "invoiceTo": {"id": "504", "type": "customer"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "reference": "expenses w/c 01/07"}] responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -2283,7 +2333,7 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee" requestBody: - application/json: {"contactRef": {"id": "752"}, "currency": "GBP", "currencyRate": 1, "dueDate": "2024-05-21", "issueDate": "2024-05-21", "lines": [{"accountRef": {"id": "35"}, "description": "Hotel", "invoiceTo": {"id": "504", "type": "customer"}, "itemRef": {"id": "80000002-1675158984"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "reference": "expenses w/c 01/07"} + application/json: {"contactRef": {"id": "752"}, "currency": "GBP", "currencyRate": 1, "dueDate": "2024-05-21", "issueDate": "2024-05-21", "lines": [{"accountRef": {"id": "35"}, "description": "Hotel", "invoiceTo": {"id": "504", "type": "customer"}, "netAmount": 100, "taxAmount": 20, "taxRateRef": {"id": "23_Bills"}, "trackingRefs": [{"dataType": "trackingCategories", "id": "DEPARTMENT_5"}]}], "notes": "APPLE.COM/BILL - 09001077498 - Card Ending: 4590", "reference": "expenses w/c 01/07"} responses: "200": application/json: {"syncId": "cd937d46-8e41-43a9-9477-a79158ffd98a"} @@ -2416,3 +2466,19 @@ examples: responses: "400": application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400} + get-company-info: + Example 1: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "200": + application/json: {"accountingPlatformRef": "1700060034_ETD", "addresses": [{"city": "London", "country": "United Kingdom", "line1": "301 Ink Rooms", "line2": "28 Easton Street", "postalCode": "WC1X 0BE", "region": "England", "type": "Billing"}, {"city": "London", "country": "UK", "line1": "28 Easton Street", "postalCode": "WC1X 0BE", "type": "Delivery"}], "baseCurrency": "GBP", "companyLegalName": "Codat Ltd", "companyName": "Codat", "createdDate": "2020-03-09T15:19:26", "financialYearStartDate": "2023-04-01T00:00:00", "phoneNumbers": [{"number": "02012 345678", "type": "Landline"}, {"number": "07123 456789", "type": "Mobile"}, {"number": "02012 345678", "type": "Fax"}], "registrationNumber": "5590111724", "sourceUrls": {"Api": "https://api.codat.io"}, "taxNumber": "74111622555799035846", "webLinks": [{"type": "Website", "url": "https://www.codat.io/"}, {"type": "Social", "url": "https://www.linkedin.com/company/codat-limited/"}]} + Unauthorized: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + responses: + "401": + application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} +generatedTests: {} diff --git a/sync-for-expenses/.speakeasy/gen.yaml b/sync-for-expenses/.speakeasy/gen.yaml index 7194eb1c..2d6d66c3 100644 --- a/sync-for-expenses/.speakeasy/gen.yaml +++ b/sync-for-expenses/.speakeasy/gen.yaml @@ -9,9 +9,10 @@ generation: requestResponseComponentNamesFeb2024: false auth: oAuth2ClientCredentialsEnabled: false + oAuth2PasswordEnabled: false telemetryEnabled: true java: - version: 0.3.0 + version: 1.0.0 additionalDependencies: [] additionalPlugins: [] artifactID: sync.expenses @@ -20,6 +21,7 @@ java: companyEmail: support@codat.io companyName: Codat companyURL: https://www.codat.io/ + defaultErrorName: SDKError description: Push expenses to accounting platforms. flattenGlobalSecurity: true githubURL: github.com/codatio/client-sdk-java/sync.expenses diff --git a/sync-for-expenses/README.md b/sync-for-expenses/README.md index ad59672f..a8d7ca6d 100644 --- a/sync-for-expenses/README.md +++ b/sync-for-expenses/README.md @@ -63,7 +63,7 @@ The samples below show how a published SDK artifact is used: Gradle: ```groovy -implementation 'io.codat:sync.expenses:0.3.0' +implementation 'io.codat:sync.expenses:1.0.0' ``` Maven: @@ -71,7 +71,7 @@ Maven: io.codat sync.expenses - 0.3.0 + 1.0.0 ``` @@ -101,47 +101,30 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -180,6 +163,10 @@ public class Application { * [list](docs/sdks/companies/README.md#list) - List companies * [update](docs/sdks/companies/README.md#update) - Update company +### [companyInfo()](docs/sdks/companyinfo/README.md) + +* [get](docs/sdks/companyinfo/README.md#get) - Get company info + ### [configuration()](docs/sdks/configuration/README.md) * [get](docs/sdks/configuration/README.md#get) - Get company configuration @@ -265,33 +252,27 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import io.codat.sync.expenses.utils.BackoffStrategy; import io.codat.sync.expenses.utils.RetryConfig; import java.lang.Exception; -import java.util.List; import java.util.concurrent.TimeUnit; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .retryConfig(RetryConfig.builder() .backoff(BackoffStrategy.builder() @@ -305,20 +286,9 @@ public class Application { .build()) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -329,20 +299,18 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import io.codat.sync.expenses.utils.BackoffStrategy; import io.codat.sync.expenses.utils.RetryConfig; import java.lang.Exception; -import java.util.List; import java.util.concurrent.TimeUnit; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .retryConfig(RetryConfig.builder() .backoff(BackoffStrategy.builder() .initialInterval(1L, TimeUnit.MILLISECONDS) @@ -354,35 +322,20 @@ public class Application { .build()) .build()) .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -391,12 +344,14 @@ public class Application { ## Error Handling -Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Exception type. +Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception. + +By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create` method throws the following exceptions: -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------- | --------------------------------- | ---------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ### Example @@ -405,47 +360,30 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -454,118 +392,39 @@ public class Application { ## Server Selection -### Select Server by Index - -You can override the default server globally by passing a server index to the `serverIndex` builder method 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 - -```java -package hello.world; - -import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; -import io.codat.sync.expenses.models.operations.CreateCompanyResponse; -import java.lang.Exception; -import java.util.List; - -public class Application { - - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() - .serverIndex(0) - .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); - - CompanyRequestBody req = CompanyRequestBody.builder() - .name("Bank of Dave") - .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) - .build(); - - CreateCompanyResponse res = sdk.companies().create() - .request(req) - .call(); - - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - - } -} -``` - - ### Override Server URL Per-Client -The default server can also be overridden globally by passing a URL to the `serverURL` builder method when initializing the SDK client instance. For example: +The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example: ```java package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .serverURL("https://api.codat.io") .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -578,9 +437,9 @@ public class Application { This SDK supports the following security scheme globally: -| Name | Type | Scheme | -| ------------ | ------------ | ------------ | -| `authHeader` | apiKey | API key | +| Name | Type | Scheme | +| ------------ | ------ | ------- | +| `authHeader` | apiKey | API key | To authenticate with the API the `authHeader` parameter must be set when initializing the SDK client instance. For example: ```java @@ -588,47 +447,30 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` diff --git a/sync-for-expenses/RELEASES.md b/sync-for-expenses/RELEASES.md index 9a50eca1..4d869203 100644 --- a/sync-for-expenses/RELEASES.md +++ b/sync-for-expenses/RELEASES.md @@ -38,4 +38,14 @@ Based on: ### Generated - [java v0.3.0] sync-for-expenses ### Releases -- [Maven Central v0.3.0] https://central.sonatype.com/artifact/io.codat.sync/expenses/0.3.0 - sync-for-expenses \ No newline at end of file +- [Maven Central v0.3.0] https://central.sonatype.com/artifact/io.codat.sync/expenses/0.3.0 - sync-for-expenses + +## 2024-11-26 17:07:44 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.447.0 (2.463.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [java v1.0.0] sync-for-expenses +### Releases +- [Maven Central v1.0.0] https://central.sonatype.com/artifact/io.codat.sync/expenses/1.0.0 - sync-for-expenses \ No newline at end of file diff --git a/sync-for-expenses/USAGE.md b/sync-for-expenses/USAGE.md index 6fe1c26a..c60b5940 100644 --- a/sync-for-expenses/USAGE.md +++ b/sync-for-expenses/USAGE.md @@ -4,47 +4,30 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` diff --git a/sync-for-expenses/build.gradle b/sync-for-expenses/build.gradle index 5deea521..3be0afaf 100644 --- a/sync-for-expenses/build.gradle +++ b/sync-for-expenses/build.gradle @@ -63,7 +63,7 @@ tasks.withType(Javadoc) { } group = "io.codat" -version = "0.3.0" +version = "1.0.0" sourcesJar { archiveBaseName = "sync.expenses" @@ -101,7 +101,7 @@ publishing { maven(MavenPublication) { groupId = 'io.codat' artifactId = 'sync.expenses' - version = '0.3.0' + version = '1.0.0' from components.java @@ -145,10 +145,11 @@ if (!project.hasProperty('skip.signing')) { } dependencies { + api 'com.fasterxml.jackson.core:jackson-annotations:2.17.2' implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.2' implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.2' implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.17.2' - implementation 'org.openapitools:jackson-databind-nullable:0.2.6' + api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'} implementation 'org.apache.httpcomponents:httpclient:4.5.14' implementation 'org.apache.httpcomponents:httpmime:4.5.14' implementation 'commons-io:commons-io:2.15.1' diff --git a/sync-for-expenses/docs/models/components/AccountMappingInfo.md b/sync-for-expenses/docs/models/components/AccountMappingInfo.md index 4b959df8..3df945ab 100644 --- a/sync-for-expenses/docs/models/components/AccountMappingInfo.md +++ b/sync-for-expenses/docs/models/components/AccountMappingInfo.md @@ -3,13 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `accountType` | [Optional](../../models/components/AccountMappingInfoAccountType.md) | :heavy_minus_sign: | Type of the account. | Expense | -| `currency` | *Optional* | :heavy_minus_sign: | Currency of the account. | GBP | -| `fullyQualifiedCategory` | *Optional* | :heavy_minus_sign: | Full account type and category of the account | Expense.DirectCosts | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of account. | 127f3b99-8dc2-4b7e-854c-91ef9bd2757b | -| `isBankAccount` | *Optional* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | -| `name` | *Optional* | :heavy_minus_sign: | Name of the account as it appears in the company's accounting software. | Purchases | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account in the accounting software. | 300 | -| `validTransactionTypes` | List<[ValidTransactionTypes](../../models/components/ValidTransactionTypes.md)> | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `accountType` | [Optional\](../../models/components/AccountMappingInfoAccountType.md) | :heavy_minus_sign: | Type of the account. | Expense | +| `currency` | *Optional\* | :heavy_minus_sign: | Currency of the account. | GBP | +| `fullyQualifiedCategory` | *Optional\* | :heavy_minus_sign: | Full account type and category of the account | Expense.DirectCosts | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of account. | 127f3b99-8dc2-4b7e-854c-91ef9bd2757b | +| `isBankAccount` | *Optional\* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | +| `name` | *Optional\* | :heavy_minus_sign: | Name of the account as it appears in the company's accounting software. | Purchases | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account in the accounting software. | 300 | +| `validFor` | List\<[ValidFor](../../models/components/ValidFor.md)> | :heavy_minus_sign: | Supported endpoints for the account. | | +| `validTransactionTypes` | List\<[ValidTransactionTypes](../../models/components/ValidTransactionTypes.md)> | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountPrototype.md b/sync-for-expenses/docs/models/components/AccountPrototype.md index 3e787aac..901fde97 100644 --- a/sync-for-expenses/docs/models/components/AccountPrototype.md +++ b/sync-for-expenses/docs/models/components/AccountPrototype.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `currency` | *Optional* | :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 | -| `currentBalance` | *JsonNullable* | :heavy_minus_sign: | Current balance in the account. | 0 | -| `description` | *JsonNullable* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | -| `fullyQualifiedCategory` | *JsonNullable* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | -| `fullyQualifiedName` | *JsonNullable* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | -| `isBankAccount` | *Optional* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | -| `name` | *JsonNullable* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | -| `status` | [Optional](../../models/components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `type` | [Optional](../../models/components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | -| `validDatatypeLinks` | List<[ValidDataTypeLinks](../../models/components/ValidDataTypeLinks.md)> | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `currency` | *Optional\* | :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 | +| `currentBalance` | *JsonNullable\* | :heavy_minus_sign: | Current balance in the account. | 0 | +| `description` | *JsonNullable\* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | +| `fullyQualifiedCategory` | *JsonNullable\* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | +| `fullyQualifiedName` | *JsonNullable\* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | +| `isBankAccount` | *Optional\* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | +| `name` | *JsonNullable\* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | +| `status` | [Optional\](../../models/components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `type` | [Optional\](../../models/components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | +| `validDatatypeLinks` | List\<[ValidDataTypeLinks](../../models/components/ValidDataTypeLinks.md)> | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountingAccount.md b/sync-for-expenses/docs/models/components/AccountingAccount.md index 4f1ff00d..d6fd43d9 100644 --- a/sync-for-expenses/docs/models/components/AccountingAccount.md +++ b/sync-for-expenses/docs/models/components/AccountingAccount.md @@ -2,8 +2,6 @@ > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. -View the coverage for accounts in the Data coverage explorer. - ## Overview Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company. @@ -36,19 +34,19 @@ To determine the list of allowed categories for a specific integration, you can: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `currency` | *Optional* | :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 | -| `currentBalance` | *JsonNullable* | :heavy_minus_sign: | Current balance in the account. | 0 | -| `description` | *JsonNullable* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | -| `fullyQualifiedCategory` | *JsonNullable* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | -| `fullyQualifiedName` | *JsonNullable* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | -| `isBankAccount` | *Optional* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | -| `metadata` | [Optional](../../models/components/CreateAccountResponseMetadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `name` | *JsonNullable* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [Optional](../../models/components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `type` | [Optional](../../models/components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | -| `validDatatypeLinks` | List<[CreateAccountResponseValidDataTypeLinks](../../models/components/CreateAccountResponseValidDataTypeLinks.md)> | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file +| `currency` | *Optional\* | :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 | +| `currentBalance` | *JsonNullable\* | :heavy_minus_sign: | Current balance in the account. | 0 | +| `description` | *JsonNullable\* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | +| `fullyQualifiedCategory` | *JsonNullable\* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | +| `fullyQualifiedName` | *JsonNullable\* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | +| `isBankAccount` | *Optional\* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | | +| `metadata` | [Optional\](../../models/components/CreateAccountResponseMetadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `name` | *JsonNullable\* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional\](../../models/components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `type` | [Optional\](../../models/components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | +| `validDatatypeLinks` | List\<[CreateAccountResponseValidDataTypeLinks](../../models/components/CreateAccountResponseValidDataTypeLinks.md)> | :heavy_minus_sign: | The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-expenses-api#/schemas/ValidDataTypeLinks). | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountingAddress.md b/sync-for-expenses/docs/models/components/AccountingAddress.md index 3a8d089d..82e6c202 100644 --- a/sync-for-expenses/docs/models/components/AccountingAddress.md +++ b/sync-for-expenses/docs/models/components/AccountingAddress.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `city` | *JsonNullable* | :heavy_minus_sign: | City of the customer address. | -| `country` | *JsonNullable* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *JsonNullable* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *JsonNullable* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postalCode` | *JsonNullable* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *JsonNullable* | :heavy_minus_sign: | Region of the customer address. | +| `city` | *JsonNullable\* | :heavy_minus_sign: | City of the customer address. | +| `country` | *JsonNullable\* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *JsonNullable\* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *JsonNullable\* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postalCode` | *JsonNullable\* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *JsonNullable\* | :heavy_minus_sign: | Region of the customer address. | | `type` | [AccountingAddressType](../../models/components/AccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountingBankAccount.md b/sync-for-expenses/docs/models/components/AccountingBankAccount.md index 91d7ae44..4c81946e 100644 --- a/sync-for-expenses/docs/models/components/AccountingBankAccount.md +++ b/sync-for-expenses/docs/models/components/AccountingBankAccount.md @@ -4,9 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) - -> View the coverage for bank accounts in the Data coverage explorer. +> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. ## Overview @@ -24,20 +22,20 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `accountType` | [Optional](../../models/components/CreateBankAccountResponseBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | Balance of the bank account. | | -| `currency` | *Optional* | :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 | -| `iBan` | *JsonNullable* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | -| `institution` | *JsonNullable* | :heavy_minus_sign: | The institution of the bank account. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | -| `overdraftLimit` | *JsonNullable* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [Optional](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | +| `accountType` | [Optional\](../../models/components/CreateBankAccountResponseBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | Balance of the bank account. | | +| `currency` | *Optional\* | :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 | +| `iBan` | *JsonNullable\* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | +| `institution` | *JsonNullable\* | :heavy_minus_sign: | The institution of the bank account. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | +| `overdraftLimit` | *JsonNullable\* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional\](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountingCustomer.md b/sync-for-expenses/docs/models/components/AccountingCustomer.md index cd98b3c3..572bde3a 100644 --- a/sync-for-expenses/docs/models/components/AccountingCustomer.md +++ b/sync-for-expenses/docs/models/components/AccountingCustomer.md @@ -1,7 +1,5 @@ # ~~AccountingCustomer~~ -> View the coverage for customers in the Data coverage explorer. - ## Overview A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). @@ -16,18 +14,18 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[CreateCustomerResponseAccountingAddress](../../models/components/CreateCustomerResponseAccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | -| `contacts` | List<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | -| `customerName` | *JsonNullable* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | -| `defaultCurrency` | *Optional* | :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 | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address the customer can be contacted by. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | +| `contacts` | List\<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | +| `customerName` | *JsonNullable\* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | +| `defaultCurrency` | *Optional\* | :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 | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address the customer can be contacted by. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [CustomerStatus](../../models/components/CustomerStatus.md) | :heavy_check_mark: | Status of customer. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AccountingSupplier.md b/sync-for-expenses/docs/models/components/AccountingSupplier.md index 474257e2..542201dc 100644 --- a/sync-for-expenses/docs/models/components/AccountingSupplier.md +++ b/sync-for-expenses/docs/models/components/AccountingSupplier.md @@ -1,7 +1,5 @@ # ~~AccountingSupplier~~ -> View the coverage for suppliers in the Data coverage explorer. - ## Overview From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). @@ -13,17 +11,17 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the supplier. | | -| `defaultCurrency` | *JsonNullable* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the supplier. | | +| `defaultCurrency` | *JsonNullable\* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [SupplierStatus](../../models/components/SupplierStatus.md) | :heavy_check_mark: | Status of the supplier. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `supplierName` | *JsonNullable* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `supplierName` | *JsonNullable\* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AdjustmentTransactionLine.md b/sync-for-expenses/docs/models/components/AdjustmentTransactionLine.md index 1ae18ce1..eaf08d3f 100644 --- a/sync-for-expenses/docs/models/components/AdjustmentTransactionLine.md +++ b/sync-for-expenses/docs/models/components/AdjustmentTransactionLine.md @@ -7,6 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountRef` | [RecordRef](../../models/components/RecordRef.md) | :heavy_check_mark: | N/A | | | `amount` | *BigDecimal* | :heavy_check_mark: | Amount of the line. A positive line represents a debit; a negative line represents a credit. | 50 | -| `description` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `invoiceTo` | [JsonNullable](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | -| `trackingRefs` | List<[TrackingRefAdjustmentTransaction](../../models/components/TrackingRefAdjustmentTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `description` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | +| `invoiceTo` | [JsonNullable\](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | +| `trackingRefs` | List\<[TrackingRefAdjustmentTransaction](../../models/components/TrackingRefAdjustmentTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AdjustmentTransactionRequest.md b/sync-for-expenses/docs/models/components/AdjustmentTransactionRequest.md index 7cafedc9..899f61ed 100644 --- a/sync-for-expenses/docs/models/components/AdjustmentTransactionRequest.md +++ b/sync-for-expenses/docs/models/components/AdjustmentTransactionRequest.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `currency` | *String* | :heavy_check_mark: | Currency the transaction was recorded in. | | -| `currencyRate` | *JsonNullable* | :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. \| | | +| `currencyRate` | *JsonNullable\* | :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. \| | | | `date` | *String* | :heavy_check_mark: | 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 | | `id` | *String* | :heavy_check_mark: | Your unique identifier for the transaction. | | -| `lines` | List<[AdjustmentTransactionLine](../../models/components/AdjustmentTransactionLine.md)> | :heavy_check_mark: | Array of transaction lines. | | -| `reference` | *JsonNullable* | :heavy_minus_sign: | User-friendly reference for the adjustment transaction. | | \ No newline at end of file +| `lines` | List\<[AdjustmentTransactionLine](../../models/components/AdjustmentTransactionLine.md)> | :heavy_check_mark: | Array of transaction lines. | | +| `reference` | *JsonNullable\* | :heavy_minus_sign: | User-friendly reference for the adjustment transaction. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/AdjustmentTransactionResponse.md b/sync-for-expenses/docs/models/components/AdjustmentTransactionResponse.md index 633e07d9..cb3be2df 100644 --- a/sync-for-expenses/docs/models/components/AdjustmentTransactionResponse.md +++ b/sync-for-expenses/docs/models/components/AdjustmentTransactionResponse.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ApAccountRef.md b/sync-for-expenses/docs/models/components/ApAccountRef.md new file mode 100644 index 00000000..c4dccea4 --- /dev/null +++ b/sync-for-expenses/docs/models/components/ApAccountRef.md @@ -0,0 +1,8 @@ +# ApAccountRef + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. | 8000004C-1724173136 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Attachment.md b/sync-for-expenses/docs/models/components/Attachment.md index 8347a594..62c38caf 100644 --- a/sync-for-expenses/docs/models/components/Attachment.md +++ b/sync-for-expenses/docs/models/components/Attachment.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `companyId` | *Optional* | :heavy_minus_sign: | Unique ID of company in Codat | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of attachment | -| `transactionId` | *Optional* | :heavy_minus_sign: | Unique identifier of transaction | \ No newline at end of file +| `companyId` | *Optional\* | :heavy_minus_sign: | Unique ID of company in Codat | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of attachment | +| `transactionId` | *Optional\* | :heavy_minus_sign: | Unique identifier of transaction | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/BankAccount.md b/sync-for-expenses/docs/models/components/BankAccount.md index 75e0ce35..0f0c3b53 100644 --- a/sync-for-expenses/docs/models/components/BankAccount.md +++ b/sync-for-expenses/docs/models/components/BankAccount.md @@ -4,9 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) - -> View the coverage for bank accounts in the Data coverage explorer. +> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. ## Overview @@ -22,20 +20,20 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `accountType` | [Optional](../../models/components/BankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | Balance of the bank account. | | -| `currency` | *Optional* | :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 | -| `iBan` | *JsonNullable* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | -| `institution` | *JsonNullable* | :heavy_minus_sign: | The institution of the bank account. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | -| `overdraftLimit` | *JsonNullable* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [Optional](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | +| `accountType` | [Optional\](../../models/components/BankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | Balance of the bank account. | | +| `currency` | *Optional\* | :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 | +| `iBan` | *JsonNullable\* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | +| `institution` | *JsonNullable\* | :heavy_minus_sign: | The institution of the bank account. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | +| `overdraftLimit` | *JsonNullable\* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional\](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/BankAccountDetails.md b/sync-for-expenses/docs/models/components/BankAccountDetails.md index 7116f98f..998d0dc2 100644 --- a/sync-for-expenses/docs/models/components/BankAccountDetails.md +++ b/sync-for-expenses/docs/models/components/BankAccountDetails.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | The id of the account from which purchases are made | 32 | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | The id of the account from which purchases are made | 32 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/BankAccountReference.md b/sync-for-expenses/docs/models/components/BankAccountReference.md index fa7c8f8e..dabab464 100644 --- a/sync-for-expenses/docs/models/components/BankAccountReference.md +++ b/sync-for-expenses/docs/models/components/BankAccountReference.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Identifier of the bank account. | 787dfb37-5707-4dc0-8a86-8d74e4cc78ea | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Identifier of the bank account. | 787dfb37-5707-4dc0-8a86-8d74e4cc78ea | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhook.md b/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhook.md index 22c74875..f03bce18 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhook.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhook.md @@ -7,10 +7,10 @@ Webhook request body for a client that has reached their rate limit. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional](../../models/components/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional\](../../models/components/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhookData.md b/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhookData.md index 748312f4..71963e2c 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhookData.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitReachedWebhookData.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiresUtc` | *Optional* | :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 | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *Optional\* | :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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhook.md b/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhook.md index 68f23dd4..a4f6e215 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhook.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhook.md @@ -7,10 +7,10 @@ Webhook request body for a client that has had their rate limit reset. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional](../../models/components/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional\](../../models/components/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhookData.md b/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhookData.md index d4f34f5f..3498735a 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhookData.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitResetWebhookData.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiresUtc` | *Optional* | :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 | -| `quotaRemaining` | *JsonNullable* | :heavy_minus_sign: | Total number of requests remaining for your client. | | -| `resetReason` | *Optional* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *Optional\* | :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 | +| `quotaRemaining` | *JsonNullable\* | :heavy_minus_sign: | Total number of requests remaining for your client. | | +| `resetReason` | *Optional\* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitWebhook.md b/sync-for-expenses/docs/models/components/ClientRateLimitWebhook.md index f1109eb7..bfcfa438 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitWebhook.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitWebhook.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `eventType` | *Optional* | :heavy_minus_sign: | The type of event. | client.rateLimit.reset | -| `generatedDate` | *Optional* | :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 | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b | -| `payload` | [Optional](../../models/components/ClientRateLimitWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `eventType` | *Optional\* | :heavy_minus_sign: | The type of event. | client.rateLimit.reset | +| `generatedDate` | *Optional\* | :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 | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b | +| `payload` | [Optional\](../../models/components/ClientRateLimitWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ClientRateLimitWebhookPayload.md b/sync-for-expenses/docs/models/components/ClientRateLimitWebhookPayload.md index 8edb73b2..70fdc833 100644 --- a/sync-for-expenses/docs/models/components/ClientRateLimitWebhookPayload.md +++ b/sync-for-expenses/docs/models/components/ClientRateLimitWebhookPayload.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiryDate` | *Optional* | :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 | -| `quotaRemaining` | *Optional* | :heavy_minus_sign: | Total number of requests remaining for your client. | | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiryDate` | *Optional\* | :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 | +| `quotaRemaining` | *Optional\* | :heavy_minus_sign: | Total number of requests remaining for your client. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Companies.md b/sync-for-expenses/docs/models/components/Companies.md index 3e6ef9b8..2abd4efd 100644 --- a/sync-for-expenses/docs/models/components/Companies.md +++ b/sync-for-expenses/docs/models/components/Companies.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Company](../../models/components/Company.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Company](../../models/components/Company.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Company.md b/sync-for-expenses/docs/models/components/Company.md index f97d9555..ac263cfa 100644 --- a/sync-for-expenses/docs/models/components/Company.md +++ b/sync-for-expenses/docs/models/components/Company.md @@ -11,12 +11,15 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created` | *Optional* | :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 | -| `createdByUserName` | *JsonNullable* | :heavy_minus_sign: | Name of user that created the company in Codat. | | -| `dataConnections` | List<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | -| `description` | *Optional* | :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. | +| `created` | *Optional\* | :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 | +| `createdByUserName` | *JsonNullable\* | :heavy_minus_sign: | Name of user that created the company in Codat. | | +| `dataConnections` | List\<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | +| `description` | *Optional\* | :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. | | `id` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `lastSync` | *Optional* | :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 | +| `lastSync` | *Optional\* | :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 | | `name` | *String* | :heavy_check_mark: | The name of the company | Codat Ltd. | +| `products` | List\<*String*> | :heavy_minus_sign: | An array of products that are currently enabled for the company. | | | `redirect` | *String* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | -| `tags` | [Optional](../../models/components/Tags.md) | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file +| `referenceParentCompany` | [Optional\](../../models/components/CompanyReference.md) | :heavy_minus_sign: | N/A | | +| `referenceSubsidiaryCompanies` | List\<[CompanyReference](../../models/components/CompanyReference.md)> | :heavy_minus_sign: | A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. | | +| `tags` | Map\ | :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/sync-for-expenses/docs/models/components/CompanyInformation.md b/sync-for-expenses/docs/models/components/CompanyInformation.md new file mode 100644 index 00000000..613950f8 --- /dev/null +++ b/sync-for-expenses/docs/models/components/CompanyInformation.md @@ -0,0 +1,27 @@ +# CompanyInformation + +Company info provides standard details about a linked company such as their address, phone number, and company registration. + +> **Company information or companies?** +> +> Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `accountingPlatformRef` | *JsonNullable\* | :heavy_minus_sign: | Identifier or reference for the company in the accounting software. | | +| `addresses` | List\<[AccountingAddress](../../models/components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `baseCurrency` | *JsonNullable\* | :heavy_minus_sign: | Currency set in the accounting software of the linked company. Used by the currency rate. | | +| `companyLegalName` | *JsonNullable\* | :heavy_minus_sign: | Registered legal name of the linked company. | | +| `companyName` | *JsonNullable\* | :heavy_minus_sign: | Name of the linked company. | | +| `createdDate` | *Optional\* | :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 | +| `financialYearStartDate` | *Optional\* | :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 | +| `ledgerLockDate` | *Optional\* | :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 | +| `phoneNumbers` | List\<[Phone](../../models/components/Phone.md)> | :heavy_minus_sign: | An array of phone numbers. | | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. | | +| `sourceUrls` | Map\ | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Company tax number. | | +| `webLinks` | List\<[Weblink](../../models/components/Weblink.md)> | :heavy_minus_sign: | An array of weblinks. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CompanyInformationType.md b/sync-for-expenses/docs/models/components/CompanyInformationType.md new file mode 100644 index 00000000..d44732c6 --- /dev/null +++ b/sync-for-expenses/docs/models/components/CompanyInformationType.md @@ -0,0 +1,12 @@ +# CompanyInformationType + +The type of the weblink. + + +## Values + +| Name | Value | +| --------- | --------- | +| `WEBSITE` | Website | +| `SOCIAL` | Social | +| `UNKNOWN` | Unknown | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CompanyReference.md b/sync-for-expenses/docs/models/components/CompanyReference.md new file mode 100644 index 00000000..36df806e --- /dev/null +++ b/sync-for-expenses/docs/models/components/CompanyReference.md @@ -0,0 +1,12 @@ +# CompanyReference + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `description` | *Optional\* | :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. | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `links` | [Optional\](../../models/components/CompanyReferenceLinks.md) | :heavy_minus_sign: | A collection of links for the company. | | +| `name` | *Optional\* | :heavy_minus_sign: | The name of the company | Codat Ltd. | +| `tags` | Map\ | :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/sync-for-expenses/docs/models/components/CompanyReferenceLinks.md b/sync-for-expenses/docs/models/components/CompanyReferenceLinks.md new file mode 100644 index 00000000..cf075bb9 --- /dev/null +++ b/sync-for-expenses/docs/models/components/CompanyReferenceLinks.md @@ -0,0 +1,10 @@ +# CompanyReferenceLinks + +A collection of links for the company. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `portal` | *Optional\* | :heavy_minus_sign: | Link to the company page in the portal. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CompanyRequestBody.md b/sync-for-expenses/docs/models/components/CompanyRequestBody.md index da236c2a..f5b32be7 100644 --- a/sync-for-expenses/docs/models/components/CompanyRequestBody.md +++ b/sync-for-expenses/docs/models/components/CompanyRequestBody.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `description` | *Optional* | :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. | -| `groups` | List<[GroupReference](../../models/components/GroupReference.md)> | :heavy_minus_sign: | Reference to the groups that the company is assigned to. | | -| `name` | *String* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | \ No newline at end of file +| `description` | *Optional\* | :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. | +| `name` | *String* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | +| `tags` | Map\ | :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/sync-for-expenses/docs/models/components/CompanySyncStatus.md b/sync-for-expenses/docs/models/components/CompanySyncStatus.md index 820ff8fe..577bba83 100644 --- a/sync-for-expenses/docs/models/components/CompanySyncStatus.md +++ b/sync-for-expenses/docs/models/components/CompanySyncStatus.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companyId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | d4d73051-ed31-42b6-99f6-d288cd940992 | -| `dataPushed` | *Optional* | :heavy_minus_sign: | Boolean of whether the sync resulted in data being pushed. | | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | Error message of the sync. | | -| `syncExceptionMessage` | *JsonNullable* | :heavy_minus_sign: | Exception message of the sync. | | -| `syncId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier of the sync. | a6a22aff-a43a-411d-a910-2dae73217cce | -| `syncStatus` | *JsonNullable* | :heavy_minus_sign: | Text status of the sync. | Complete | -| `syncStatusCode` | *Optional* | :heavy_minus_sign: | Status code of the sync. | 2000 | -| `syncUtc` | *Optional* | :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 | \ No newline at end of file +| `companyId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | d4d73051-ed31-42b6-99f6-d288cd940992 | +| `dataPushed` | *Optional\* | :heavy_minus_sign: | Boolean of whether the sync resulted in data being pushed. | | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | Error message of the sync. | | +| `syncExceptionMessage` | *JsonNullable\* | :heavy_minus_sign: | Exception message of the sync. | | +| `syncId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier of the sync. | a6a22aff-a43a-411d-a910-2dae73217cce | +| `syncStatus` | *JsonNullable\* | :heavy_minus_sign: | Text status of the sync. | Complete | +| `syncStatusCode` | *Optional\* | :heavy_minus_sign: | Status code of the sync. | 2000 | +| `syncUtc` | *Optional\* | :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 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Connection.md b/sync-for-expenses/docs/models/components/Connection.md index 71ec570a..3bc94576 100644 --- a/sync-for-expenses/docs/models/components/Connection.md +++ b/sync-for-expenses/docs/models/components/Connection.md @@ -16,14 +16,13 @@ Before you can use a data connection to pull or push data, the company must gran | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additionalProperties` | *Optional* | :heavy_minus_sign: | N/A | | -| `connectionInfo` | Map | :heavy_minus_sign: | N/A | | +| `connectionInfo` | Map\ | :heavy_minus_sign: | N/A | | | `created` | *String* | :heavy_check_mark: | 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 | -| `dataConnectionErrors` | List<[DataConnectionError](../../models/components/DataConnectionError.md)> | :heavy_minus_sign: | N/A | | +| `dataConnectionErrors` | List\<[DataConnectionError](../../models/components/DataConnectionError.md)> | :heavy_minus_sign: | N/A | | | `id` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integrationId` | *String* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integrationKey` | *String* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | -| `lastSync` | *Optional* | :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 | +| `lastSync` | *Optional\* | :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 | | `linkUrl` | *String* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | | `platformName` | *String* | :heavy_check_mark: | Name of integration connected to company. | | | `sourceId` | *String* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | diff --git a/sync-for-expenses/docs/models/components/Connections.md b/sync-for-expenses/docs/models/components/Connections.md index 142200ca..ea2d295a 100644 --- a/sync-for-expenses/docs/models/components/Connections.md +++ b/sync-for-expenses/docs/models/components/Connections.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Contact.md b/sync-for-expenses/docs/models/components/Contact.md index 2498d310..bb82b588 100644 --- a/sync-for-expenses/docs/models/components/Contact.md +++ b/sync-for-expenses/docs/models/components/Contact.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `address` | [Optional](../../models/components/Items.md) | :heavy_minus_sign: | N/A | | -| `email` | *JsonNullable* | :heavy_minus_sign: | Email of a contact for a customer. | | -| `modifiedDate` | *Optional* | :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 | -| `name` | *JsonNullable* | :heavy_minus_sign: | Name of a contact for a customer. | | -| `phone` | List<[Phone](../../models/components/Phone.md)> | :heavy_minus_sign: | An array of Phone numbers. | | +| `address` | [Optional\](../../models/components/Items.md) | :heavy_minus_sign: | N/A | | +| `email` | *JsonNullable\* | :heavy_minus_sign: | Email of a contact for a customer. | | +| `modifiedDate` | *Optional\* | :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 | +| `name` | *JsonNullable\* | :heavy_minus_sign: | Name of a contact for a customer. | | +| `phone` | List\<[PhoneNumberItems](../../models/components/PhoneNumberItems.md)> | :heavy_minus_sign: | An array of Phone numbers. | | | `status` | [CustomerStatus](../../models/components/CustomerStatus.md) | :heavy_check_mark: | Status of customer. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateAccountResponse.md b/sync-for-expenses/docs/models/components/CreateAccountResponse.md index c88f3034..dcbbcc06 100644 --- a/sync-for-expenses/docs/models/components/CreateAccountResponse.md +++ b/sync-for-expenses/docs/models/components/CreateAccountResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/AccountingAccount.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/AccountingAccount.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateAccountResponseMetadata.md b/sync-for-expenses/docs/models/components/CreateAccountResponseMetadata.md index 847254bf..7a8cfc78 100644 --- a/sync-for-expenses/docs/models/components/CreateAccountResponseMetadata.md +++ b/sync-for-expenses/docs/models/components/CreateAccountResponseMetadata.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `isDeleted` | *JsonNullable* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file +| `isDeleted` | *JsonNullable\* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateAccountResponseValidDataTypeLinks.md b/sync-for-expenses/docs/models/components/CreateAccountResponseValidDataTypeLinks.md index df9168f7..8cb2342a 100644 --- a/sync-for-expenses/docs/models/components/CreateAccountResponseValidDataTypeLinks.md +++ b/sync-for-expenses/docs/models/components/CreateAccountResponseValidDataTypeLinks.md @@ -46,5 +46,5 @@ If you'd like us to extend support to more data types or integrations, suggest o | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `links` | List<*String*> | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | -| `property` | *JsonNullable* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file +| `links` | List\<*String*> | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | +| `property` | *JsonNullable\* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateBankAccountResponse.md b/sync-for-expenses/docs/models/components/CreateBankAccountResponse.md index 23e6a483..99bc6262 100644 --- a/sync-for-expenses/docs/models/components/CreateBankAccountResponse.md +++ b/sync-for-expenses/docs/models/components/CreateBankAccountResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/AccountingBankAccount.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/AccountingBankAccount.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateCustomerResponse.md b/sync-for-expenses/docs/models/components/CreateCustomerResponse.md index 2480e1a4..89cae797 100644 --- a/sync-for-expenses/docs/models/components/CreateCustomerResponse.md +++ b/sync-for-expenses/docs/models/components/CreateCustomerResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/AccountingCustomer.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/AccountingCustomer.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateCustomerResponseAccountingAddress.md b/sync-for-expenses/docs/models/components/CreateCustomerResponseAccountingAddress.md deleted file mode 100644 index cc2a7fa3..00000000 --- a/sync-for-expenses/docs/models/components/CreateCustomerResponseAccountingAddress.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateCustomerResponseAccountingAddress - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `city` | *JsonNullable* | :heavy_minus_sign: | City of the customer address. | -| `country` | *JsonNullable* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *JsonNullable* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *JsonNullable* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postalCode` | *JsonNullable* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *JsonNullable* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [AccountingAddressType](../../models/components/AccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateExpenseResponse.md b/sync-for-expenses/docs/models/components/CreateExpenseResponse.md index d7a5642f..0cd6e484 100644 --- a/sync-for-expenses/docs/models/components/CreateExpenseResponse.md +++ b/sync-for-expenses/docs/models/components/CreateExpenseResponse.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateReimbursableExpenseResponse.md b/sync-for-expenses/docs/models/components/CreateReimbursableExpenseResponse.md index c1425d2d..0741b7a5 100644 --- a/sync-for-expenses/docs/models/components/CreateReimbursableExpenseResponse.md +++ b/sync-for-expenses/docs/models/components/CreateReimbursableExpenseResponse.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CreateSupplierResponse.md b/sync-for-expenses/docs/models/components/CreateSupplierResponse.md index 51b8ba86..02f42976 100644 --- a/sync-for-expenses/docs/models/components/CreateSupplierResponse.md +++ b/sync-for-expenses/docs/models/components/CreateSupplierResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/AccountingSupplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/AccountingSupplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Customer.md b/sync-for-expenses/docs/models/components/Customer.md index eb076ecb..a3cbaa94 100644 --- a/sync-for-expenses/docs/models/components/Customer.md +++ b/sync-for-expenses/docs/models/components/Customer.md @@ -1,7 +1,5 @@ # Customer -> View the coverage for customers in the Data coverage explorer. - ## Overview A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). @@ -14,18 +12,18 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[AccountingAddress](../../models/components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | -| `contacts` | List<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | -| `customerName` | *JsonNullable* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | -| `defaultCurrency` | *Optional* | :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 | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address the customer can be contacted by. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | +| `contacts` | List\<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | +| `customerName` | *JsonNullable\* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | +| `defaultCurrency` | *Optional\* | :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 | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address the customer can be contacted by. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [CustomerStatus](../../models/components/CustomerStatus.md) | :heavy_check_mark: | Status of customer. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/CustomerDetails.md b/sync-for-expenses/docs/models/components/CustomerDetails.md index 1f970a61..e44c50b3 100644 --- a/sync-for-expenses/docs/models/components/CustomerDetails.md +++ b/sync-for-expenses/docs/models/components/CustomerDetails.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Customers.md b/sync-for-expenses/docs/models/components/Customers.md index cc420af6..0bbb2ce0 100644 --- a/sync-for-expenses/docs/models/components/Customers.md +++ b/sync-for-expenses/docs/models/components/Customers.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Customer](../../models/components/Customer.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Customer](../../models/components/Customer.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/DataConnectionError.md b/sync-for-expenses/docs/models/components/DataConnectionError.md index 30c434fc..47d52908 100644 --- a/sync-for-expenses/docs/models/components/DataConnectionError.md +++ b/sync-for-expenses/docs/models/components/DataConnectionError.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `errorMessage` | *Optional* | :heavy_minus_sign: | A message about a error returned by Codat. | | -| `erroredOnUtc` | *Optional* | :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 | -| `resolvedOnUtc` | *Optional* | :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 | -| `status` | [JsonNullable](../../models/components/ErrorStatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | | -| `statusCode` | *Optional* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | | -| `statusText` | *Optional* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | | \ No newline at end of file +| `errorMessage` | *Optional\* | :heavy_minus_sign: | A message about a error returned by Codat. | | +| `erroredOnUtc` | *Optional\* | :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 | +| `resolvedOnUtc` | *Optional\* | :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 | +| `status` | [JsonNullable\](../../models/components/ErrorStatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | | +| `statusCode` | *Optional\* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | | +| `statusText` | *Optional\* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/DataStatus.md b/sync-for-expenses/docs/models/components/DataStatus.md index a7e954fa..c42b65da 100644 --- a/sync-for-expenses/docs/models/components/DataStatus.md +++ b/sync-for-expenses/docs/models/components/DataStatus.md @@ -10,5 +10,5 @@ Describes the state of data in the Codat cache for a company and data type | `currentStatus` | [Status](../../models/components/Status.md) | :heavy_check_mark: | The current status of the dataset. | | | `dataType` | [DataTypes](../../models/components/DataTypes.md) | :heavy_check_mark: | Available data types | invoices | | `lastSuccessfulSync` | *String* | :heavy_check_mark: | 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 | -| `latestSuccessfulSyncId` | *Optional* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | -| `latestSyncId` | *Optional* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file +| `latestSuccessfulSyncId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | +| `latestSyncId` | *Optional\* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ErrorValidation.md b/sync-for-expenses/docs/models/components/ErrorValidation.md index 8665bc8c..2cfad261 100644 --- a/sync-for-expenses/docs/models/components/ErrorValidation.md +++ b/sync-for-expenses/docs/models/components/ErrorValidation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made. If an op ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `errors` | List<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `errors` | List\<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ErrorValidationItem.md b/sync-for-expenses/docs/models/components/ErrorValidationItem.md index 500a8de3..3c4a4160 100644 --- a/sync-for-expenses/docs/models/components/ErrorValidationItem.md +++ b/sync-for-expenses/docs/models/components/ErrorValidationItem.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for a validation item. | -| `message` | *JsonNullable* | :heavy_minus_sign: | A message outlining validation item's issue. | -| `validatorName` | *JsonNullable* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file +| `itemId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *JsonNullable\* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validatorName` | *JsonNullable\* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ExpenseContactRef.md b/sync-for-expenses/docs/models/components/ExpenseContactRef.md index 154b04c4..3b270e7e 100644 --- a/sync-for-expenses/docs/models/components/ExpenseContactRef.md +++ b/sync-for-expenses/docs/models/components/ExpenseContactRef.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `id` | *String* | :heavy_check_mark: | Identifier of supplier or customer. | 40e3e57c-2322-4898-966c-ca41adfd23fd | -| `type` | [Optional](../../models/components/Type.md) | :heavy_minus_sign: | The type of contact. | Supplier | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `id` | *String* | :heavy_check_mark: | Identifier of supplier or customer. | 40e3e57c-2322-4898-966c-ca41adfd23fd | +| `type` | [Optional\](../../models/components/Type.md) | :heavy_minus_sign: | The type of contact. | Supplier | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ExpenseTransaction.md b/sync-for-expenses/docs/models/components/ExpenseTransaction.md index a8ed5c54..afa0785b 100644 --- a/sync-for-expenses/docs/models/components/ExpenseTransaction.md +++ b/sync-for-expenses/docs/models/components/ExpenseTransaction.md @@ -5,14 +5,15 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankAccountRef` | [Optional](../../models/components/BankAccountReference.md) | :heavy_minus_sign: | N/A | | -| `contactRef` | [Optional](../../models/components/ExpenseContactRef.md) | :heavy_minus_sign: | N/A | | +| `bankAccountRef` | [Optional\](../../models/components/BankAccountReference.md) | :heavy_minus_sign: | N/A | | +| `contactRef` | [Optional\](../../models/components/ExpenseContactRef.md) | :heavy_minus_sign: | N/A | | | `currency` | *String* | :heavy_check_mark: | Currency the transaction was recorded in. | GBP | -| `currencyRate` | *JsonNullable* | :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. \| | | +| `currencyRate` | *JsonNullable\* | :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` | *String* | :heavy_check_mark: | Your unique identifier for the transaction. | 4d7c6929-7770-412b-91bb-44d3bc71d111 | | `issueDate` | *String* | :heavy_check_mark: | 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 | -| `lines` | List<[ExpenseTransactionLine](../../models/components/ExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | -| `merchantName` | *Optional* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | -| `notes` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `postAsDraft` | *JsonNullable* | :heavy_minus_sign: | This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central. | | +| `lines` | List\<[ExpenseTransactionLine](../../models/components/ExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | +| `merchantName` | *Optional\* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | +| `notes` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | +| `postAsDraft` | *JsonNullable\* | :heavy_minus_sign: | This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central. | | +| `reference` | *JsonNullable\* | :heavy_minus_sign: | User-friendly reference for the expense transaction. | | | `type` | [ExpenseTransactionType](../../models/components/ExpenseTransactionType.md) | :heavy_check_mark: | The type of transaction. | Payment | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ExpenseTransactionLine.md b/sync-for-expenses/docs/models/components/ExpenseTransactionLine.md index 7dd143dd..83751388 100644 --- a/sync-for-expenses/docs/models/components/ExpenseTransactionLine.md +++ b/sync-for-expenses/docs/models/components/ExpenseTransactionLine.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountRef` | [Optional](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | -| `invoiceTo` | [JsonNullable](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | -| `itemRef` | [JsonNullable](../../models/components/ItemRef.md) | :heavy_minus_sign: | N/A | | +| `accountRef` | [Optional\](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | +| `invoiceTo` | [JsonNullable\](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | +| `itemRef` | [JsonNullable\](../../models/components/ItemRef.md) | :heavy_minus_sign: | N/A | | | `netAmount` | *BigDecimal* | :heavy_check_mark: | Amount of the line, exclusive of tax. | 100 | -| `taxAmount` | *Optional* | :heavy_minus_sign: | Amount of tax for the line. | 20 | -| `taxRateRef` | [Optional](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | -| `trackingRefs` | List<[TrackingRef](../../models/components/TrackingRef.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `taxAmount` | *Optional\* | :heavy_minus_sign: | Amount of tax for the line. | 20 | +| `taxRateRef` | [Optional\](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | +| `trackingRefs` | List\<[TrackingRef](../../models/components/TrackingRef.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ExpensesSyncWebhook.md b/sync-for-expenses/docs/models/components/ExpensesSyncWebhook.md new file mode 100644 index 00000000..c170e02d --- /dev/null +++ b/sync-for-expenses/docs/models/components/ExpensesSyncWebhook.md @@ -0,0 +1,11 @@ +# ExpensesSyncWebhook + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `eventType` | *Optional\* | :heavy_minus_sign: | The type of event. | expenses.sync.successful | +| `generatedDate` | *Optional\* | :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 | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 | +| `payload` | [Optional\](../../models/components/ExpensesSyncWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ExpensesSyncWebhookPayload.md b/sync-for-expenses/docs/models/components/ExpensesSyncWebhookPayload.md new file mode 100644 index 00000000..9fcabfd0 --- /dev/null +++ b/sync-for-expenses/docs/models/components/ExpensesSyncWebhookPayload.md @@ -0,0 +1,10 @@ +# ExpensesSyncWebhookPayload + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `referenceCompany` | [Optional\](../../models/components/CompanyReference.md) | :heavy_minus_sign: | N/A | +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the sync. | +| `transactions` | List\<[Transaction](../../models/components/Transaction.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/HalRef.md b/sync-for-expenses/docs/models/components/HalRef.md index e0c97c05..b65ff569 100644 --- a/sync-for-expenses/docs/models/components/HalRef.md +++ b/sync-for-expenses/docs/models/components/HalRef.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `href` | *Optional* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file +| `href` | *Optional\* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/InvoiceTo.md b/sync-for-expenses/docs/models/components/InvoiceTo.md index 45ec6454..8349d00e 100644 --- a/sync-for-expenses/docs/models/components/InvoiceTo.md +++ b/sync-for-expenses/docs/models/components/InvoiceTo.md @@ -5,7 +5,7 @@ Unique identifier for the customer billed for the transaction. The `invoiceTo` o ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | identifier of customer. | 80000002-1674552702 | -| `type` | [Optional](../../models/components/InvoiceToType.md) | :heavy_minus_sign: | The type of contact. | customer | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `id` | *Optional\* | :heavy_minus_sign: | identifier of customer. | 80000002-1674552702 | +| `type` | [Optional\](../../models/components/InvoiceToType.md) | :heavy_minus_sign: | The type of contact. | customer | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ItemRef.md b/sync-for-expenses/docs/models/components/ItemRef.md index a94934b2..c05853c2 100644 --- a/sync-for-expenses/docs/models/components/ItemRef.md +++ b/sync-for-expenses/docs/models/components/ItemRef.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both. | 80000002-1675158984 | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both. | 80000002-1675158984 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Items.md b/sync-for-expenses/docs/models/components/Items.md index 06efeacc..63e3cea7 100644 --- a/sync-for-expenses/docs/models/components/Items.md +++ b/sync-for-expenses/docs/models/components/Items.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `city` | *JsonNullable* | :heavy_minus_sign: | City of the customer address. | -| `country` | *JsonNullable* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *JsonNullable* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *JsonNullable* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postalCode` | *JsonNullable* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *JsonNullable* | :heavy_minus_sign: | Region of the customer address. | +| `city` | *JsonNullable\* | :heavy_minus_sign: | City of the customer address. | +| `country` | *JsonNullable\* | :heavy_minus_sign: | Country of the customer address. | +| `line1` | *JsonNullable\* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *JsonNullable\* | :heavy_minus_sign: | Line 2 of the customer address. | +| `postalCode` | *JsonNullable\* | :heavy_minus_sign: | Postal code or zip code. | +| `region` | *JsonNullable\* | :heavy_minus_sign: | Region of the customer address. | | `type` | [AccountingAddressType](../../models/components/AccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Links.md b/sync-for-expenses/docs/models/components/Links.md index d53255ac..d829d756 100644 --- a/sync-for-expenses/docs/models/components/Links.md +++ b/sync-for-expenses/docs/models/components/Links.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `current` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | -| `next` | [Optional](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | -| `self` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `current` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | +| `next` | [Optional\](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | +| `previous` | [Optional\](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | +| `self` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/MappingOptions.md b/sync-for-expenses/docs/models/components/MappingOptions.md index d2590639..8e1f4767 100644 --- a/sync-for-expenses/docs/models/components/MappingOptions.md +++ b/sync-for-expenses/docs/models/components/MappingOptions.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `accounts` | List<[AccountMappingInfo](../../models/components/AccountMappingInfo.md)> | :heavy_minus_sign: | Array of available accounts for mapping. | | -| `expenseProvider` | *JsonNullable* | :heavy_minus_sign: | Name of the expense integration. | Partner Expense | -| `taxRates` | List<[TaxRateMappingInfo](../../models/components/TaxRateMappingInfo.md)> | :heavy_minus_sign: | Array of available tax rates for mapping. | | -| `trackingCategories` | List<[TrackingCategoryMappingInfo](../../models/components/TrackingCategoryMappingInfo.md)> | :heavy_minus_sign: | Array of available tracking categories for mapping. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `accounts` | List\<[AccountMappingInfo](../../models/components/AccountMappingInfo.md)> | :heavy_minus_sign: | Array of available accounts for mapping. | | +| `expenseProvider` | *JsonNullable\* | :heavy_minus_sign: | Name of the expense integration. | Partner Expense | +| `taxRates` | List\<[TaxRateMappingInfo](../../models/components/TaxRateMappingInfo.md)> | :heavy_minus_sign: | Array of available tax rates for mapping. | | +| `trackingCategories` | List\<[TrackingCategoryMappingInfo](../../models/components/TrackingCategoryMappingInfo.md)> | :heavy_minus_sign: | Array of available tracking categories for mapping. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Metadata.md b/sync-for-expenses/docs/models/components/Metadata.md index 0a21d56c..89a4ad1b 100644 --- a/sync-for-expenses/docs/models/components/Metadata.md +++ b/sync-for-expenses/docs/models/components/Metadata.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `isDeleted` | *JsonNullable* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file +| `isDeleted` | *JsonNullable\* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Phone.md b/sync-for-expenses/docs/models/components/Phone.md index cf4b74a8..b97fdf8a 100644 --- a/sync-for-expenses/docs/models/components/Phone.md +++ b/sync-for-expenses/docs/models/components/Phone.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `number` | *JsonNullable* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | +| `number` | *JsonNullable\* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | | `type` | [PhoneNumberType](../../models/components/PhoneNumberType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PhoneNumberItems.md b/sync-for-expenses/docs/models/components/PhoneNumberItems.md new file mode 100644 index 00000000..d7efe9d2 --- /dev/null +++ b/sync-for-expenses/docs/models/components/PhoneNumberItems.md @@ -0,0 +1,9 @@ +# PhoneNumberItems + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `number` | *JsonNullable\* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | +| `type` | [PhoneNumberType](../../models/components/PhoneNumberType.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PullOperation.md b/sync-for-expenses/docs/models/components/PullOperation.md index 13cf1202..90a8a6c6 100644 --- a/sync-for-expenses/docs/models/components/PullOperation.md +++ b/sync-for-expenses/docs/models/components/PullOperation.md @@ -9,14 +9,14 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | -| `completed` | *Optional* | :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 | +| `completed` | *Optional\* | :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 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | | `dataType` | *String* | :heavy_check_mark: | The data type you are requesting in a pull operation. | | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about a transient or persistent error returned by Codat or the source platform. | | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about a transient or persistent error returned by Codat or the source platform. | | | `id` | *String* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | | `isCompleted` | *boolean* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | | | `isErrored` | *boolean* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | | `progress` | *long* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `requested` | *String* | :heavy_check_mark: | 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 | | `status` | [DatasetStatus](../../models/components/DatasetStatus.md) | :heavy_check_mark: | The current status of the dataset. | | -| `statusDescription` | *JsonNullable* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z | \ No newline at end of file +| `statusDescription` | *JsonNullable\* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PullOperations.md b/sync-for-expenses/docs/models/components/PullOperations.md index ff7feff5..1997a7bb 100644 --- a/sync-for-expenses/docs/models/components/PullOperations.md +++ b/sync-for-expenses/docs/models/components/PullOperations.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[PullOperation](../../models/components/PullOperation.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[PullOperation](../../models/components/PullOperation.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushFieldValidation.md b/sync-for-expenses/docs/models/components/PushFieldValidation.md index 013f54b0..dab3c713 100644 --- a/sync-for-expenses/docs/models/components/PushFieldValidation.md +++ b/sync-for-expenses/docs/models/components/PushFieldValidation.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `details` | *String* | :heavy_check_mark: | Details on the validation issue. | -| `field` | *Optional* | :heavy_minus_sign: | Field name that resulted in the validation issue. | -| `ref` | *JsonNullable* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file +| `field` | *Optional\* | :heavy_minus_sign: | Field name that resulted in the validation issue. | +| `ref` | *JsonNullable\* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOperation.md b/sync-for-expenses/docs/models/components/PushOperation.md index a956bfcc..5211dc40 100644 --- a/sync-for-expenses/docs/models/components/PushOperation.md +++ b/sync-for-expenses/docs/models/components/PushOperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | +| `completedOnUtc` | *Optional\* | :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 | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOperationChange.md b/sync-for-expenses/docs/models/components/PushOperationChange.md index 3cc2dad8..7e998d75 100644 --- a/sync-for-expenses/docs/models/components/PushOperationChange.md +++ b/sync-for-expenses/docs/models/components/PushOperationChange.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `attachmentId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | -| `recordRef` | [Optional](../../models/components/PushOperationRef.md) | :heavy_minus_sign: | N/A | -| `type` | [Optional](../../models/components/PushChangeType.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `attachmentId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | +| `recordRef` | [Optional\](../../models/components/PushOperationRef.md) | :heavy_minus_sign: | N/A | +| `type` | [Optional\](../../models/components/PushChangeType.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOperationRef.md b/sync-for-expenses/docs/models/components/PushOperationRef.md index af085c5d..03460545 100644 --- a/sync-for-expenses/docs/models/components/PushOperationRef.md +++ b/sync-for-expenses/docs/models/components/PushOperationRef.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOperations.md b/sync-for-expenses/docs/models/components/PushOperations.md index 1eef6307..3b4f29e2 100644 --- a/sync-for-expenses/docs/models/components/PushOperations.md +++ b/sync-for-expenses/docs/models/components/PushOperations.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[PushOperation](../../models/components/PushOperation.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[PushOperation](../../models/components/PushOperation.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOption.md b/sync-for-expenses/docs/models/components/PushOption.md index 6677bd0c..606a5ebe 100644 --- a/sync-for-expenses/docs/models/components/PushOption.md +++ b/sync-for-expenses/docs/models/components/PushOption.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `description` | *Optional* | :heavy_minus_sign: | A description of the property. | -| `displayName` | *String* | :heavy_check_mark: | The property's display name. | -| `options` | List<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | -| `properties` | Map | :heavy_minus_sign: | N/A | -| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *Optional\* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *String* | :heavy_check_mark: | The property's display name. | +| `options` | List\<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | +| `properties` | Map\ | :heavy_minus_sign: | N/A | +| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional\](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOptionChoice.md b/sync-for-expenses/docs/models/components/PushOptionChoice.md index c35f167d..cf30d4f0 100644 --- a/sync-for-expenses/docs/models/components/PushOptionChoice.md +++ b/sync-for-expenses/docs/models/components/PushOptionChoice.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `description` | *Optional* | :heavy_minus_sign: | A description of the property. | -| `displayName` | *Optional* | :heavy_minus_sign: | The property's display name. | -| `required` | *Optional* | :heavy_minus_sign: | The property is required if `True`. | -| `type` | [Optional](../../models/components/PushOptionType.md) | :heavy_minus_sign: | The option type. | -| `value` | *Optional* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `description` | *Optional\* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *Optional\* | :heavy_minus_sign: | The property's display name. | +| `required` | *Optional\* | :heavy_minus_sign: | The property is required if `True`. | +| `type` | [Optional\](../../models/components/PushOptionType.md) | :heavy_minus_sign: | The option type. | +| `value` | *Optional\* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushOptionProperty.md b/sync-for-expenses/docs/models/components/PushOptionProperty.md index ddd70d65..4829813e 100644 --- a/sync-for-expenses/docs/models/components/PushOptionProperty.md +++ b/sync-for-expenses/docs/models/components/PushOptionProperty.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `description` | *String* | :heavy_check_mark: | A description of the property. | -| `displayName` | *String* | :heavy_check_mark: | The property's display name. | -| `options` | List<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | -| `properties` | Map | :heavy_minus_sign: | N/A | -| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *String* | :heavy_check_mark: | A description of the property. | +| `displayName` | *String* | :heavy_check_mark: | The property's display name. | +| `options` | List\<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | +| `properties` | Map\ | :heavy_minus_sign: | N/A | +| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional\](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/PushValidationInfo.md b/sync-for-expenses/docs/models/components/PushValidationInfo.md index 824a0826..8bdba81e 100644 --- a/sync-for-expenses/docs/models/components/PushValidationInfo.md +++ b/sync-for-expenses/docs/models/components/PushValidationInfo.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `information` | List<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `information` | List\<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/RecordRef.md b/sync-for-expenses/docs/models/components/RecordRef.md index 95a334c2..2a80ab96 100644 --- a/sync-for-expenses/docs/models/components/RecordRef.md +++ b/sync-for-expenses/docs/models/components/RecordRef.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | Identifier of linked reference from mapping options. | 40e3e57c-2322-4898-966c-ca41adfd23fd | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Identifier of linked reference from mapping options. | 40e3e57c-2322-4898-966c-ca41adfd23fd | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ReimbursableExpenseTransaction.md b/sync-for-expenses/docs/models/components/ReimbursableExpenseTransaction.md index 6e49dcac..c8b780c1 100644 --- a/sync-for-expenses/docs/models/components/ReimbursableExpenseTransaction.md +++ b/sync-for-expenses/docs/models/components/ReimbursableExpenseTransaction.md @@ -5,12 +5,13 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `apAccountRef` | [JsonNullable\](../../models/components/ApAccountRef.md) | :heavy_minus_sign: | N/A | | | `contactRef` | [ReimbursementContactRef](../../models/components/ReimbursementContactRef.md) | :heavy_check_mark: | N/A | | | `currency` | *String* | :heavy_check_mark: | Currency the transaction was recorded in. | GBP | -| `currencyRate` | *JsonNullable* | :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. \| | | +| `currencyRate` | *JsonNullable\* | :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. \| | | | `dueDate` | *String* | :heavy_check_mark: | 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 | | `id` | *String* | :heavy_check_mark: | Your unique identifier for the transaction. | 4d7c6929-7770-412b-91bb-44d3bc71d111 | | `issueDate` | *String* | :heavy_check_mark: | 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 | -| `lines` | List<[ReimbursableExpenseTransactionLine](../../models/components/ReimbursableExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | -| `notes` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `reference` | *JsonNullable* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | \ No newline at end of file +| `lines` | List\<[ReimbursableExpenseTransactionLine](../../models/components/ReimbursableExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | +| `notes` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | +| `reference` | *JsonNullable\* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ReimbursableExpenseTransactionLine.md b/sync-for-expenses/docs/models/components/ReimbursableExpenseTransactionLine.md index bd019f8c..0ff38568 100644 --- a/sync-for-expenses/docs/models/components/ReimbursableExpenseTransactionLine.md +++ b/sync-for-expenses/docs/models/components/ReimbursableExpenseTransactionLine.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountRef` | [Optional](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | -| `description` | *Optional* | :heavy_minus_sign: | line description | 2-night hotel stay | -| `invoiceTo` | [JsonNullable](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | -| `itemRef` | [JsonNullable](../../models/components/ItemRef.md) | :heavy_minus_sign: | N/A | | +| `accountRef` | [Optional\](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | +| `description` | *Optional\* | :heavy_minus_sign: | line description | 2-night hotel stay | +| `invoiceTo` | [JsonNullable\](../../models/components/InvoiceTo.md) | :heavy_minus_sign: | Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. | | +| `itemRef` | [JsonNullable\](../../models/components/ItemRef.md) | :heavy_minus_sign: | N/A | | | `netAmount` | *BigDecimal* | :heavy_check_mark: | Amount of the line, exclusive of tax. | 100 | -| `taxAmount` | *Optional* | :heavy_minus_sign: | Amount of tax for the line. | 20 | -| `taxRateRef` | [Optional](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | -| `trackingRefs` | List<[TrackingRef](../../models/components/TrackingRef.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `taxAmount` | *Optional\* | :heavy_minus_sign: | Amount of tax for the line. | 20 | +| `taxRateRef` | [Optional\](../../models/components/RecordRef.md) | :heavy_minus_sign: | N/A | | +| `trackingRefs` | List\<[TrackingRef](../../models/components/TrackingRef.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SchemaTransaction.md b/sync-for-expenses/docs/models/components/SchemaTransaction.md new file mode 100644 index 00000000..763b3669 --- /dev/null +++ b/sync-for-expenses/docs/models/components/SchemaTransaction.md @@ -0,0 +1,11 @@ +# SchemaTransaction + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `integrationType` | [JsonNullable\](../../models/components/IntegrationType.md) | :heavy_minus_sign: | Type of transaction that has been processed e.g. Expense or Bank Feed. | expenses | +| `message` | *JsonNullable\* | :heavy_minus_sign: | Metadata such as validation errors or the resulting record created in the accounting software. | | +| `status` | [JsonNullable\](../../models/components/TransactionStatus.md) | :heavy_minus_sign: | Status of the transaction. | Completed | +| `transactionId` | *JsonNullable\* | :heavy_minus_sign: | Your unique idenfier of the transaction. | aa02271d-ed5f-47f5-be76-778d5905225a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SupplementalData.md b/sync-for-expenses/docs/models/components/SupplementalData.md index ec0c9302..8c2b0aa1 100644 --- a/sync-for-expenses/docs/models/components/SupplementalData.md +++ b/sync-for-expenses/docs/models/components/SupplementalData.md @@ -7,6 +7,6 @@ It is referenced as a configured dynamic key value pair that is unique to the ac ## Fields -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `content` | Map> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `content` | Map\> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Supplier.md b/sync-for-expenses/docs/models/components/Supplier.md index 7d29794f..0e816939 100644 --- a/sync-for-expenses/docs/models/components/Supplier.md +++ b/sync-for-expenses/docs/models/components/Supplier.md @@ -1,7 +1,5 @@ # Supplier -> View the coverage for suppliers in the Data coverage explorer. - ## Overview From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). @@ -11,17 +9,17 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the supplier. | | -| `defaultCurrency` | *JsonNullable* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the supplier. | | +| `defaultCurrency` | *JsonNullable\* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [SupplierStatus](../../models/components/SupplierStatus.md) | :heavy_check_mark: | Status of the supplier. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `supplierName` | *JsonNullable* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `supplierName` | *JsonNullable\* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SupplierDetails.md b/sync-for-expenses/docs/models/components/SupplierDetails.md index 242b9c19..b6d6960e 100644 --- a/sync-for-expenses/docs/models/components/SupplierDetails.md +++ b/sync-for-expenses/docs/models/components/SupplierDetails.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Suppliers.md b/sync-for-expenses/docs/models/components/Suppliers.md index 908157d7..aafd7019 100644 --- a/sync-for-expenses/docs/models/components/Suppliers.md +++ b/sync-for-expenses/docs/models/components/Suppliers.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Supplier](../../models/components/Supplier.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Supplier](../../models/components/Supplier.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SyncCompleteWebhook.md b/sync-for-expenses/docs/models/components/SyncCompleteWebhook.md index e22fb35b..5222c813 100644 --- a/sync-for-expenses/docs/models/components/SyncCompleteWebhook.md +++ b/sync-for-expenses/docs/models/components/SyncCompleteWebhook.md @@ -7,11 +7,11 @@ Webhook request body used to notify that a sync has completed. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | | -| `companyId` | *Optional* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional](../../models/components/SyncCompleteWebhookData.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | | +| `companyId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional\](../../models/components/SyncCompleteWebhookData.md) | :heavy_minus_sign: | N/A | | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SyncCompleteWebhookData.md b/sync-for-expenses/docs/models/components/SyncCompleteWebhookData.md index 543ea1ab..ddf3e70d 100644 --- a/sync-for-expenses/docs/models/components/SyncCompleteWebhookData.md +++ b/sync-for-expenses/docs/models/components/SyncCompleteWebhookData.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | -| `syncType` | *Optional* | :heavy_minus_sign: | The type of sync being performed. | | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | +| `syncType` | *Optional\* | :heavy_minus_sign: | The type of sync being performed. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SyncFailedWebhook.md b/sync-for-expenses/docs/models/components/SyncFailedWebhook.md index 94c5902e..35b91a4a 100644 --- a/sync-for-expenses/docs/models/components/SyncFailedWebhook.md +++ b/sync-for-expenses/docs/models/components/SyncFailedWebhook.md @@ -7,11 +7,11 @@ Webhook request body used to notify that a sync has failed. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | | -| `companyId` | *Optional* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional](../../models/components/SyncFailedWebhookData.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | | +| `companyId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional\](../../models/components/SyncFailedWebhookData.md) | :heavy_minus_sign: | N/A | | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/SyncFailedWebhookData.md b/sync-for-expenses/docs/models/components/SyncFailedWebhookData.md index 5a3a22c6..baf15f31 100644 --- a/sync-for-expenses/docs/models/components/SyncFailedWebhookData.md +++ b/sync-for-expenses/docs/models/components/SyncFailedWebhookData.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `failureStage` | *Optional* | :heavy_minus_sign: | The stage of the job the sync failed. | | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | -| `syncType` | *Optional* | :heavy_minus_sign: | The type of sync being performed. | | \ No newline at end of file +| `failureStage` | *Optional\* | :heavy_minus_sign: | The stage of the job the sync failed. | | +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the failed sync. | a9367074-b5c3-42c4-9be4-be129f43577e | +| `syncType` | *Optional\* | :heavy_minus_sign: | The type of sync being performed. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Tags.md b/sync-for-expenses/docs/models/components/Tags.md deleted file mode 100644 index 6de993aa..00000000 --- a/sync-for-expenses/docs/models/components/Tags.md +++ /dev/null @@ -1,9 +0,0 @@ -# Tags - -A collection of user-defined key-value pairs that store custom metadata against the company. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TaxRateMappingInfo.md b/sync-for-expenses/docs/models/components/TaxRateMappingInfo.md index d3fd533c..4eeb66af 100644 --- a/sync-for-expenses/docs/models/components/TaxRateMappingInfo.md +++ b/sync-for-expenses/docs/models/components/TaxRateMappingInfo.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `code` | *JsonNullable* | :heavy_minus_sign: | Code for the tax rate from the accounting software. | 20% Bill tax | -| `effectiveTaxRate` | *Optional* | :heavy_minus_sign: | Effective tax rate. | 20 | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of tax rate. | 23_Bills | -| `name` | *Optional* | :heavy_minus_sign: | Name of the tax rate in the accounting software. | 20% Bill tax Bills | -| `totalTaxRate` | *Optional* | :heavy_minus_sign: | Total (not compounded) sum of the components of a tax rate. | 20 | -| `validTransactionTypes` | List<[ValidTransactionTypes](../../models/components/ValidTransactionTypes.md)> | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `code` | *JsonNullable\* | :heavy_minus_sign: | Code for the tax rate from the accounting software. | 20% Bill tax | +| `effectiveTaxRate` | *Optional\* | :heavy_minus_sign: | Effective tax rate. | 20 | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of tax rate. | 23_Bills | +| `name` | *Optional\* | :heavy_minus_sign: | Name of the tax rate in the accounting software. | 20% Bill tax Bills | +| `totalTaxRate` | *Optional\* | :heavy_minus_sign: | Total (not compounded) sum of the components of a tax rate. | 20 | +| `validTransactionTypes` | List\<[ValidTransactionTypes](../../models/components/ValidTransactionTypes.md)> | :heavy_minus_sign: | Supported transaction types for the account. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TrackingCategoryMappingInfo.md b/sync-for-expenses/docs/models/components/TrackingCategoryMappingInfo.md index 3b36e67e..1eee0349 100644 --- a/sync-for-expenses/docs/models/components/TrackingCategoryMappingInfo.md +++ b/sync-for-expenses/docs/models/components/TrackingCategoryMappingInfo.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `hasChildren` | *Optional* | :heavy_minus_sign: | Boolean of whether the tracking category has child categories. | | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the tracking category. | DEPARTMENT_2 | -| `name` | *Optional* | :heavy_minus_sign: | Name of the tracking category as it appears in the accounting software. | New York | -| `parentId` | *JsonNullable* | :heavy_minus_sign: | ID of the parent tracking category | DEPARTMENTS | \ No newline at end of file +| `hasChildren` | *Optional\* | :heavy_minus_sign: | Boolean of whether the tracking category has child categories. | | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the tracking category. | DEPARTMENT_2 | +| `name` | *Optional\* | :heavy_minus_sign: | Name of the tracking category as it appears in the accounting software. | New York | +| `parentId` | *JsonNullable\* | :heavy_minus_sign: | ID of the parent tracking category | DEPARTMENTS | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TrackingRef.md b/sync-for-expenses/docs/models/components/TrackingRef.md index b182d5da..8e81d636 100644 --- a/sync-for-expenses/docs/models/components/TrackingRef.md +++ b/sync-for-expenses/docs/models/components/TrackingRef.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `dataType` | [Optional](../../models/components/TrackingRefDataType.md) | :heavy_minus_sign: | The type of the linked reference | trackingCategories | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. | e9a1b63d-9ff0-40e7-8038-016354b987e6 | \ No newline at end of file +| `dataType` | [Optional\](../../models/components/TrackingRefDataType.md) | :heavy_minus_sign: | The type of the linked reference | trackingCategories | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. | e9a1b63d-9ff0-40e7-8038-016354b987e6 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TrackingRefAdjustmentTransaction.md b/sync-for-expenses/docs/models/components/TrackingRefAdjustmentTransaction.md index d48fd45b..0c423bc9 100644 --- a/sync-for-expenses/docs/models/components/TrackingRefAdjustmentTransaction.md +++ b/sync-for-expenses/docs/models/components/TrackingRefAdjustmentTransaction.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `dataType` | [Optional](../../models/components/TrackingRefAdjustmentTransactionDataType.md) | :heavy_minus_sign: | The type of the linked reference | trackingCategories | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. | e9a1b63d-9ff0-40e7-8038-016354b987e6 | \ No newline at end of file +| `dataType` | [Optional\](../../models/components/TrackingRefAdjustmentTransactionDataType.md) | :heavy_minus_sign: | The type of the linked reference | trackingCategories | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. | e9a1b63d-9ff0-40e7-8038-016354b987e6 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Transaction.md b/sync-for-expenses/docs/models/components/Transaction.md index ad3d7029..80644cd9 100644 --- a/sync-for-expenses/docs/models/components/Transaction.md +++ b/sync-for-expenses/docs/models/components/Transaction.md @@ -3,9 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `integrationType` | [JsonNullable](../../models/components/IntegrationType.md) | :heavy_minus_sign: | Type of transaction that has been processed e.g. Expense or Bank Feed. | expenses | -| `message` | *JsonNullable* | :heavy_minus_sign: | Metadata such as validation errors or the resulting record created in the accounting software. | | -| `status` | [JsonNullable](../../models/components/TransactionStatus.md) | :heavy_minus_sign: | Status of the transaction. | Completed | -| `transactionId` | *JsonNullable* | :heavy_minus_sign: | Your unique idenfier of the transaction. | aa02271d-ed5f-47f5-be76-778d5905225a | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | Error message for failed transaction. | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the transaction. | +| `status` | [Optional\](../../models/components/TransactionDefinitionsStatus.md) | :heavy_minus_sign: | Status of transaction. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TransactionDefinitionsStatus.md b/sync-for-expenses/docs/models/components/TransactionDefinitionsStatus.md new file mode 100644 index 00000000..ab0d38dd --- /dev/null +++ b/sync-for-expenses/docs/models/components/TransactionDefinitionsStatus.md @@ -0,0 +1,14 @@ +# TransactionDefinitionsStatus + +Status of transaction. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `UNKNOWN` | Unknown | +| `PUSH_ERROR` | PushError | +| `COMPLETED` | Completed | +| `FAILED` | Failed | +| `PENDING` | Pending | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Transactions.md b/sync-for-expenses/docs/models/components/Transactions.md index ef3d2c6b..ad40eba3 100644 --- a/sync-for-expenses/docs/models/components/Transactions.md +++ b/sync-for-expenses/docs/models/components/Transactions.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Transaction](../../models/components/Transaction.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[SchemaTransaction](../../models/components/SchemaTransaction.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TransferTransactionRequest.md b/sync-for-expenses/docs/models/components/TransferTransactionRequest.md index b53b3aea..8366bc0e 100644 --- a/sync-for-expenses/docs/models/components/TransferTransactionRequest.md +++ b/sync-for-expenses/docs/models/components/TransferTransactionRequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | | `date` | *String* | :heavy_check_mark: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `description` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | Transfer from bank account Y to bank account Z | +| `description` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | Transfer from bank account Y to bank account Z | | `from` | [From](../../models/components/From.md) | :heavy_check_mark: | N/A | | | `to` | [To](../../models/components/To.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/TransferTransactionResponse.md b/sync-for-expenses/docs/models/components/TransferTransactionResponse.md index e12363d1..1c65bc28 100644 --- a/sync-for-expenses/docs/models/components/TransferTransactionResponse.md +++ b/sync-for-expenses/docs/models/components/TransferTransactionResponse.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique id of sync created | cd937d46-8e41-43a9-9477-a79158ffd98a | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateCustomerResponse.md b/sync-for-expenses/docs/models/components/UpdateCustomerResponse.md index 19c9e8e9..62e550f1 100644 --- a/sync-for-expenses/docs/models/components/UpdateCustomerResponse.md +++ b/sync-for-expenses/docs/models/components/UpdateCustomerResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/UpdateCustomerResponseAccountingCustomer.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/UpdateCustomerResponseAccountingCustomer.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingAddress.md b/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingAddress.md deleted file mode 100644 index 859468ff..00000000 --- a/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingAddress.md +++ /dev/null @@ -1,14 +0,0 @@ -# UpdateCustomerResponseAccountingAddress - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `city` | *JsonNullable* | :heavy_minus_sign: | City of the customer address. | -| `country` | *JsonNullable* | :heavy_minus_sign: | Country of the customer address. | -| `line1` | *JsonNullable* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *JsonNullable* | :heavy_minus_sign: | Line 2 of the customer address. | -| `postalCode` | *JsonNullable* | :heavy_minus_sign: | Postal code or zip code. | -| `region` | *JsonNullable* | :heavy_minus_sign: | Region of the customer address. | -| `type` | [AccountingAddressType](../../models/components/AccountingAddressType.md) | :heavy_check_mark: | The type of the address | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingCustomer.md b/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingCustomer.md index f8e1dd81..c23b2d9a 100644 --- a/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingCustomer.md +++ b/sync-for-expenses/docs/models/components/UpdateCustomerResponseAccountingCustomer.md @@ -1,7 +1,5 @@ # ~~UpdateCustomerResponseAccountingCustomer~~ -> View the coverage for customers in the Data coverage explorer. - ## Overview A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). @@ -16,18 +14,18 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/sy | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[UpdateCustomerResponseAccountingAddress](../../models/components/UpdateCustomerResponseAccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | -| `contacts` | List<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | -| `customerName` | *JsonNullable* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | -| `defaultCurrency` | *Optional* | :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 | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address the customer can be contacted by. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | +| `contacts` | List\<[Contact](../../models/components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | +| `customerName` | *JsonNullable\* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | +| `defaultCurrency` | *Optional\* | :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 | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address the customer can be contacted by. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number. In the UK, this is typically the Companies House company registration number. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [CustomerStatus](../../models/components/CustomerStatus.md) | :heavy_check_mark: | Status of customer. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateExpenseRequest.md b/sync-for-expenses/docs/models/components/UpdateExpenseRequest.md index 1335c366..291c3244 100644 --- a/sync-for-expenses/docs/models/components/UpdateExpenseRequest.md +++ b/sync-for-expenses/docs/models/components/UpdateExpenseRequest.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankAccountRef` | [Optional](../../models/components/UpdateExpenseRequestBankAccountReference.md) | :heavy_minus_sign: | N/A | | -| `contactRef` | [Optional](../../models/components/ExpenseContactRef.md) | :heavy_minus_sign: | N/A | | +| `bankAccountRef` | [Optional\](../../models/components/UpdateExpenseRequestBankAccountReference.md) | :heavy_minus_sign: | N/A | | +| `contactRef` | [Optional\](../../models/components/ExpenseContactRef.md) | :heavy_minus_sign: | N/A | | | `currency` | *String* | :heavy_check_mark: | Currency the transaction was recorded in. | GBP | -| `currencyRate` | *JsonNullable* | :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. \| | | +| `currencyRate` | *JsonNullable\* | :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. \| | | | `issueDate` | *String* | :heavy_check_mark: | Date the transaction was recorded. | 2022-06-28T00:00:00.000Z | -| `lines` | List<[ExpenseTransactionLine](../../models/components/ExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | -| `merchantName` | *Optional* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | -| `notes` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | +| `lines` | List\<[ExpenseTransactionLine](../../models/components/ExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | +| `merchantName` | *Optional\* | :heavy_minus_sign: | Name of the merchant where the purchase took place | Amazon UK | +| `notes` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | | `type` | [UpdateExpenseRequestType](../../models/components/UpdateExpenseRequestType.md) | :heavy_check_mark: | The type of transaction. | Payment | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateExpenseRequestBankAccountReference.md b/sync-for-expenses/docs/models/components/UpdateExpenseRequestBankAccountReference.md index 9155add7..583de22e 100644 --- a/sync-for-expenses/docs/models/components/UpdateExpenseRequestBankAccountReference.md +++ b/sync-for-expenses/docs/models/components/UpdateExpenseRequestBankAccountReference.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Identifier of the bank account. | 787dfb37-5707-4dc0-8a86-8d74e4cc78ea | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Identifier of the bank account. | 787dfb37-5707-4dc0-8a86-8d74e4cc78ea | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateExpenseResponse.md b/sync-for-expenses/docs/models/components/UpdateExpenseResponse.md index d393c7d1..dd0bebc1 100644 --- a/sync-for-expenses/docs/models/components/UpdateExpenseResponse.md +++ b/sync-for-expenses/docs/models/components/UpdateExpenseResponse.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `syncId` | *Optional* | :heavy_minus_sign: | Unique identifier for the update expense sync. | \ No newline at end of file +| `syncId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the update expense sync. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateReimbursableExpenseTransactionRequest.md b/sync-for-expenses/docs/models/components/UpdateReimbursableExpenseTransactionRequest.md index ea1f25b6..6ff57304 100644 --- a/sync-for-expenses/docs/models/components/UpdateReimbursableExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/models/components/UpdateReimbursableExpenseTransactionRequest.md @@ -5,11 +5,12 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `apAccountRef` | [JsonNullable\](../../models/components/ApAccountRef.md) | :heavy_minus_sign: | N/A | | | `contactRef` | [ReimbursementContactRef](../../models/components/ReimbursementContactRef.md) | :heavy_check_mark: | N/A | | | `currency` | *String* | :heavy_check_mark: | Currency the transaction was recorded in. | GBP | -| `currencyRate` | *JsonNullable* | :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. \| | | +| `currencyRate` | *JsonNullable\* | :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. \| | | | `dueDate` | *String* | :heavy_check_mark: | 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 | | `issueDate` | *String* | :heavy_check_mark: | 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 | -| `lines` | List<[ReimbursableExpenseTransactionLine](../../models/components/ReimbursableExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | -| `notes` | *Optional* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | -| `reference` | *JsonNullable* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | \ No newline at end of file +| `lines` | List\<[ReimbursableExpenseTransactionLine](../../models/components/ReimbursableExpenseTransactionLine.md)> | :heavy_minus_sign: | Array of transaction lines. | | +| `notes` | *Optional\* | :heavy_minus_sign: | Any private, company notes about the transaction. | APPLE.COM/BILL - 09001077498 - Card Ending: 4590 | +| `reference` | *JsonNullable\* | :heavy_minus_sign: | User-friendly reference for the reimbursable expense. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateSupplierResponse.md b/sync-for-expenses/docs/models/components/UpdateSupplierResponse.md index 7397afb8..0eeb3679 100644 --- a/sync-for-expenses/docs/models/components/UpdateSupplierResponse.md +++ b/sync-for-expenses/docs/models/components/UpdateSupplierResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :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 | -| `data` | [JsonNullable](../../models/components/UpdateSupplierResponseAccountingSupplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | +| `completedOnUtc` | *Optional\* | :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 | +| `data` | [JsonNullable\](../../models/components/UpdateSupplierResponseAccountingSupplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | 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 | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/UpdateSupplierResponseAccountingSupplier.md b/sync-for-expenses/docs/models/components/UpdateSupplierResponseAccountingSupplier.md index 017032e1..81fb327a 100644 --- a/sync-for-expenses/docs/models/components/UpdateSupplierResponseAccountingSupplier.md +++ b/sync-for-expenses/docs/models/components/UpdateSupplierResponseAccountingSupplier.md @@ -1,7 +1,5 @@ # ~~UpdateSupplierResponseAccountingSupplier~~ -> View the coverage for suppliers in the Data coverage explorer. - ## Overview From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). @@ -13,17 +11,17 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addresses` | List<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | -| `contactName` | *JsonNullable* | :heavy_minus_sign: | Name of the main contact for the supplier. | | -| `defaultCurrency` | *JsonNullable* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `phone` | *JsonNullable* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | -| `registrationNumber` | *JsonNullable* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `addresses` | List\<[Items](../../models/components/Items.md)> | :heavy_minus_sign: | An array of Addresses. | | +| `contactName` | *JsonNullable\* | :heavy_minus_sign: | Name of the main contact for the supplier. | | +| `defaultCurrency` | *JsonNullable\* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | | +| `emailAddress` | *JsonNullable\* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `phone` | *JsonNullable\* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | +| `registrationNumber` | *JsonNullable\* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | | `status` | [SupplierStatus](../../models/components/SupplierStatus.md) | :heavy_check_mark: | Status of the supplier. | | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `supplierName` | *JsonNullable* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | -| `taxNumber` | *JsonNullable* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | +| `supplierName` | *JsonNullable\* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | +| `taxNumber` | *JsonNullable\* | :heavy_minus_sign: | Supplier's company tax number. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ValidDataTypeLinks.md b/sync-for-expenses/docs/models/components/ValidDataTypeLinks.md index 152f6b8e..cefb3677 100644 --- a/sync-for-expenses/docs/models/components/ValidDataTypeLinks.md +++ b/sync-for-expenses/docs/models/components/ValidDataTypeLinks.md @@ -46,5 +46,5 @@ If you'd like us to extend support to more data types or integrations, suggest o | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `links` | List<*String*> | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | -| `property` | *JsonNullable* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file +| `links` | List\<*String*> | :heavy_minus_sign: | Supported `dataTypes` that the record can be linked to. | +| `property` | *JsonNullable\* | :heavy_minus_sign: | The property from the account that can be linked. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ValidFor.md b/sync-for-expenses/docs/models/components/ValidFor.md new file mode 100644 index 00000000..4d6bb507 --- /dev/null +++ b/sync-for-expenses/docs/models/components/ValidFor.md @@ -0,0 +1,14 @@ +# ValidFor + + +## Values + +| Name | Value | +| ----------------------------------- | ----------------------------------- | +| `EXPENSE_TRANSACTIONS_PAYMENT` | expense-transactions.Payment | +| `EXPENSE_TRANSACTIONS_REFUND` | expense-transactions.Refund | +| `EXPENSE_TRANSACTIONS_REWARD` | expense-transactions.Reward | +| `EXPENSE_TRANSACTIONS_CHARGEBACK` | expense-transactions.Chargeback | +| `REIMBURSABLE_EXPENSE_TRANSACTIONS` | reimbursable-expense-transactions | +| `TRANSFER_TRANSACTIONS` | transfer-transactions | +| `ADJUSTMENT_TRANSACTIONS` | adjustment-transactions | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Validation.md b/sync-for-expenses/docs/models/components/Validation.md index f214d48c..ad25f1d1 100644 --- a/sync-for-expenses/docs/models/components/Validation.md +++ b/sync-for-expenses/docs/models/components/Validation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made when push ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `errors` | List<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `errors` | List\<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/ValidationItem.md b/sync-for-expenses/docs/models/components/ValidationItem.md index d0cc54dc..eda568c5 100644 --- a/sync-for-expenses/docs/models/components/ValidationItem.md +++ b/sync-for-expenses/docs/models/components/ValidationItem.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for a validation item. | -| `message` | *JsonNullable* | :heavy_minus_sign: | A message outlining validation item's issue. | -| `validatorName` | *JsonNullable* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file +| `itemId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *JsonNullable\* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validatorName` | *JsonNullable\* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/Weblink.md b/sync-for-expenses/docs/models/components/Weblink.md new file mode 100644 index 00000000..1705957e --- /dev/null +++ b/sync-for-expenses/docs/models/components/Weblink.md @@ -0,0 +1,11 @@ +# Weblink + +Weblink associated with the company. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `type` | [Optional\](../../models/components/CompanyInformationType.md) | :heavy_minus_sign: | The type of the weblink. | +| `url` | *Optional\* | :heavy_minus_sign: | The full URL for the weblink. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/errors/ErrorMessage.md b/sync-for-expenses/docs/models/errors/ErrorMessage.md index fbd0a775..e10178f0 100644 --- a/sync-for-expenses/docs/models/errors/ErrorMessage.md +++ b/sync-for-expenses/docs/models/errors/ErrorMessage.md @@ -1,16 +1,16 @@ # ErrorMessage -The request made is not valid. +Your `query` parameter was not correctly formed ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `canBeRetried` | *Optional* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | -| `correlationId` | *Optional* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | -| `detailedErrorCode` | *Optional* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | -| `error` | *Optional* | :heavy_minus_sign: | A brief description of the error. | -| `service` | *Optional* | :heavy_minus_sign: | Codat's service the returned the error. | -| `statusCode` | *Optional* | :heavy_minus_sign: | The HTTP status code returned by the error. | -| `validation` | [JsonNullable](../../models/components/ErrorValidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. | \ No newline at end of file +| `canBeRetried` | *Optional\* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlationId` | *Optional\* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailedErrorCode` | *Optional\* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *Optional\* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *Optional\* | :heavy_minus_sign: | Codat's service the returned the error. | +| `statusCode` | *Optional\* | :heavy_minus_sign: | The HTTP status code returned by the error. | +| `validation` | [JsonNullable\](../../models/components/ErrorValidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateAccountRequest.md b/sync-for-expenses/docs/models/operations/CreateAccountRequest.md index c6be8b34..12460e49 100644 --- a/sync-for-expenses/docs/models/operations/CreateAccountRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateAccountRequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `accountPrototype` | [Optional](../../models/components/AccountPrototype.md) | :heavy_minus_sign: | N/A | | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `accountPrototype` | [Optional\](../../models/components/AccountPrototype.md) | :heavy_minus_sign: | N/A | | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateAccountResponse.md b/sync-for-expenses/docs/models/operations/CreateAccountResponse.md index 4064630e..8a0a4489 100644 --- a/sync-for-expenses/docs/models/operations/CreateAccountResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateAccountResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createAccountResponse` | [Optional](../../models/components/CreateAccountResponse.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createAccountResponse` | [Optional\](../../models/components/CreateAccountResponse.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionRequest.md b/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionRequest.md index dd2d331c..55fad01e 100644 --- a/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `requestBody` | List<[AdjustmentTransactionRequest](../../models/components/AdjustmentTransactionRequest.md)> | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `requestBody` | List\<[AdjustmentTransactionRequest](../../models/components/AdjustmentTransactionRequest.md)> | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionResponse.md b/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionResponse.md index 2c69eb5a..fd15da2a 100644 --- a/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateAdjustmentTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `adjustmentTransactionResponse` | [Optional](../../models/components/AdjustmentTransactionResponse.md) | :heavy_minus_sign: | OK | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `adjustmentTransactionResponse` | [Optional\](../../models/components/AdjustmentTransactionResponse.md) | :heavy_minus_sign: | OK | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateBankAccountRequest.md b/sync-for-expenses/docs/models/operations/CreateBankAccountRequest.md index 48d8697a..3398d8ef 100644 --- a/sync-for-expenses/docs/models/operations/CreateBankAccountRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateBankAccountRequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `bankAccount` | [JsonNullable](../../models/components/BankAccount.md) | :heavy_minus_sign: | N/A | | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `bankAccount` | [JsonNullable\](../../models/components/BankAccount.md) | :heavy_minus_sign: | N/A | | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateBankAccountResponse.md b/sync-for-expenses/docs/models/operations/CreateBankAccountResponse.md index 166d129a..1d757b48 100644 --- a/sync-for-expenses/docs/models/operations/CreateBankAccountResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateBankAccountResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createBankAccountResponse` | [Optional](../../models/components/CreateBankAccountResponse.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createBankAccountResponse` | [Optional\](../../models/components/CreateBankAccountResponse.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateCompanyResponse.md b/sync-for-expenses/docs/models/operations/CreateCompanyResponse.md index 01ade6c4..f0e7fb68 100644 --- a/sync-for-expenses/docs/models/operations/CreateCompanyResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateConnectionRequest.md b/sync-for-expenses/docs/models/operations/CreateConnectionRequest.md index 9aafcbb8..9edc7d43 100644 --- a/sync-for-expenses/docs/models/operations/CreateConnectionRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateConnectionRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `requestBody` | [Optional](../../models/operations/CreateConnectionRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `requestBody` | [Optional\](../../models/operations/CreateConnectionRequestBody.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateConnectionRequestBody.md b/sync-for-expenses/docs/models/operations/CreateConnectionRequestBody.md index f05cc6ab..da4f839d 100644 --- a/sync-for-expenses/docs/models/operations/CreateConnectionRequestBody.md +++ b/sync-for-expenses/docs/models/operations/CreateConnectionRequestBody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `platformKey` | *Optional* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file +| `platformKey` | *Optional\* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateConnectionResponse.md b/sync-for-expenses/docs/models/operations/CreateConnectionResponse.md index 88d793fb..b368d1db 100644 --- a/sync-for-expenses/docs/models/operations/CreateConnectionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateCustomerRequest.md b/sync-for-expenses/docs/models/operations/CreateCustomerRequest.md index 1615e3fe..ad0f0c6f 100644 --- a/sync-for-expenses/docs/models/operations/CreateCustomerRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateCustomerRequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `customer` | [JsonNullable](../../models/components/Customer.md) | :heavy_minus_sign: | N/A | | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `customer` | [JsonNullable\](../../models/components/Customer.md) | :heavy_minus_sign: | N/A | | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateCustomerResponse.md b/sync-for-expenses/docs/models/operations/CreateCustomerResponse.md index dd07291a..d297309f 100644 --- a/sync-for-expenses/docs/models/operations/CreateCustomerResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateCustomerResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createCustomerResponse` | [Optional](../../models/components/CreateCustomerResponse.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createCustomerResponse` | [Optional\](../../models/components/CreateCustomerResponse.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateExpenseTransactionRequest.md b/sync-for-expenses/docs/models/operations/CreateExpenseTransactionRequest.md index ec85676e..9c1a5c7b 100644 --- a/sync-for-expenses/docs/models/operations/CreateExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateExpenseTransactionRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `requestBody` | List<[ExpenseTransaction](../../models/components/ExpenseTransaction.md)> | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `requestBody` | List\<[ExpenseTransaction](../../models/components/ExpenseTransaction.md)> | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateExpenseTransactionResponse.md b/sync-for-expenses/docs/models/operations/CreateExpenseTransactionResponse.md index 6f264b2b..35c77edc 100644 --- a/sync-for-expenses/docs/models/operations/CreateExpenseTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateExpenseTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createExpenseResponse` | [Optional](../../models/components/CreateExpenseResponse.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createExpenseResponse` | [Optional\](../../models/components/CreateExpenseResponse.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreatePartnerExpenseConnectionResponse.md b/sync-for-expenses/docs/models/operations/CreatePartnerExpenseConnectionResponse.md index 1b48bece..c6b13b8c 100644 --- a/sync-for-expenses/docs/models/operations/CreatePartnerExpenseConnectionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreatePartnerExpenseConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | Success | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | Success | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionRequest.md b/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionRequest.md index 6ce71ec3..e26f4008 100644 --- a/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `requestBody` | List<[ReimbursableExpenseTransaction](../../models/components/ReimbursableExpenseTransaction.md)> | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `requestBody` | List\<[ReimbursableExpenseTransaction](../../models/components/ReimbursableExpenseTransaction.md)> | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionResponse.md b/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionResponse.md index d9695f74..4c358225 100644 --- a/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateReimbursableExpenseTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createReimbursableExpenseResponse` | [Optional](../../models/components/CreateReimbursableExpenseResponse.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createReimbursableExpenseResponse` | [Optional\](../../models/components/CreateReimbursableExpenseResponse.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateSupplierRequest.md b/sync-for-expenses/docs/models/operations/CreateSupplierRequest.md index 12444ff0..8b179664 100644 --- a/sync-for-expenses/docs/models/operations/CreateSupplierRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateSupplierRequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `supplier` | [JsonNullable](../../models/components/Supplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `supplier` | [JsonNullable\](../../models/components/Supplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateSupplierResponse.md b/sync-for-expenses/docs/models/operations/CreateSupplierResponse.md index 8ac47bbe..b6b02c35 100644 --- a/sync-for-expenses/docs/models/operations/CreateSupplierResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateSupplierResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createSupplierResponse` | [Optional](../../models/components/CreateSupplierResponse.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createSupplierResponse` | [Optional\](../../models/components/CreateSupplierResponse.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateTransferTransactionRequest.md b/sync-for-expenses/docs/models/operations/CreateTransferTransactionRequest.md index 270e5731..b9e680a2 100644 --- a/sync-for-expenses/docs/models/operations/CreateTransferTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/CreateTransferTransactionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `transferTransactionRequest` | [Optional](../../models/components/TransferTransactionRequest.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `transferTransactionRequest` | [Optional\](../../models/components/TransferTransactionRequest.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/CreateTransferTransactionResponse.md b/sync-for-expenses/docs/models/operations/CreateTransferTransactionResponse.md index bc578598..6fb8d4b7 100644 --- a/sync-for-expenses/docs/models/operations/CreateTransferTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/CreateTransferTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `transferTransactionResponse` | [Optional](../../models/components/TransferTransactionResponse.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `transferTransactionResponse` | [Optional\](../../models/components/TransferTransactionResponse.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/DeleteCompanyResponse.md b/sync-for-expenses/docs/models/operations/DeleteCompanyResponse.md index d0feee97..ec962677 100644 --- a/sync-for-expenses/docs/models/operations/DeleteCompanyResponse.md +++ b/sync-for-expenses/docs/models/operations/DeleteCompanyResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/DeleteConnectionResponse.md b/sync-for-expenses/docs/models/operations/DeleteConnectionResponse.md index 1fc7d9a2..7ca58b59 100644 --- a/sync-for-expenses/docs/models/operations/DeleteConnectionResponse.md +++ b/sync-for-expenses/docs/models/operations/DeleteConnectionResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCompanyConfigurationResponse.md b/sync-for-expenses/docs/models/operations/GetCompanyConfigurationResponse.md index a117c991..d883fac9 100644 --- a/sync-for-expenses/docs/models/operations/GetCompanyConfigurationResponse.md +++ b/sync-for-expenses/docs/models/operations/GetCompanyConfigurationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companyConfiguration` | [Optional](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companyConfiguration` | [Optional\](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/components/GroupReference.md b/sync-for-expenses/docs/models/operations/GetCompanyInfoRequest.md similarity index 65% rename from sync-for-expenses/docs/models/components/GroupReference.md rename to sync-for-expenses/docs/models/operations/GetCompanyInfoRequest.md index 638321db..b64acd7a 100644 --- a/sync-for-expenses/docs/models/components/GroupReference.md +++ b/sync-for-expenses/docs/models/operations/GetCompanyInfoRequest.md @@ -1,8 +1,8 @@ -# GroupReference +# GetCompanyInfoRequest ## Fields | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the group. | 60d2fa12-8a04-11ee-b9d1-0242ac120002 | \ No newline at end of file +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCompanyInfoResponse.md b/sync-for-expenses/docs/models/operations/GetCompanyInfoResponse.md new file mode 100644 index 00000000..5565abfa --- /dev/null +++ b/sync-for-expenses/docs/models/operations/GetCompanyInfoResponse.md @@ -0,0 +1,11 @@ +# GetCompanyInfoResponse + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `companyInformation` | [Optional\](../../models/components/CompanyInformation.md) | :heavy_minus_sign: | Success | {
"companyName": "ACME Corporation",
"accountingPlatformRef": "4444e827-401b-4925-92cb-d79086bf3b6b",
"companyLegalName": "ACME Corporation Ltd.",
"addresses": [
{
"type": "Billing",
"line1": "Warner House",
"line2": "98 Theobald's Road",
"city": "London",
"region": "",
"country": "United Kingdom",
"postalcode": "WC1X 8WB"
},
{
"type": "Unknown",
"line1": "123 Sierra Way",
"line2": "",
"city": "San Pablo",
"region": "CA",
"country": "",
"postalCode": "87999"
}
],
"phoneNumbers": [
{
"number": "010 1234 5678",
"type": "Landline"
}
],
"webLinks": [
{
"type": "Website",
"url": "https://www.wbsl.com/"
}
],
"ledgerLockDate": "2019-03-04T12:08:01.881Z",
"registrationNumber": "1234567890",
"taxNumber": "GB 123456789",
"financialYearStartDate": "2019-04-01T00:00:00Z",
"baseCurrency": "USD",
"sourceUrls": {
"url1": "https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q",
"url2": "https://reporting.xero.com/!rxs0Q"
},
"createdDate": "2020-02-03T16:42:02Z"
} | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCompanyResponse.md b/sync-for-expenses/docs/models/operations/GetCompanyResponse.md index ddc005f7..3a39749f 100644 --- a/sync-for-expenses/docs/models/operations/GetCompanyResponse.md +++ b/sync-for-expenses/docs/models/operations/GetCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetConnectionResponse.md b/sync-for-expenses/docs/models/operations/GetConnectionResponse.md index c4d7d3c4..fdd0cde7 100644 --- a/sync-for-expenses/docs/models/operations/GetConnectionResponse.md +++ b/sync-for-expenses/docs/models/operations/GetConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCreateBankAccountsModelResponse.md b/sync-for-expenses/docs/models/operations/GetCreateBankAccountsModelResponse.md index cdc8abaa..cc1ac7bd 100644 --- a/sync-for-expenses/docs/models/operations/GetCreateBankAccountsModelResponse.md +++ b/sync-for-expenses/docs/models/operations/GetCreateBankAccountsModelResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `pushOption` | [Optional](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `pushOption` | [Optional\](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCreateChartOfAccountsModelResponse.md b/sync-for-expenses/docs/models/operations/GetCreateChartOfAccountsModelResponse.md index 127a7da3..f9670807 100644 --- a/sync-for-expenses/docs/models/operations/GetCreateChartOfAccountsModelResponse.md +++ b/sync-for-expenses/docs/models/operations/GetCreateChartOfAccountsModelResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `pushOption` | [Optional](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `pushOption` | [Optional\](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCustomerRequest.md b/sync-for-expenses/docs/models/operations/GetCustomerRequest.md index ae5fa161..0e318cdf 100644 --- a/sync-for-expenses/docs/models/operations/GetCustomerRequest.md +++ b/sync-for-expenses/docs/models/operations/GetCustomerRequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `customerId` | *String* | :heavy_check_mark: | Unique identifier for a customer. | | \ No newline at end of file +| `customerId` | *String* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetCustomerResponse.md b/sync-for-expenses/docs/models/operations/GetCustomerResponse.md index 669c43ce..223b1f17 100644 --- a/sync-for-expenses/docs/models/operations/GetCustomerResponse.md +++ b/sync-for-expenses/docs/models/operations/GetCustomerResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `customer` | [JsonNullable](../../models/components/Customer.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `customer` | [JsonNullable\](../../models/components/Customer.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetDataStatusDataStatuses.md b/sync-for-expenses/docs/models/operations/GetDataStatusDataStatuses.md index 6868be5a..32f1cb1f 100644 --- a/sync-for-expenses/docs/models/operations/GetDataStatusDataStatuses.md +++ b/sync-for-expenses/docs/models/operations/GetDataStatusDataStatuses.md @@ -7,46 +7,46 @@ OK | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountTransactions` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `balanceSheet` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankAccounts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankTransactions` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankingAccountBalances` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankingAccounts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankingTransactionCategories` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bankingTransactions` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `billCreditNotes` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `billPayments` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `bills` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `cashFlowStatement` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `chartOfAccounts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceCompanyInfo` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceCustomers` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceDisputes` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceLocations` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceOrders` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commercePaymentMethods` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commercePayments` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceProductCategories` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceProducts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceTaxComponents` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `commerceTransactions` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `company` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `creditNotes` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `customers` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `directCosts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `directIncomes` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `invoices` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `itemReceipts` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `items` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `journalEntries` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `journals` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `paymentMethods` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `payments` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `profitAndLoss` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `purchaseOrders` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `salesOrders` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `suppliers` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `taxRates` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `trackingCategories` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | -| `transfers` | [Optional](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | \ No newline at end of file +| `accountTransactions` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `balanceSheet` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankAccounts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankTransactions` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankingAccountBalances` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankingAccounts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankingTransactionCategories` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bankingTransactions` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `billCreditNotes` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `billPayments` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `bills` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `cashFlowStatement` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `chartOfAccounts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceCompanyInfo` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceCustomers` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceDisputes` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceLocations` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceOrders` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commercePaymentMethods` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commercePayments` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceProductCategories` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceProducts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceTaxComponents` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `commerceTransactions` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `company` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `creditNotes` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `customers` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `directCosts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `directIncomes` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `invoices` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `itemReceipts` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `items` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `journalEntries` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `journals` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `paymentMethods` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `payments` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `profitAndLoss` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `purchaseOrders` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `salesOrders` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `suppliers` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `taxRates` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `trackingCategories` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | +| `transfers` | [Optional\](../../models/components/DataStatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetDataStatusResponse.md b/sync-for-expenses/docs/models/operations/GetDataStatusResponse.md index 2f1edb11..9a4eb8cf 100644 --- a/sync-for-expenses/docs/models/operations/GetDataStatusResponse.md +++ b/sync-for-expenses/docs/models/operations/GetDataStatusResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `dataStatuses` | [Optional](../../models/operations/GetDataStatusDataStatuses.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `dataStatuses` | [Optional\](../../models/operations/GetDataStatusDataStatuses.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetLastSuccessfulSyncResponse.md b/sync-for-expenses/docs/models/operations/GetLastSuccessfulSyncResponse.md index 5e84774d..82f874bf 100644 --- a/sync-for-expenses/docs/models/operations/GetLastSuccessfulSyncResponse.md +++ b/sync-for-expenses/docs/models/operations/GetLastSuccessfulSyncResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companySyncStatus` | [Optional](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companySyncStatus` | [Optional\](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetLatestSyncResponse.md b/sync-for-expenses/docs/models/operations/GetLatestSyncResponse.md index 7b62d85d..9aa82da5 100644 --- a/sync-for-expenses/docs/models/operations/GetLatestSyncResponse.md +++ b/sync-for-expenses/docs/models/operations/GetLatestSyncResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companySyncStatus` | [Optional](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companySyncStatus` | [Optional\](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetMappingOptionsResponse.md b/sync-for-expenses/docs/models/operations/GetMappingOptionsResponse.md index 020b0411..513f7104 100644 --- a/sync-for-expenses/docs/models/operations/GetMappingOptionsResponse.md +++ b/sync-for-expenses/docs/models/operations/GetMappingOptionsResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `mappingOptions` | [Optional](../../models/components/MappingOptions.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `mappingOptions` | [Optional\](../../models/components/MappingOptions.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetPullOperationResponse.md b/sync-for-expenses/docs/models/operations/GetPullOperationResponse.md index f622f540..bfb0735d 100644 --- a/sync-for-expenses/docs/models/operations/GetPullOperationResponse.md +++ b/sync-for-expenses/docs/models/operations/GetPullOperationResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `pullOperation` | [Optional](../../models/components/PullOperation.md) | :heavy_minus_sign: | OK | {
"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
"connectionId": "51baa045-4836-4317-a42e-3542e991e581",
"dataType": "invoices",
"status": "Initial",
"statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
"requested": "2022-11-14T11:18:37.2798351Z",
"progress": 10,
"isCompleted": false,
"isErrored": false
} | +| `pullOperation` | [Optional\](../../models/components/PullOperation.md) | :heavy_minus_sign: | OK | {
"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
"connectionId": "51baa045-4836-4317-a42e-3542e991e581",
"dataType": "invoices",
"status": "Initial",
"statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
"requested": "2022-11-14T11:18:37.2798351Z",
"progress": 10,
"isCompleted": false,
"isErrored": false
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetPushOperationResponse.md b/sync-for-expenses/docs/models/operations/GetPushOperationResponse.md index c5b78e03..46006b2b 100644 --- a/sync-for-expenses/docs/models/operations/GetPushOperationResponse.md +++ b/sync-for-expenses/docs/models/operations/GetPushOperationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `pushOperation` | [Optional](../../models/components/PushOperation.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `pushOperation` | [Optional\](../../models/components/PushOperation.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetSupplierResponse.md b/sync-for-expenses/docs/models/operations/GetSupplierResponse.md index a66f12c6..d18657ff 100644 --- a/sync-for-expenses/docs/models/operations/GetSupplierResponse.md +++ b/sync-for-expenses/docs/models/operations/GetSupplierResponse.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | -| `supplier` | [JsonNullable](../../models/components/Supplier.md) | :heavy_minus_sign: | Success | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `supplier` | [JsonNullable\](../../models/components/Supplier.md) | :heavy_minus_sign: | Success | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetSyncByIdResponse.md b/sync-for-expenses/docs/models/operations/GetSyncByIdResponse.md index d34d5d11..8f16d88f 100644 --- a/sync-for-expenses/docs/models/operations/GetSyncByIdResponse.md +++ b/sync-for-expenses/docs/models/operations/GetSyncByIdResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companySyncStatus` | [Optional](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companySyncStatus` | [Optional\](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/GetSyncTransactionResponse.md b/sync-for-expenses/docs/models/operations/GetSyncTransactionResponse.md index b67350fc..1d3e5226 100644 --- a/sync-for-expenses/docs/models/operations/GetSyncTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/GetSyncTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `transactionResponse` | List<[Transaction](../../models/components/Transaction.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `transactionResponse` | List\<[SchemaTransaction](../../models/components/SchemaTransaction.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListCompaniesRequest.md b/sync-for-expenses/docs/models/operations/ListCompaniesRequest.md index b5099c58..a1dd2014 100644 --- a/sync-for-expenses/docs/models/operations/ListCompaniesRequest.md +++ b/sync-for-expenses/docs/models/operations/ListCompaniesRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListCompaniesResponse.md b/sync-for-expenses/docs/models/operations/ListCompaniesResponse.md index 8548fc6e..9d57bf6c 100644 --- a/sync-for-expenses/docs/models/operations/ListCompaniesResponse.md +++ b/sync-for-expenses/docs/models/operations/ListCompaniesResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companies` | [Optional](../../models/components/Companies.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `companies` | [Optional\](../../models/components/Companies.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListConnectionsRequest.md b/sync-for-expenses/docs/models/operations/ListConnectionsRequest.md index a6f3e3d2..b2973f4e 100644 --- a/sync-for-expenses/docs/models/operations/ListConnectionsRequest.md +++ b/sync-for-expenses/docs/models/operations/ListConnectionsRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListConnectionsResponse.md b/sync-for-expenses/docs/models/operations/ListConnectionsResponse.md index f590878d..ceb3db80 100644 --- a/sync-for-expenses/docs/models/operations/ListConnectionsResponse.md +++ b/sync-for-expenses/docs/models/operations/ListConnectionsResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `connections` | [Optional](../../models/components/Connections.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `connections` | [Optional\](../../models/components/Connections.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListCustomersRequest.md b/sync-for-expenses/docs/models/operations/ListCustomersRequest.md index 00a91361..d24f9e67 100644 --- a/sync-for-expenses/docs/models/operations/ListCustomersRequest.md +++ b/sync-for-expenses/docs/models/operations/ListCustomersRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListCustomersResponse.md b/sync-for-expenses/docs/models/operations/ListCustomersResponse.md index 00c4ca3b..d9186e35 100644 --- a/sync-for-expenses/docs/models/operations/ListCustomersResponse.md +++ b/sync-for-expenses/docs/models/operations/ListCustomersResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `customers` | [Optional](../../models/components/Customers.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `customers` | [Optional\](../../models/components/Customers.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListPullOperationsRequest.md b/sync-for-expenses/docs/models/operations/ListPullOperationsRequest.md index fb4e68ab..6b85603c 100644 --- a/sync-for-expenses/docs/models/operations/ListPullOperationsRequest.md +++ b/sync-for-expenses/docs/models/operations/ListPullOperationsRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListPullOperationsResponse.md b/sync-for-expenses/docs/models/operations/ListPullOperationsResponse.md index 7a17b4ba..9a80ae57 100644 --- a/sync-for-expenses/docs/models/operations/ListPullOperationsResponse.md +++ b/sync-for-expenses/docs/models/operations/ListPullOperationsResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `pullOperations` | [Optional](../../models/components/PullOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `pullOperations` | [Optional\](../../models/components/PullOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListPushOperationsRequest.md b/sync-for-expenses/docs/models/operations/ListPushOperationsRequest.md index 1b9095b6..a2638386 100644 --- a/sync-for-expenses/docs/models/operations/ListPushOperationsRequest.md +++ b/sync-for-expenses/docs/models/operations/ListPushOperationsRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListPushOperationsResponse.md b/sync-for-expenses/docs/models/operations/ListPushOperationsResponse.md index c3025969..25c0b189 100644 --- a/sync-for-expenses/docs/models/operations/ListPushOperationsResponse.md +++ b/sync-for-expenses/docs/models/operations/ListPushOperationsResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `pushOperations` | [Optional](../../models/components/PushOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `pushOperations` | [Optional\](../../models/components/PushOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListSuppliersRequest.md b/sync-for-expenses/docs/models/operations/ListSuppliersRequest.md index 6da698f9..19e6662c 100644 --- a/sync-for-expenses/docs/models/operations/ListSuppliersRequest.md +++ b/sync-for-expenses/docs/models/operations/ListSuppliersRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListSuppliersResponse.md b/sync-for-expenses/docs/models/operations/ListSuppliersResponse.md index 096e139e..de48c478 100644 --- a/sync-for-expenses/docs/models/operations/ListSuppliersResponse.md +++ b/sync-for-expenses/docs/models/operations/ListSuppliersResponse.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | -| `suppliers` | [Optional](../../models/components/Suppliers.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `suppliers` | [Optional\](../../models/components/Suppliers.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListSyncTransactionsRequest.md b/sync-for-expenses/docs/models/operations/ListSyncTransactionsRequest.md index e32f174e..d92813c9 100644 --- a/sync-for-expenses/docs/models/operations/ListSyncTransactionsRequest.md +++ b/sync-for-expenses/docs/models/operations/ListSyncTransactionsRequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | | `syncId` | *String* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListSyncTransactionsResponse.md b/sync-for-expenses/docs/models/operations/ListSyncTransactionsResponse.md index 75d6e1fe..3cf53216 100644 --- a/sync-for-expenses/docs/models/operations/ListSyncTransactionsResponse.md +++ b/sync-for-expenses/docs/models/operations/ListSyncTransactionsResponse.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | -| `transactions` | [Optional](../../models/components/Transactions.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `transactions` | [Optional\](../../models/components/Transactions.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/ListSyncsResponse.md b/sync-for-expenses/docs/models/operations/ListSyncsResponse.md index 52be2e4e..d7bb8d8d 100644 --- a/sync-for-expenses/docs/models/operations/ListSyncsResponse.md +++ b/sync-for-expenses/docs/models/operations/ListSyncsResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `classes` | List<[CompanySyncStatus](../../models/components/CompanySyncStatus.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `classes` | List\<[CompanySyncStatus](../../models/components/CompanySyncStatus.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/RefreshAllDataTypesResponse.md b/sync-for-expenses/docs/models/operations/RefreshAllDataTypesResponse.md index b3fbfcce..434c2281 100644 --- a/sync-for-expenses/docs/models/operations/RefreshAllDataTypesResponse.md +++ b/sync-for-expenses/docs/models/operations/RefreshAllDataTypesResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/RefreshDataTypeRequest.md b/sync-for-expenses/docs/models/operations/RefreshDataTypeRequest.md index 2e0d8d81..bc057286 100644 --- a/sync-for-expenses/docs/models/operations/RefreshDataTypeRequest.md +++ b/sync-for-expenses/docs/models/operations/RefreshDataTypeRequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *Optional* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | +| `connectionId` | *Optional\* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | | `dataType` | [SchemaDataType](../../models/components/SchemaDataType.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/RefreshDataTypeResponse.md b/sync-for-expenses/docs/models/operations/RefreshDataTypeResponse.md index 05e48ef5..ef26a349 100644 --- a/sync-for-expenses/docs/models/operations/RefreshDataTypeResponse.md +++ b/sync-for-expenses/docs/models/operations/RefreshDataTypeResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `pullOperation` | [Optional](../../models/components/PullOperation.md) | :heavy_minus_sign: | OK | {
"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
"connectionId": "51baa045-4836-4317-a42e-3542e991e581",
"dataType": "invoices",
"status": "Initial",
"statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
"requested": "2022-11-14T11:18:37.2798351Z",
"progress": 10,
"isCompleted": false,
"isErrored": false
} | +| `pullOperation` | [Optional\](../../models/components/PullOperation.md) | :heavy_minus_sign: | OK | {
"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
"companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
"connectionId": "51baa045-4836-4317-a42e-3542e991e581",
"dataType": "invoices",
"status": "Initial",
"statusDescription": "Paused until 2022-10-23T00:00:00.000Z",
"requested": "2022-11-14T11:18:37.2798351Z",
"progress": 10,
"isCompleted": false,
"isErrored": false
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/SetCompanyConfigurationRequest.md b/sync-for-expenses/docs/models/operations/SetCompanyConfigurationRequest.md index 74c768cd..4aaf2dd0 100644 --- a/sync-for-expenses/docs/models/operations/SetCompanyConfigurationRequest.md +++ b/sync-for-expenses/docs/models/operations/SetCompanyConfigurationRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `companyConfiguration` | [Optional](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `companyConfiguration` | [Optional\](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/SetCompanyConfigurationResponse.md b/sync-for-expenses/docs/models/operations/SetCompanyConfigurationResponse.md index cb88e503..2bc94275 100644 --- a/sync-for-expenses/docs/models/operations/SetCompanyConfigurationResponse.md +++ b/sync-for-expenses/docs/models/operations/SetCompanyConfigurationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companyConfiguration` | [Optional](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companyConfiguration` | [Optional\](../../models/components/CompanyConfiguration.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UnlinkConnectionRequest.md b/sync-for-expenses/docs/models/operations/UnlinkConnectionRequest.md index 6ed76d28..72d6aa44 100644 --- a/sync-for-expenses/docs/models/operations/UnlinkConnectionRequest.md +++ b/sync-for-expenses/docs/models/operations/UnlinkConnectionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `requestBody` | [Optional](../../models/operations/UnlinkConnectionUpdateConnection.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `requestBody` | [Optional\](../../models/operations/UnlinkConnectionUpdateConnection.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UnlinkConnectionResponse.md b/sync-for-expenses/docs/models/operations/UnlinkConnectionResponse.md index bffb5d9e..d68063d5 100644 --- a/sync-for-expenses/docs/models/operations/UnlinkConnectionResponse.md +++ b/sync-for-expenses/docs/models/operations/UnlinkConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UnlinkConnectionUpdateConnection.md b/sync-for-expenses/docs/models/operations/UnlinkConnectionUpdateConnection.md index ba4b2967..ae37e303 100644 --- a/sync-for-expenses/docs/models/operations/UnlinkConnectionUpdateConnection.md +++ b/sync-for-expenses/docs/models/operations/UnlinkConnectionUpdateConnection.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `status` | [Optional](../../models/components/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `status` | [Optional\](../../models/components/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateCompanyRequest.md b/sync-for-expenses/docs/models/operations/UpdateCompanyRequest.md index 3871c24e..aca6a51d 100644 --- a/sync-for-expenses/docs/models/operations/UpdateCompanyRequest.md +++ b/sync-for-expenses/docs/models/operations/UpdateCompanyRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `companyRequestBody` | [Optional](../../models/components/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `companyRequestBody` | [Optional\](../../models/components/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateCompanyResponse.md b/sync-for-expenses/docs/models/operations/UpdateCompanyResponse.md index e2a590f8..2beb7269 100644 --- a/sync-for-expenses/docs/models/operations/UpdateCompanyResponse.md +++ b/sync-for-expenses/docs/models/operations/UpdateCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateCustomerRequest.md b/sync-for-expenses/docs/models/operations/UpdateCustomerRequest.md index 9100a3a7..64847d3d 100644 --- a/sync-for-expenses/docs/models/operations/UpdateCustomerRequest.md +++ b/sync-for-expenses/docs/models/operations/UpdateCustomerRequest.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `customer` | [JsonNullable](../../models/components/Customer.md) | :heavy_minus_sign: | N/A | | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `customer` | [JsonNullable\](../../models/components/Customer.md) | :heavy_minus_sign: | N/A | | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `customerId` | *String* | :heavy_check_mark: | Unique identifier for a customer. | | -| `forceUpdate` | *Optional* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| `customerId` | *String* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `forceUpdate` | *Optional\* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateCustomerResponse.md b/sync-for-expenses/docs/models/operations/UpdateCustomerResponse.md index 8158e294..950d49da 100644 --- a/sync-for-expenses/docs/models/operations/UpdateCustomerResponse.md +++ b/sync-for-expenses/docs/models/operations/UpdateCustomerResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `updateCustomerResponse` | [Optional](../../models/components/UpdateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `updateCustomerResponse` | [Optional\](../../models/components/UpdateCustomerResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionRequest.md b/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionRequest.md index 0896eb7a..005629ae 100644 --- a/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `updateExpenseRequest` | [Optional](../../models/components/UpdateExpenseRequest.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `updateExpenseRequest` | [Optional\](../../models/components/UpdateExpenseRequest.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionResponse.md b/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionResponse.md index a5661c8a..07a5ee05 100644 --- a/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/UpdateExpenseTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `updateExpenseResponse` | [Optional](../../models/components/UpdateExpenseResponse.md) | :heavy_minus_sign: | Accepted | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `updateExpenseResponse` | [Optional\](../../models/components/UpdateExpenseResponse.md) | :heavy_minus_sign: | Accepted | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionRequest.md b/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionRequest.md index 7139024b..6e75db54 100644 --- a/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionRequest.md +++ b/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `updateReimbursableExpenseTransactionRequest` | [Optional](../../models/components/UpdateReimbursableExpenseTransactionRequest.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `updateReimbursableExpenseTransactionRequest` | [Optional\](../../models/components/UpdateReimbursableExpenseTransactionRequest.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionResponse.md b/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionResponse.md index 3a996612..714dd86f 100644 --- a/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionResponse.md +++ b/sync-for-expenses/docs/models/operations/UpdateReimbursableExpenseTransactionResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createReimbursableExpenseResponse` | [Optional](../../models/components/CreateReimbursableExpenseResponse.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createReimbursableExpenseResponse` | [Optional\](../../models/components/CreateReimbursableExpenseResponse.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateSupplierRequest.md b/sync-for-expenses/docs/models/operations/UpdateSupplierRequest.md index 2e92bfe9..82c0b854 100644 --- a/sync-for-expenses/docs/models/operations/UpdateSupplierRequest.md +++ b/sync-for-expenses/docs/models/operations/UpdateSupplierRequest.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `supplier` | [JsonNullable](../../models/components/Supplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `supplier` | [JsonNullable\](../../models/components/Supplier.md) | :heavy_minus_sign: | N/A | {
"id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
"supplierName": "Kelly's Industrial Supplies",
"contactName": "Kelly's Industrial Supplies",
"emailAddress": "sales@kellysupplies.com",
"phone": "07999 999999",
"addresses": [
{
"type": "Billing",
"line1": "Unit 51",
"line2": "Bakersfield Industrial Estate",
"city": "Bakersfield",
"region": "California",
"country": "USA",
"postalcode": "93308"
}
],
"registrationNumber": "string",
"taxNumber": "string",
"status": "Unknown",
"defaultCurrency": "string",
"metadata": {
"isDeleted": true
},
"supplementalData": {
"content": {
"property1": {
"property1": null,
"property2": null
},
"property2": {
"property1": null,
"property2": null
}
}
},
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
} | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `forceUpdate` | *Optional* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | +| `forceUpdate` | *Optional\* | :heavy_minus_sign: | When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check. | | | `supplierId` | *String* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UpdateSupplierResponse.md b/sync-for-expenses/docs/models/operations/UpdateSupplierResponse.md index 92448496..fb245b58 100644 --- a/sync-for-expenses/docs/models/operations/UpdateSupplierResponse.md +++ b/sync-for-expenses/docs/models/operations/UpdateSupplierResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `updateSupplierResponse` | [Optional](../../models/components/UpdateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `updateSupplierResponse` | [Optional\](../../models/components/UpdateSupplierResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentRequest.md b/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentRequest.md index 2d2c58ce..0e7bf53d 100644 --- a/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentRequest.md +++ b/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `attachmentUpload` | [Optional](../../models/components/AttachmentUpload.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `syncId` | *String* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | -| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `attachmentUpload` | [Optional\](../../models/components/AttachmentUpload.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `syncId` | *String* | :heavy_check_mark: | Unique identifier for a sync. | 6fb40d5e-b13e-11ed-afa1-0242ac120002 | +| `transactionId` | *String* | :heavy_check_mark: | The unique identifier for your SMB's transaction. | 336694d8-2dca-4cb5-a28d-3ccb83e55eee | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentResponse.md b/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentResponse.md index f2a461fa..a0eaeee1 100644 --- a/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentResponse.md +++ b/sync-for-expenses/docs/models/operations/UploadExpenseAttachmentResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `attachment` | [Optional](../../models/components/Attachment.md) | :heavy_minus_sign: | OK | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `attachment` | [Optional\](../../models/components/Attachment.md) | :heavy_minus_sign: | OK | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse.md b/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse.md index 8d81865c..1667253d 100644 --- a/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse.md +++ b/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse1.md b/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse1.md index 03b649e0..0d14c216 100644 --- a/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse1.md +++ b/sync-for-expenses/docs/models/webhooks/ClientRateLimitReachedResponse1.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse.md b/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse.md index ae5b2046..3f308003 100644 --- a/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse.md +++ b/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse1.md b/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse1.md index 04cbf9b7..234c58cd 100644 --- a/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse1.md +++ b/sync-for-expenses/docs/models/webhooks/ClientRateLimitResetResponse1.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ExpensesSyncSuccessfulResponse.md b/sync-for-expenses/docs/models/webhooks/ExpensesSyncSuccessfulResponse.md new file mode 100644 index 00000000..4c57a6b3 --- /dev/null +++ b/sync-for-expenses/docs/models/webhooks/ExpensesSyncSuccessfulResponse.md @@ -0,0 +1,10 @@ +# ExpensesSyncSuccessfulResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/ExpensesSyncUnsuccessfulResponse.md b/sync-for-expenses/docs/models/webhooks/ExpensesSyncUnsuccessfulResponse.md new file mode 100644 index 00000000..bc05f041 --- /dev/null +++ b/sync-for-expenses/docs/models/webhooks/ExpensesSyncUnsuccessfulResponse.md @@ -0,0 +1,10 @@ +# ExpensesSyncUnsuccessfulResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/SyncCompleteResponse.md b/sync-for-expenses/docs/models/webhooks/SyncCompleteResponse.md deleted file mode 100644 index 79daaffa..00000000 --- a/sync-for-expenses/docs/models/webhooks/SyncCompleteResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SyncCompleteResponse - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/SyncCompletedResponse.md b/sync-for-expenses/docs/models/webhooks/SyncCompletedResponse.md new file mode 100644 index 00000000..c656f38b --- /dev/null +++ b/sync-for-expenses/docs/models/webhooks/SyncCompletedResponse.md @@ -0,0 +1,10 @@ +# SyncCompletedResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/models/webhooks/SyncFailedResponse.md b/sync-for-expenses/docs/models/webhooks/SyncFailedResponse.md index 08817419..dd97c6ac 100644 --- a/sync-for-expenses/docs/models/webhooks/SyncFailedResponse.md +++ b/sync-for-expenses/docs/models/webhooks/SyncFailedResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/accounts/README.md b/sync-for-expenses/docs/sdks/accounts/README.md index 8a65d735..4133dd9a 100644 --- a/sync-for-expenses/docs/sdks/accounts/README.md +++ b/sync-for-expenses/docs/sdks/accounts/README.md @@ -20,9 +20,6 @@ The *Create account* endpoint creates a new [account](https://docs.codat.io/sync Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - - ### Example Usage ```java @@ -32,7 +29,7 @@ import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.AccountPrototype; import io.codat.sync.expenses.models.components.AccountStatus; import io.codat.sync.expenses.models.components.AccountType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateAccountRequest; import io.codat.sync.expenses.models.operations.CreateAccountResponse; import java.lang.Exception; @@ -40,13 +37,13 @@ import java.math.BigDecimal; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateAccountRequest req = CreateAccountRequest.builder() + CreateAccountRequest req = CreateAccountRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .accountPrototype(AccountPrototype.builder() @@ -62,24 +59,13 @@ public class Application { .build()) .build(); - CreateAccountResponse res = sdk.accounts().create() + CreateAccountResponse res = sdk.accounts().create() .request(req) .call(); - if (res.createAccountResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createAccountResponse().isPresent()) { + // handle response } - } } ``` @@ -96,11 +82,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getCreateModel @@ -112,51 +97,37 @@ The *Get create account model* endpoint returns the expected data for the reques See the *response examples* for integration-specific indicative models. -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - - ### Example Usage ```java package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetCreateChartOfAccountsModelRequest; import io.codat.sync.expenses.models.operations.GetCreateChartOfAccountsModelResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCreateChartOfAccountsModelRequest req = GetCreateChartOfAccountsModelRequest.builder() + GetCreateChartOfAccountsModelRequest req = GetCreateChartOfAccountsModelRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetCreateChartOfAccountsModelResponse res = sdk.accounts().getCreateModel() + GetCreateChartOfAccountsModelResponse res = sdk.accounts().getCreateModel() .request(req) .call(); - if (res.pushOption().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOption().isPresent()) { + // handle response } - } } ``` @@ -173,7 +144,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/adjustments/README.md b/sync-for-expenses/docs/sdks/adjustments/README.md index 201730f9..519b18ec 100644 --- a/sync-for-expenses/docs/sdks/adjustments/README.md +++ b/sync-for-expenses/docs/sdks/adjustments/README.md @@ -34,7 +34,7 @@ import io.codat.sync.expenses.models.components.InvoiceToType; import io.codat.sync.expenses.models.components.RecordRef; import io.codat.sync.expenses.models.components.TrackingRefAdjustmentTransaction; import io.codat.sync.expenses.models.components.TrackingRefAdjustmentTransactionDataType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateAdjustmentTransactionRequest; import io.codat.sync.expenses.models.operations.CreateAdjustmentTransactionResponse; import java.lang.Exception; @@ -43,19 +43,19 @@ import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateAdjustmentTransactionRequest req = CreateAdjustmentTransactionRequest.builder() + CreateAdjustmentTransactionRequest req = CreateAdjustmentTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .requestBody(List.of( AdjustmentTransactionRequest.builder() - .currency("Lithuanian Litas") + .currency("Tenge") .date("2022-10-23T00:00:00Z") - .id("d642c1fc-6fe0-4724-9bcd-d89dc7fa504e") + .id("621cf021-cd9c-4f54-a033-15211a509a30") .lines(List.of( AdjustmentTransactionLine.builder() .accountRef(RecordRef.builder() @@ -76,24 +76,13 @@ public class Application { .build())) .build(); - CreateAdjustmentTransactionResponse res = sdk.adjustments().create() + CreateAdjustmentTransactionResponse res = sdk.adjustments().create() .request(req) .call(); - if (res.adjustmentTransactionResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.adjustmentTransactionResponse().isPresent()) { + // handle response } - } } ``` @@ -110,7 +99,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/attachments/README.md b/sync-for-expenses/docs/sdks/attachments/README.md index 40438450..cc7e2cfd 100644 --- a/sync-for-expenses/docs/sdks/attachments/README.md +++ b/sync-for-expenses/docs/sdks/attachments/README.md @@ -13,18 +13,20 @@ Attach receipts to a transaction for a complete audit trail. The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. -[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. +[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. **Integration-specific behaviour** Each accounting software supports different file formats and sizes. -| Integration | File Size | File Extension | -|-------------|-------------|--------------------------------------------------------------------------------------------------------------| -| Xero | 3MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | -| QuickBooks Online | 100MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | -| NetSuite | 100MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | -| Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that "You can attach any type of file, such as text, image, or video files". | +| Integration | File size | File extension |Supported transaction type +|-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | +| **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` | +| **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` | +| **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types +| **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | +| **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF ### Example Usage @@ -32,43 +34,32 @@ Each accounting software supports different file formats and sizes. package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UploadExpenseAttachmentRequest; import io.codat.sync.expenses.models.operations.UploadExpenseAttachmentResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UploadExpenseAttachmentRequest req = UploadExpenseAttachmentRequest.builder() + UploadExpenseAttachmentRequest req = UploadExpenseAttachmentRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .syncId("6fb40d5e-b13e-11ed-afa1-0242ac120002") .transactionId("336694d8-2dca-4cb5-a28d-3ccb83e55eee") .build(); - UploadExpenseAttachmentResponse res = sdk.attachments().upload() + UploadExpenseAttachmentResponse res = sdk.attachments().upload() .request(req) .call(); - if (res.attachment().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.attachment().isPresent()) { + // handle response } - } } ``` @@ -85,7 +76,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/bankaccounts/README.md b/sync-for-expenses/docs/sdks/bankaccounts/README.md index f7e31c45..76cf39e7 100644 --- a/sync-for-expenses/docs/sdks/bankaccounts/README.md +++ b/sync-for-expenses/docs/sdks/bankaccounts/README.md @@ -18,9 +18,7 @@ The *Create bank account* endpoint creates a new [bank account](https://docs.cod **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. +Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). ### Example Usage @@ -30,20 +28,20 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.BankAccount; import io.codat.sync.expenses.models.components.BankAccountStatus; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateBankAccountRequest; import io.codat.sync.expenses.models.operations.CreateBankAccountResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateBankAccountRequest req = CreateBankAccountRequest.builder() + CreateBankAccountRequest req = CreateBankAccountRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .bankAccount(BankAccount.builder() @@ -54,24 +52,13 @@ public class Application { .build()) .build(); - CreateBankAccountResponse res = sdk.bankAccounts().create() + CreateBankAccountResponse res = sdk.bankAccounts().create() .request(req) .call(); - if (res.createBankAccountResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createBankAccountResponse().isPresent()) { + // handle response } - } } ``` @@ -88,11 +75,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getCreateModel @@ -103,8 +89,6 @@ The *Get create/update bank account model* endpoint returns the expected data fo **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. ### Example Usage @@ -113,42 +97,31 @@ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetCreateBankAccountsModelRequest; import io.codat.sync.expenses.models.operations.GetCreateBankAccountsModelResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCreateBankAccountsModelRequest req = GetCreateBankAccountsModelRequest.builder() + GetCreateBankAccountsModelRequest req = GetCreateBankAccountsModelRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetCreateBankAccountsModelResponse res = sdk.bankAccounts().getCreateModel() + GetCreateBankAccountsModelResponse res = sdk.bankAccounts().getCreateModel() .request(req) .call(); - if (res.pushOption().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOption().isPresent()) { + // handle response } - } } ``` @@ -165,7 +138,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md b/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md index 3297e0bc..e86931ee 100644 --- a/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md +++ b/sync-for-expenses/docs/sdks/codatsyncexpenses/README.md @@ -32,4 +32,6 @@ Not seeing the endpoints you're expecting? We've [reorganized our products](http | Accounts | Create accounts and view account schemas. | | Customers | Get, create, and update customers. | | Suppliers | Get, create, and update suppliers. | - \ No newline at end of file + + +### Available Operations diff --git a/sync-for-expenses/docs/sdks/companies/README.md b/sync-for-expenses/docs/sdks/companies/README.md index 8d5071bb..f9cb492f 100644 --- a/sync-for-expenses/docs/sdks/companies/README.md +++ b/sync-for-expenses/docs/sdks/companies/README.md @@ -29,47 +29,30 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -86,11 +69,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## delete @@ -106,39 +88,28 @@ Each company can have multiple [connections](https://docs.codat.io/sync-for-expe package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.DeleteCompanyRequest; import io.codat.sync.expenses.models.operations.DeleteCompanyResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteCompanyRequest req = DeleteCompanyRequest.builder() + DeleteCompanyRequest req = DeleteCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - DeleteCompanyResponse res = sdk.companies().delete() + DeleteCompanyResponse res = sdk.companies().delete() .request(req) .call(); - // handle response - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -155,11 +126,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -175,41 +145,30 @@ Each company can have multiple [connections](https://docs.codat.io/sync-for-expe package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetCompanyRequest; import io.codat.sync.expenses.models.operations.GetCompanyResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCompanyRequest req = GetCompanyRequest.builder() + GetCompanyRequest req = GetCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetCompanyResponse res = sdk.companies().get() + GetCompanyResponse res = sdk.companies().get() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -226,15 +185,14 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list -The *List companies* endpoint returns a list of [companies] associated to your instances. +The *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances. A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -245,44 +203,33 @@ Each company can have multiple [connections](https://docs.codat.io/sync-for-expe package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListCompaniesRequest; import io.codat.sync.expenses.models.operations.ListCompaniesResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListCompaniesRequest req = ListCompaniesRequest.builder() + ListCompaniesRequest req = ListCompaniesRequest.builder() .orderBy("-modifiedDate") .page(1) .pageSize(100) .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListCompaniesResponse res = sdk.companies().list() + ListCompaniesResponse res = sdk.companies().list() .request(req) .call(); - if (res.companies().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companies().isPresent()) { + // handle response } - } } ``` @@ -299,16 +246,14 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update Use the *Update company* endpoint to update both the name and description of the company. -If you use [groups](https://docs.codat.io/sync-for-expenses-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/sync-for-expenses-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/sync-for-expenses-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -320,51 +265,34 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.CompanyRequestBody; -import io.codat.sync.expenses.models.components.GroupReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UpdateCompanyRequest; import io.codat.sync.expenses.models.operations.UpdateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateCompanyRequest req = UpdateCompanyRequest.builder() + UpdateCompanyRequest req = UpdateCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .companyRequestBody(CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build()) .build(); - UpdateCompanyResponse res = sdk.companies().update() + UpdateCompanyResponse res = sdk.companies().update() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -381,7 +309,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/companyinfo/README.md b/sync-for-expenses/docs/sdks/companyinfo/README.md new file mode 100644 index 00000000..f6923b4b --- /dev/null +++ b/sync-for-expenses/docs/sdks/companyinfo/README.md @@ -0,0 +1,65 @@ +# CompanyInfo +(*companyInfo()*) + +## Overview + +View the company information of your customers' linked accounting software. + +### Available Operations + +* [get](#get) - Get company info + +## get + +Gets the latest basic info for a company. + +### Example Usage + +```java +package hello.world; + +import io.codat.sync.expenses.CodatSyncExpenses; +import io.codat.sync.expenses.models.errors.ErrorMessage; +import io.codat.sync.expenses.models.operations.GetCompanyInfoRequest; +import io.codat.sync.expenses.models.operations.GetCompanyInfoResponse; +import java.lang.Exception; + +public class Application { + + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() + .authHeader("Basic BASE_64_ENCODED(API_KEY)") + .build(); + + GetCompanyInfoRequest req = GetCompanyInfoRequest.builder() + .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") + .build(); + + GetCompanyInfoResponse res = sdk.companyInfo().get() + .request(req) + .call(); + + if (res.companyInformation().isPresent()) { + // handle response + } + } +} +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `request` | [GetCompanyInfoRequest](../../models/operations/GetCompanyInfoRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[GetCompanyInfoResponse](../../models/operations/GetCompanyInfoResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/configuration/README.md b/sync-for-expenses/docs/sdks/configuration/README.md index 6da38eea..f8c02a11 100644 --- a/sync-for-expenses/docs/sdks/configuration/README.md +++ b/sync-for-expenses/docs/sdks/configuration/README.md @@ -20,41 +20,30 @@ Gets a company's expense sync configuration package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetCompanyConfigurationRequest; import io.codat.sync.expenses.models.operations.GetCompanyConfigurationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCompanyConfigurationRequest req = GetCompanyConfigurationRequest.builder() + GetCompanyConfigurationRequest req = GetCompanyConfigurationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetCompanyConfigurationResponse res = sdk.configuration().get() + GetCompanyConfigurationResponse res = sdk.configuration().get() .request(req) .call(); - if (res.companyConfiguration().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companyConfiguration().isPresent()) { + // handle response } - } } ``` @@ -71,11 +60,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## set @@ -91,20 +79,20 @@ import io.codat.sync.expenses.models.components.BankAccountDetails; import io.codat.sync.expenses.models.components.CompanyConfiguration; import io.codat.sync.expenses.models.components.CustomerDetails; import io.codat.sync.expenses.models.components.SupplierDetails; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.SetCompanyConfigurationRequest; import io.codat.sync.expenses.models.operations.SetCompanyConfigurationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - SetCompanyConfigurationRequest req = SetCompanyConfigurationRequest.builder() + SetCompanyConfigurationRequest req = SetCompanyConfigurationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .companyConfiguration(CompanyConfiguration.builder() .bankAccount(BankAccountDetails.builder() @@ -117,24 +105,13 @@ public class Application { .build()) .build(); - SetCompanyConfigurationResponse res = sdk.configuration().set() + SetCompanyConfigurationResponse res = sdk.configuration().set() .request(req) .call(); - if (res.companyConfiguration().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companyConfiguration().isPresent()) { + // handle response } - } } ``` @@ -151,7 +128,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/connections/README.md b/sync-for-expenses/docs/sdks/connections/README.md index 94d62166..9d2886b2 100644 --- a/sync-for-expenses/docs/sdks/connections/README.md +++ b/sync-for-expenses/docs/sdks/connections/README.md @@ -18,7 +18,7 @@ Create new and manage existing data connections for a company. Creates a connection for the company by providing a valid `platformKey`. -Use the [List Integrations](https://docs.codat.io/sync-for-expenses-api#/operations/list-integrations) endpoint to access valid platform keys. +Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. ### Example Usage @@ -26,7 +26,7 @@ Use the [List Integrations](https://docs.codat.io/sync-for-expenses-api#/operati package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateConnectionRequest; import io.codat.sync.expenses.models.operations.CreateConnectionRequestBody; import io.codat.sync.expenses.models.operations.CreateConnectionResponse; @@ -34,37 +34,26 @@ import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateConnectionRequest req = CreateConnectionRequest.builder() + CreateConnectionRequest req = CreateConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .requestBody(CreateConnectionRequestBody.builder() .platformKey("gbol") .build()) .build(); - CreateConnectionResponse res = sdk.connections().create() + CreateConnectionResponse res = sdk.connections().create() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -81,11 +70,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## createPartnerExpenseConnection @@ -97,41 +85,30 @@ Creates a partner expense data connection package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreatePartnerExpenseConnectionRequest; import io.codat.sync.expenses.models.operations.CreatePartnerExpenseConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreatePartnerExpenseConnectionRequest req = CreatePartnerExpenseConnectionRequest.builder() + CreatePartnerExpenseConnectionRequest req = CreatePartnerExpenseConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - CreatePartnerExpenseConnectionResponse res = sdk.connections().createPartnerExpenseConnection() + CreatePartnerExpenseConnectionResponse res = sdk.connections().createPartnerExpenseConnection() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -148,11 +125,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## delete @@ -165,40 +141,29 @@ This operation is not reversible. The end user would need to reauthorize a new d package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.DeleteConnectionRequest; import io.codat.sync.expenses.models.operations.DeleteConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteConnectionRequest req = DeleteConnectionRequest.builder() + DeleteConnectionRequest req = DeleteConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - DeleteConnectionResponse res = sdk.connections().delete() + DeleteConnectionResponse res = sdk.connections().delete() .request(req) .call(); - // handle response - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -215,11 +180,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -231,42 +195,31 @@ public class Application { package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetConnectionRequest; import io.codat.sync.expenses.models.operations.GetConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetConnectionRequest req = GetConnectionRequest.builder() + GetConnectionRequest req = GetConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetConnectionResponse res = sdk.connections().get() + GetConnectionResponse res = sdk.connections().get() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -283,11 +236,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -299,20 +251,20 @@ public class Application { package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListConnectionsRequest; import io.codat.sync.expenses.models.operations.ListConnectionsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListConnectionsRequest req = ListConnectionsRequest.builder() + ListConnectionsRequest req = ListConnectionsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -320,24 +272,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListConnectionsResponse res = sdk.connections().list() + ListConnectionsResponse res = sdk.connections().list() .request(req) .call(); - if (res.connections().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connections().isPresent()) { + // handle response } - } } ``` @@ -354,11 +295,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## unlink @@ -370,42 +310,31 @@ public class Application { package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UnlinkConnectionRequest; import io.codat.sync.expenses.models.operations.UnlinkConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UnlinkConnectionRequest req = UnlinkConnectionRequest.builder() + UnlinkConnectionRequest req = UnlinkConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - UnlinkConnectionResponse res = sdk.connections().unlink() + UnlinkConnectionResponse res = sdk.connections().unlink() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -422,7 +351,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/customers/README.md b/sync-for-expenses/docs/sdks/customers/README.md index 0d5aed72..0373c189 100644 --- a/sync-for-expenses/docs/sdks/customers/README.md +++ b/sync-for-expenses/docs/sdks/customers/README.md @@ -22,9 +22,6 @@ The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sy Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - - ### Example Usage ```java @@ -34,9 +31,9 @@ import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.Contact; import io.codat.sync.expenses.models.components.Customer; import io.codat.sync.expenses.models.components.CustomerStatus; -import io.codat.sync.expenses.models.components.Phone; +import io.codat.sync.expenses.models.components.PhoneNumberItems; import io.codat.sync.expenses.models.components.PhoneNumberType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateCustomerRequest; import io.codat.sync.expenses.models.operations.CreateCustomerResponse; import java.lang.Exception; @@ -44,13 +41,13 @@ import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateCustomerRequest req = CreateCustomerRequest.builder() + CreateCustomerRequest req = CreateCustomerRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .customer(Customer.builder() @@ -60,35 +57,24 @@ public class Application { .status(CustomerStatus.ACTIVE) .modifiedDate("2022-10-23T00:00:00Z") .phone(List.of( - Phone.builder() - .type(PhoneNumberType.MOBILE) + PhoneNumberItems.builder() + .type(PhoneNumberType.PRIMARY) .number("+44 25691 154789") .build())) .build())) - .defaultCurrency("GBP") + .defaultCurrency("EUR") .modifiedDate("2022-10-23T00:00:00Z") .sourceModifiedDate("2022-10-23T00:00:00Z") .build()) .build(); - CreateCustomerResponse res = sdk.customers().create() + CreateCustomerResponse res = sdk.customers().create() .request(req) .call(); - if (res.createCustomerResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createCustomerResponse().isPresent()) { + // handle response } - } } ``` @@ -105,11 +91,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -117,8 +102,6 @@ The *Get customer* endpoint returns a single customer for a given customerId. [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). @@ -128,42 +111,31 @@ Before using this endpoint, you must have [retrieved data for the company](https package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetCustomerRequest; import io.codat.sync.expenses.models.operations.GetCustomerResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCustomerRequest req = GetCustomerRequest.builder() + GetCustomerRequest req = GetCustomerRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") - .customerId("") + .customerId("7110701885") .build(); - GetCustomerResponse res = sdk.customers().get() + GetCustomerResponse res = sdk.customers().get() .request(req) .call(); - if (res.customer().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.customer().isPresent()) { + // handle response } - } } ``` @@ -180,11 +152,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -201,20 +172,20 @@ Before using this endpoint, you must have [retrieved data for the company](https package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListCustomersRequest; import io.codat.sync.expenses.models.operations.ListCustomersResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListCustomersRequest req = ListCustomersRequest.builder() + ListCustomersRequest req = ListCustomersRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -222,24 +193,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListCustomersResponse res = sdk.customers().list() + ListCustomersResponse res = sdk.customers().list() .request(req) .call(); - if (res.customers().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.customers().isPresent()) { + // handle response } - } } ``` @@ -256,11 +216,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update @@ -272,9 +231,6 @@ The *Update customer* endpoint updates an existing [customer](https://docs.codat Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - - ### Example Usage ```java @@ -284,9 +240,9 @@ import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.Contact; import io.codat.sync.expenses.models.components.Customer; import io.codat.sync.expenses.models.components.CustomerStatus; -import io.codat.sync.expenses.models.components.Phone; +import io.codat.sync.expenses.models.components.PhoneNumberItems; import io.codat.sync.expenses.models.components.PhoneNumberType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UpdateCustomerRequest; import io.codat.sync.expenses.models.operations.UpdateCustomerResponse; import java.lang.Exception; @@ -294,52 +250,41 @@ import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateCustomerRequest req = UpdateCustomerRequest.builder() + UpdateCustomerRequest req = UpdateCustomerRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") - .customerId("") + .customerId("EILBDVJVNUAGVKRQ") .customer(Customer.builder() - .status(CustomerStatus.ARCHIVED) + .status(CustomerStatus.ACTIVE) .contacts(List.of( Contact.builder() - .status(CustomerStatus.UNKNOWN) + .status(CustomerStatus.ACTIVE) .modifiedDate("2022-10-23T00:00:00Z") .phone(List.of( - Phone.builder() - .type(PhoneNumberType.LANDLINE) - .number("01224 658 999") + PhoneNumberItems.builder() + .type(PhoneNumberType.FAX) + .number("(877) 492-8687") .build())) .build())) - .defaultCurrency("USD") + .defaultCurrency("EUR") .modifiedDate("2022-10-23T00:00:00Z") .sourceModifiedDate("2022-10-23T00:00:00Z") .build()) .build(); - UpdateCustomerResponse res = sdk.customers().update() + UpdateCustomerResponse res = sdk.customers().update() .request(req) .call(); - if (res.updateCustomerResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.updateCustomerResponse().isPresent()) { + // handle response } - } } ``` @@ -356,7 +301,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/expenses/README.md b/sync-for-expenses/docs/sdks/expenses/README.md index b5e7064b..f56eb942 100644 --- a/sync-for-expenses/docs/sdks/expenses/README.md +++ b/sync-for-expenses/docs/sdks/expenses/README.md @@ -33,44 +33,82 @@ The *Create expense* endpoint creates an [expense transaction](https://docs.coda package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.components.BankAccountReference; +import io.codat.sync.expenses.models.components.ExpenseContactRef; +import io.codat.sync.expenses.models.components.ExpenseTransaction; +import io.codat.sync.expenses.models.components.ExpenseTransactionLine; +import io.codat.sync.expenses.models.components.ExpenseTransactionType; +import io.codat.sync.expenses.models.components.InvoiceTo; +import io.codat.sync.expenses.models.components.InvoiceToType; +import io.codat.sync.expenses.models.components.RecordRef; +import io.codat.sync.expenses.models.components.TrackingRef; +import io.codat.sync.expenses.models.components.TrackingRefDataType; +import io.codat.sync.expenses.models.components.Type; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateExpenseTransactionRequest; import io.codat.sync.expenses.models.operations.CreateExpenseTransactionResponse; import java.lang.Exception; +import java.math.BigDecimal; import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateExpenseTransactionRequest req = CreateExpenseTransactionRequest.builder() + CreateExpenseTransactionRequest req = CreateExpenseTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .requestBody(List.of( - )) + ExpenseTransaction.builder() + .currency("GBP") + .id("4d7c6929-7770-412b-91bb-44d3bc71d111") + .issueDate("2022-10-23T00:00:00Z") + .type(ExpenseTransactionType.PAYMENT) + .bankAccountRef(BankAccountReference.builder() + .id("97") + .build()) + .contactRef(ExpenseContactRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .type(Type.SUPPLIER) + .build()) + .currencyRate(new BigDecimal("1")) + .lines(List.of( + ExpenseTransactionLine.builder() + .netAmount(new BigDecimal("100")) + .accountRef(RecordRef.builder() + .id("35") + .build()) + .invoiceTo(InvoiceTo.builder() + .id("504") + .type(InvoiceToType.CUSTOMER) + .build()) + .taxAmount(new BigDecimal("20")) + .taxRateRef(RecordRef.builder() + .id("23_Bills") + .build()) + .trackingRefs(List.of( + TrackingRef.builder() + .id("DEPARTMENT_3") + .build(), + TrackingRef.builder() + .dataType(TrackingRefDataType.TRACKING_CATEGORIES) + .build())) + .build())) + .merchantName("Amazon UK") + .notes("amazon purchase") + .build())) .build(); - CreateExpenseTransactionResponse res = sdk.expenses().create() + CreateExpenseTransactionResponse res = sdk.expenses().create() .request(req) .call(); - if (res.createExpenseResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createExpenseResponse().isPresent()) { + // handle response } - } } ``` @@ -87,11 +125,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update @@ -115,25 +152,33 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.ExpenseContactRef; +import io.codat.sync.expenses.models.components.ExpenseTransactionLine; +import io.codat.sync.expenses.models.components.InvoiceTo; +import io.codat.sync.expenses.models.components.InvoiceToType; +import io.codat.sync.expenses.models.components.ItemRef; +import io.codat.sync.expenses.models.components.RecordRef; +import io.codat.sync.expenses.models.components.TrackingRef; +import io.codat.sync.expenses.models.components.TrackingRefDataType; import io.codat.sync.expenses.models.components.Type; import io.codat.sync.expenses.models.components.UpdateExpenseRequest; import io.codat.sync.expenses.models.components.UpdateExpenseRequestBankAccountReference; import io.codat.sync.expenses.models.components.UpdateExpenseRequestType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UpdateExpenseTransactionRequest; import io.codat.sync.expenses.models.operations.UpdateExpenseTransactionResponse; import java.lang.Exception; +import java.math.BigDecimal; import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateExpenseTransactionRequest req = UpdateExpenseTransactionRequest.builder() + UpdateExpenseTransactionRequest req = UpdateExpenseTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .transactionId("336694d8-2dca-4cb5-a28d-3ccb83e55eee") .updateExpenseRequest(UpdateExpenseRequest.builder() @@ -148,30 +193,40 @@ public class Application { .type(Type.SUPPLIER) .build()) .lines(List.of( - )) + ExpenseTransactionLine.builder() + .netAmount(new BigDecimal("100")) + .accountRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .invoiceTo(InvoiceTo.builder() + .id("80000002-1674552702") + .type(InvoiceToType.CUSTOMER) + .build()) + .itemRef(ItemRef.builder() + .id("80000002-1675158984") + .build()) + .taxAmount(new BigDecimal("20")) + .taxRateRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .trackingRefs(List.of( + TrackingRef.builder() + .dataType(TrackingRefDataType.TRACKING_CATEGORIES) + .id("e9a1b63d-9ff0-40e7-8038-016354b987e6") + .build())) + .build())) .merchantName("Amazon UK") .notes("APPLE.COM/BILL - 09001077498 - Card Ending: 4590") .build()) .build(); - UpdateExpenseTransactionResponse res = sdk.expenses().update() + UpdateExpenseTransactionResponse res = sdk.expenses().update() .request(req) .call(); - if (res.updateExpenseResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.updateExpenseResponse().isPresent()) { + // handle response } - } } ``` @@ -188,7 +243,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,422,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 422, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/managedata/README.md b/sync-for-expenses/docs/sdks/managedata/README.md index 90ac134a..d86a08a0 100644 --- a/sync-for-expenses/docs/sdks/managedata/README.md +++ b/sync-for-expenses/docs/sdks/managedata/README.md @@ -23,41 +23,30 @@ Get the state of each data type for a company package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetDataStatusRequest; import io.codat.sync.expenses.models.operations.GetDataStatusResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetDataStatusRequest req = GetDataStatusRequest.builder() + GetDataStatusRequest req = GetDataStatusRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetDataStatusResponse res = sdk.manageData().get() + GetDataStatusResponse res = sdk.manageData().get() .request(req) .call(); - if (res.dataStatuses().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.dataStatuses().isPresent()) { + // handle response } - } } ``` @@ -74,11 +63,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getPullOperation @@ -90,42 +78,31 @@ Retrieve information about a single dataset or pull operation. package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetPullOperationRequest; import io.codat.sync.expenses.models.operations.GetPullOperationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetPullOperationRequest req = GetPullOperationRequest.builder() + GetPullOperationRequest req = GetPullOperationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") - .datasetId("7911a54a-c808-4f4b-b87e-b195f52b4da5") + .datasetId("71a4c0fb-8e15-45bd-958d-330b4e6e9f07") .build(); - GetPullOperationResponse res = sdk.manageData().getPullOperation() + GetPullOperationResponse res = sdk.manageData().getPullOperation() .request(req) .call(); - if (res.pullOperation().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pullOperation().isPresent()) { + // handle response } - } } ``` @@ -142,11 +119,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## listPullOperations @@ -158,20 +134,20 @@ Gets the pull operation history (datasets) for a given company. package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListPullOperationsRequest; import io.codat.sync.expenses.models.operations.ListPullOperationsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListPullOperationsRequest req = ListPullOperationsRequest.builder() + ListPullOperationsRequest req = ListPullOperationsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -179,24 +155,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListPullOperationsResponse res = sdk.manageData().listPullOperations() + ListPullOperationsResponse res = sdk.manageData().listPullOperations() .request(req) .call(); - if (res.pullOperations().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pullOperations().isPresent()) { + // handle response } - } } ``` @@ -213,11 +178,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## refreshAllDataTypes @@ -233,39 +197,28 @@ This is an asynchronous operation, and will bring updated data into Codat from t package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.RefreshAllDataTypesRequest; import io.codat.sync.expenses.models.operations.RefreshAllDataTypesResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - RefreshAllDataTypesRequest req = RefreshAllDataTypesRequest.builder() + RefreshAllDataTypesRequest req = RefreshAllDataTypesRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - RefreshAllDataTypesResponse res = sdk.manageData().refreshAllDataTypes() + RefreshAllDataTypesResponse res = sdk.manageData().refreshAllDataTypes() .request(req) .call(); - // handle response - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -282,11 +235,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## refreshDataType @@ -301,42 +253,31 @@ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; import io.codat.sync.expenses.models.components.SchemaDataType; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.RefreshDataTypeRequest; import io.codat.sync.expenses.models.operations.RefreshDataTypeResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - RefreshDataTypeRequest req = RefreshDataTypeRequest.builder() + RefreshDataTypeRequest req = RefreshDataTypeRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .dataType(SchemaDataType.INVOICES) .build(); - RefreshDataTypeResponse res = sdk.manageData().refreshDataType() + RefreshDataTypeResponse res = sdk.manageData().refreshDataType() .request(req) .call(); - if (res.pullOperation().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pullOperation().isPresent()) { + // handle response } - } } ``` @@ -353,7 +294,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/mappingoptions/README.md b/sync-for-expenses/docs/sdks/mappingoptions/README.md index f8c15ea9..ac36560e 100644 --- a/sync-for-expenses/docs/sdks/mappingoptions/README.md +++ b/sync-for-expenses/docs/sdks/mappingoptions/README.md @@ -19,41 +19,30 @@ Gets the mapping options (accounts, trackingCategories and taxRates) for a compa package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetMappingOptionsRequest; import io.codat.sync.expenses.models.operations.GetMappingOptionsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetMappingOptionsRequest req = GetMappingOptionsRequest.builder() + GetMappingOptionsRequest req = GetMappingOptionsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetMappingOptionsResponse res = sdk.mappingOptions().getMappingOptions() + GetMappingOptionsResponse res = sdk.mappingOptions().getMappingOptions() .request(req) .call(); - if (res.mappingOptions().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.mappingOptions().isPresent()) { + // handle response } - } } ``` @@ -70,7 +59,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/pushoperations/README.md b/sync-for-expenses/docs/sdks/pushoperations/README.md index 5e6abc45..4eaad6f4 100644 --- a/sync-for-expenses/docs/sdks/pushoperations/README.md +++ b/sync-for-expenses/docs/sdks/pushoperations/README.md @@ -20,42 +20,31 @@ Retrieve push operation. package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetPushOperationRequest; import io.codat.sync.expenses.models.operations.GetPushOperationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetPushOperationRequest req = GetPushOperationRequest.builder() + GetPushOperationRequest req = GetPushOperationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") - .pushOperationKey("b18d8d81-fd7b-4764-a31e-475cb1f36591") + .pushOperationKey("b888f774-3e7c-4135-a18c-6b985523c4bc") .build(); - GetPushOperationResponse res = sdk.pushOperations().get() + GetPushOperationResponse res = sdk.pushOperations().get() .request(req) .call(); - if (res.pushOperation().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOperation().isPresent()) { + // handle response } - } } ``` @@ -72,11 +61,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -88,20 +76,20 @@ List push operation records. package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListPushOperationsRequest; import io.codat.sync.expenses.models.operations.ListPushOperationsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListPushOperationsRequest req = ListPushOperationsRequest.builder() + ListPushOperationsRequest req = ListPushOperationsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -109,24 +97,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListPushOperationsResponse res = sdk.pushOperations().list() + ListPushOperationsResponse res = sdk.pushOperations().list() .request(req) .call(); - if (res.pushOperations().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOperations().isPresent()) { + // handle response } - } } ``` @@ -143,7 +120,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/reimbursements/README.md b/sync-for-expenses/docs/sdks/reimbursements/README.md index 81caf088..8ab3b5af 100644 --- a/sync-for-expenses/docs/sdks/reimbursements/README.md +++ b/sync-for-expenses/docs/sdks/reimbursements/README.md @@ -30,44 +30,80 @@ Use the *Create reimbursable expense* endpoint to submit an employee expense cla package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.components.ApAccountRef; +import io.codat.sync.expenses.models.components.InvoiceTo; +import io.codat.sync.expenses.models.components.InvoiceToType; +import io.codat.sync.expenses.models.components.ItemRef; +import io.codat.sync.expenses.models.components.RecordRef; +import io.codat.sync.expenses.models.components.ReimbursableExpenseTransaction; +import io.codat.sync.expenses.models.components.ReimbursableExpenseTransactionLine; +import io.codat.sync.expenses.models.components.ReimbursementContactRef; +import io.codat.sync.expenses.models.components.TrackingRef; +import io.codat.sync.expenses.models.components.TrackingRefDataType; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateReimbursableExpenseTransactionRequest; import io.codat.sync.expenses.models.operations.CreateReimbursableExpenseTransactionResponse; import java.lang.Exception; +import java.math.BigDecimal; import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateReimbursableExpenseTransactionRequest req = CreateReimbursableExpenseTransactionRequest.builder() + CreateReimbursableExpenseTransactionRequest req = CreateReimbursableExpenseTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .requestBody(List.of( - )) + ReimbursableExpenseTransaction.builder() + .contactRef(ReimbursementContactRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .currency("GBP") + .dueDate("2022-10-23T00:00:00Z") + .id("4d7c6929-7770-412b-91bb-44d3bc71d111") + .issueDate("2022-10-23T00:00:00Z") + .apAccountRef(ApAccountRef.builder() + .id("8000004C-1724173136") + .build()) + .lines(List.of( + ReimbursableExpenseTransactionLine.builder() + .netAmount(new BigDecimal("100")) + .accountRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .description("2-night hotel stay") + .invoiceTo(InvoiceTo.builder() + .id("80000002-1674552702") + .type(InvoiceToType.CUSTOMER) + .build()) + .itemRef(ItemRef.builder() + .id("80000002-1675158984") + .build()) + .taxAmount(new BigDecimal("20")) + .taxRateRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .trackingRefs(List.of( + TrackingRef.builder() + .dataType(TrackingRefDataType.TRACKING_CATEGORIES) + .id("e9a1b63d-9ff0-40e7-8038-016354b987e6") + .build())) + .build())) + .notes("APPLE.COM/BILL - 09001077498 - Card Ending: 4590") + .build())) .build(); - CreateReimbursableExpenseTransactionResponse res = sdk.reimbursements().create() + CreateReimbursableExpenseTransactionResponse res = sdk.reimbursements().create() .request(req) .call(); - if (res.createReimbursableExpenseResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createReimbursableExpenseResponse().isPresent()) { + // handle response } - } } ``` @@ -84,11 +120,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update @@ -100,7 +135,6 @@ Updating an existing [reimbursable expense transaction](https://docs.codat.io/sy | Integration | Supported | |-----------------------|-----------| | FreeAgent | Yes | -| QuickBooks Desktop | Yes | | QuickBooks Online | Yes | | Oracle NetSuite | Yes | @@ -110,22 +144,31 @@ Updating an existing [reimbursable expense transaction](https://docs.codat.io/sy package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; +import io.codat.sync.expenses.models.components.ApAccountRef; +import io.codat.sync.expenses.models.components.InvoiceTo; +import io.codat.sync.expenses.models.components.InvoiceToType; +import io.codat.sync.expenses.models.components.ItemRef; +import io.codat.sync.expenses.models.components.RecordRef; +import io.codat.sync.expenses.models.components.ReimbursableExpenseTransactionLine; import io.codat.sync.expenses.models.components.ReimbursementContactRef; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.components.TrackingRef; +import io.codat.sync.expenses.models.components.TrackingRefDataType; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UpdateReimbursableExpenseTransactionRequest; import io.codat.sync.expenses.models.operations.UpdateReimbursableExpenseTransactionResponse; import java.lang.Exception; +import java.math.BigDecimal; import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateReimbursableExpenseTransactionRequest req = UpdateReimbursableExpenseTransactionRequest.builder() + UpdateReimbursableExpenseTransactionRequest req = UpdateReimbursableExpenseTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .transactionId("336694d8-2dca-4cb5-a28d-3ccb83e55eee") .updateReimbursableExpenseTransactionRequest(io.codat.sync.expenses.models.components.UpdateReimbursableExpenseTransactionRequest.builder() @@ -135,30 +178,44 @@ public class Application { .currency("GBP") .dueDate("2022-10-23T00:00:00Z") .issueDate("2022-10-23T00:00:00Z") + .apAccountRef(ApAccountRef.builder() + .id("8000004C-1724173136") + .build()) .lines(List.of( - )) + ReimbursableExpenseTransactionLine.builder() + .netAmount(new BigDecimal("100")) + .accountRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .description("2-night hotel stay") + .invoiceTo(InvoiceTo.builder() + .id("80000002-1674552702") + .type(InvoiceToType.CUSTOMER) + .build()) + .itemRef(ItemRef.builder() + .id("80000002-1675158984") + .build()) + .taxAmount(new BigDecimal("20")) + .taxRateRef(RecordRef.builder() + .id("40e3e57c-2322-4898-966c-ca41adfd23fd") + .build()) + .trackingRefs(List.of( + TrackingRef.builder() + .dataType(TrackingRefDataType.TRACKING_CATEGORIES) + .id("e9a1b63d-9ff0-40e7-8038-016354b987e6") + .build())) + .build())) .notes("APPLE.COM/BILL - 09001077498 - Card Ending: 4590") .build()) .build(); - UpdateReimbursableExpenseTransactionResponse res = sdk.reimbursements().update() + UpdateReimbursableExpenseTransactionResponse res = sdk.reimbursements().update() .request(req) .call(); - if (res.createReimbursableExpenseResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createReimbursableExpenseResponse().isPresent()) { + // handle response } - } } ``` @@ -175,7 +232,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/suppliers/README.md b/sync-for-expenses/docs/sdks/suppliers/README.md index 728d4c5e..1cb30b3b 100644 --- a/sync-for-expenses/docs/sdks/suppliers/README.md +++ b/sync-for-expenses/docs/sdks/suppliers/README.md @@ -21,8 +21,6 @@ The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sy **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. ### Example Usage @@ -31,50 +29,74 @@ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; +import io.codat.sync.expenses.models.components.AccountingAddressType; +import io.codat.sync.expenses.models.components.Items; +import io.codat.sync.expenses.models.components.Metadata; +import io.codat.sync.expenses.models.components.SupplementalData; import io.codat.sync.expenses.models.components.Supplier; import io.codat.sync.expenses.models.components.SupplierStatus; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateSupplierRequest; import io.codat.sync.expenses.models.operations.CreateSupplierResponse; import java.lang.Exception; +import java.util.List; +import java.util.Map; +import java.util.Optional; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateSupplierRequest req = CreateSupplierRequest.builder() + CreateSupplierRequest req = CreateSupplierRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .supplier(Supplier.builder() .status(SupplierStatus.ACTIVE) + .addresses(List.of( + Items.builder() + .type(AccountingAddressType.BILLING) + .city("Bakersfield") + .country("USA") + .line1("Unit 51") + .line2("Bakersfield Industrial Estate") + .region("California") + .build())) + .contactName("Kelly's Industrial Supplies") + .defaultCurrency("string") + .emailAddress("sales@kellysupplies.com") + .id("C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F") + .metadata(Metadata.builder() + .isDeleted(true) + .build()) .modifiedDate("2022-10-23T00:00:00Z") - .phone("(877) 492-8687") + .phone("07999 999999") + .registrationNumber("string") .sourceModifiedDate("2022-10-23T00:00:00Z") + .supplementalData(SupplementalData.builder() + .content(Map.ofEntries( + Map.entry("property1", Map.ofEntries( + Map.entry("property1", Optional.empty()), + Map.entry("property2", Optional.empty()))), + Map.entry("property2", Map.ofEntries( + Map.entry("property1", Optional.empty()), + Map.entry("property2", Optional.empty()))))) + .build()) + .supplierName("Kelly's Industrial Supplies") + .taxNumber("string") .build()) .build(); - CreateSupplierResponse res = sdk.suppliers().create() + CreateSupplierResponse res = sdk.suppliers().create() .request(req) .call(); - if (res.createSupplierResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createSupplierResponse().isPresent()) { + // handle response } - } } ``` @@ -91,11 +113,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -103,8 +124,6 @@ The *Get supplier* endpoint returns a single supplier for a given supplierId. [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). @@ -114,42 +133,31 @@ Before using this endpoint, you must have [retrieved data for the company](https package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetSupplierRequest; import io.codat.sync.expenses.models.operations.GetSupplierResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetSupplierRequest req = GetSupplierRequest.builder() + GetSupplierRequest req = GetSupplierRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") - .supplierId("13d946f0-c5d5-42bc-b092-97ece17923ab") + .supplierId("7110701885") .build(); - GetSupplierResponse res = sdk.suppliers().get() + GetSupplierResponse res = sdk.suppliers().get() .request(req) .call(); - if (res.supplier().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.supplier().isPresent()) { + // handle response } - } } ``` @@ -166,11 +174,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -187,20 +194,20 @@ Before using this endpoint, you must have [retrieved data for the company](https package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListSuppliersRequest; import io.codat.sync.expenses.models.operations.ListSuppliersResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListSuppliersRequest req = ListSuppliersRequest.builder() + ListSuppliersRequest req = ListSuppliersRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -208,24 +215,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListSuppliersResponse res = sdk.suppliers().list() + ListSuppliersResponse res = sdk.suppliers().list() .request(req) .call(); - if (res.suppliers().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.suppliers().isPresent()) { + // handle response } - } } ``` @@ -242,11 +238,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update @@ -256,10 +251,7 @@ The *Update supplier* endpoint updates an existing [supplier](https://docs.codat **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - +Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). ### Example Usage @@ -267,51 +259,75 @@ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/ package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; +import io.codat.sync.expenses.models.components.AccountingAddressType; +import io.codat.sync.expenses.models.components.Items; +import io.codat.sync.expenses.models.components.Metadata; +import io.codat.sync.expenses.models.components.SupplementalData; import io.codat.sync.expenses.models.components.Supplier; import io.codat.sync.expenses.models.components.SupplierStatus; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.UpdateSupplierRequest; import io.codat.sync.expenses.models.operations.UpdateSupplierResponse; import java.lang.Exception; +import java.util.List; +import java.util.Map; +import java.util.Optional; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateSupplierRequest req = UpdateSupplierRequest.builder() + UpdateSupplierRequest req = UpdateSupplierRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") - .supplierId("13d946f0-c5d5-42bc-b092-97ece17923ab") + .supplierId("EILBDVJVNUAGVKRQ") .supplier(Supplier.builder() .status(SupplierStatus.ACTIVE) + .addresses(List.of( + Items.builder() + .type(AccountingAddressType.BILLING) + .city("Bakersfield") + .country("USA") + .line1("Unit 51") + .line2("Bakersfield Industrial Estate") + .region("California") + .build())) + .contactName("Kelly's Industrial Supplies") + .defaultCurrency("string") + .emailAddress("sales@kellysupplies.com") + .id("C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F") + .metadata(Metadata.builder() + .isDeleted(true) + .build()) .modifiedDate("2022-10-23T00:00:00Z") - .phone("01224 658 999") + .phone("07999 999999") + .registrationNumber("string") .sourceModifiedDate("2022-10-23T00:00:00Z") + .supplementalData(SupplementalData.builder() + .content(Map.ofEntries( + Map.entry("property1", Map.ofEntries( + Map.entry("property1", Optional.empty()), + Map.entry("property2", Optional.empty()))), + Map.entry("property2", Map.ofEntries( + Map.entry("property1", Optional.empty()), + Map.entry("property2", Optional.empty()))))) + .build()) + .supplierName("Kelly's Industrial Supplies") + .taxNumber("string") .build()) .build(); - UpdateSupplierResponse res = sdk.suppliers().update() + UpdateSupplierResponse res = sdk.suppliers().update() .request(req) .call(); - if (res.updateSupplierResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.updateSupplierResponse().isPresent()) { + // handle response } - } } ``` @@ -328,7 +344,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/sync/README.md b/sync-for-expenses/docs/sdks/sync/README.md index 7a0ead87..f5a0571b 100644 --- a/sync-for-expenses/docs/sdks/sync/README.md +++ b/sync-for-expenses/docs/sdks/sync/README.md @@ -22,42 +22,31 @@ Get the sync status for a specified sync package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetSyncByIdRequest; import io.codat.sync.expenses.models.operations.GetSyncByIdResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetSyncByIdRequest req = GetSyncByIdRequest.builder() + GetSyncByIdRequest req = GetSyncByIdRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .syncId("6fb40d5e-b13e-11ed-afa1-0242ac120002") .build(); - GetSyncByIdResponse res = sdk.sync().get() + GetSyncByIdResponse res = sdk.sync().get() .request(req) .call(); - if (res.companySyncStatus().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companySyncStatus().isPresent()) { + // handle response } - } } ``` @@ -74,11 +63,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getLastSuccessfulSync @@ -90,41 +78,30 @@ Gets the status of the last successful sync package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetLastSuccessfulSyncRequest; import io.codat.sync.expenses.models.operations.GetLastSuccessfulSyncResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetLastSuccessfulSyncRequest req = GetLastSuccessfulSyncRequest.builder() + GetLastSuccessfulSyncRequest req = GetLastSuccessfulSyncRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetLastSuccessfulSyncResponse res = sdk.sync().getLastSuccessfulSync() + GetLastSuccessfulSyncResponse res = sdk.sync().getLastSuccessfulSync() .request(req) .call(); - if (res.companySyncStatus().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companySyncStatus().isPresent()) { + // handle response } - } } ``` @@ -141,11 +118,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getLatestSync @@ -157,41 +133,30 @@ Gets the latest sync status package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetLatestSyncRequest; import io.codat.sync.expenses.models.operations.GetLatestSyncResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetLatestSyncRequest req = GetLatestSyncRequest.builder() + GetLatestSyncRequest req = GetLatestSyncRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetLatestSyncResponse res = sdk.sync().getLatestSync() + GetLatestSyncResponse res = sdk.sync().getLatestSync() .request(req) .call(); - if (res.companySyncStatus().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companySyncStatus().isPresent()) { + // handle response } - } } ``` @@ -208,11 +173,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -224,41 +188,30 @@ Gets a list of sync statuses package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListSyncsRequest; import io.codat.sync.expenses.models.operations.ListSyncsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListSyncsRequest req = ListSyncsRequest.builder() + ListSyncsRequest req = ListSyncsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - ListSyncsResponse res = sdk.sync().list() + ListSyncsResponse res = sdk.sync().list() .request(req) .call(); - if (res.classes().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.classes().isPresent()) { + // handle response } - } } ``` @@ -275,7 +228,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/transactionstatus/README.md b/sync-for-expenses/docs/sdks/transactionstatus/README.md index 6e071508..8511bcae 100644 --- a/sync-for-expenses/docs/sdks/transactionstatus/README.md +++ b/sync-for-expenses/docs/sdks/transactionstatus/README.md @@ -20,43 +20,32 @@ Gets the status of a transaction for a sync package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.GetSyncTransactionRequest; import io.codat.sync.expenses.models.operations.GetSyncTransactionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetSyncTransactionRequest req = GetSyncTransactionRequest.builder() + GetSyncTransactionRequest req = GetSyncTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .syncId("6fb40d5e-b13e-11ed-afa1-0242ac120002") .transactionId("336694d8-2dca-4cb5-a28d-3ccb83e55eee") .build(); - GetSyncTransactionResponse res = sdk.transactionStatus().get() + GetSyncTransactionResponse res = sdk.transactionStatus().get() .request(req) .call(); - if (res.transactionResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.transactionResponse().isPresent()) { + // handle response } - } } ``` @@ -73,11 +62,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -89,44 +77,33 @@ Gets the transactions and status for a sync package hello.world; import io.codat.sync.expenses.CodatSyncExpenses; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.ListSyncTransactionsRequest; import io.codat.sync.expenses.models.operations.ListSyncTransactionsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListSyncTransactionsRequest req = ListSyncTransactionsRequest.builder() + ListSyncTransactionsRequest req = ListSyncTransactionsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .syncId("6fb40d5e-b13e-11ed-afa1-0242ac120002") .page(1) .pageSize(100) .build(); - ListSyncTransactionsResponse res = sdk.transactionStatus().list() + ListSyncTransactionsResponse res = sdk.transactionStatus().list() .request(req) .call(); - if (res.transactions().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.transactions().isPresent()) { + // handle response } - } } ``` @@ -143,7 +120,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/docs/sdks/transfers/README.md b/sync-for-expenses/docs/sdks/transfers/README.md index 524809e8..4e386836 100644 --- a/sync-for-expenses/docs/sdks/transfers/README.md +++ b/sync-for-expenses/docs/sdks/transfers/README.md @@ -36,7 +36,7 @@ import io.codat.sync.expenses.models.components.From; import io.codat.sync.expenses.models.components.To; import io.codat.sync.expenses.models.components.TransferTransactionRequest; import io.codat.sync.expenses.models.components.TransferTransactionRequestAccountReference; -import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.operations.CreateTransferTransactionRequest; import io.codat.sync.expenses.models.operations.CreateTransferTransactionResponse; import java.lang.Exception; @@ -44,13 +44,13 @@ import java.math.BigDecimal; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatSyncExpenses sdk = CodatSyncExpenses.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatSyncExpenses sdk = CodatSyncExpenses.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateTransferTransactionRequest req = CreateTransferTransactionRequest.builder() + CreateTransferTransactionRequest req = CreateTransferTransactionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .transactionId("336694d8-2dca-4cb5-a28d-3ccb83e55eee") .transferTransactionRequest(TransferTransactionRequest.builder() @@ -65,30 +65,19 @@ public class Application { .accountRef(TransferTransactionRequestAccountReference.builder() .id("") .build()) - .amount(new BigDecimal("8592.13")) + .amount(new BigDecimal("4174.58")) .build()) .description("Transfer from bank account Y to bank account Z") .build()) .build(); - CreateTransferTransactionResponse res = sdk.transfers().create() + CreateTransferTransactionResponse res = sdk.transfers().create() .request(req) .call(); - if (res.transferTransactionResponse().isPresent()) { - // handle response - } - } catch (io.codat.sync.expenses.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.transferTransactionResponse().isPresent()) { + // handle response } - } } ``` @@ -105,7 +94,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Accounts.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Accounts.java index 2e925fbc..978a1763 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Accounts.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Accounts.java @@ -63,9 +63,6 @@ public class Accounts implements * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @return The call builder */ public CreateAccountRequestBuilder create() { @@ -81,9 +78,6 @@ public CreateAccountRequestBuilder create() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -102,9 +96,6 @@ public CreateAccountResponse create( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -115,7 +106,7 @@ public CreateAccountResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -137,7 +128,7 @@ public CreateAccountResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateAccountRequest.class, @@ -274,9 +265,6 @@ public CreateAccountResponse create( * **Integration-specific behaviour** * * See the *response examples* for integration-specific indicative models. - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @return The call builder */ public GetCreateChartOfAccountsModelRequestBuilder getCreateModel() { @@ -292,9 +280,6 @@ public GetCreateChartOfAccountsModelRequestBuilder getCreateModel() { * **Integration-specific behaviour** * * See the *response examples* for integration-specific indicative models. - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -313,9 +298,6 @@ public GetCreateChartOfAccountsModelResponse getCreateModel( * **Integration-specific behaviour** * * See the *response examples* for integration-specific indicative models. - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -326,7 +308,7 @@ public GetCreateChartOfAccountsModelResponse getCreateModel( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -338,7 +320,7 @@ public GetCreateChartOfAccountsModelResponse getCreateModel( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Adjustments.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Adjustments.java index 6c5037c6..ca5cbf8b 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Adjustments.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Adjustments.java @@ -108,7 +108,7 @@ public CreateAdjustmentTransactionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -130,7 +130,7 @@ public CreateAdjustmentTransactionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Attachments.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Attachments.java index 02d297fa..b92fc5a3 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Attachments.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Attachments.java @@ -54,18 +54,20 @@ public class Attachments implements * Upload attachment * The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. * - * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. + * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. * * **Integration-specific behaviour** * * Each accounting software supports different file formats and sizes. * - * | Integration | File Size | File Extension | - * |-------------|-------------|--------------------------------------------------------------------------------------------------------------| - * | Xero | 3MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | - * | QuickBooks Online | 100MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | - * | NetSuite | 100MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | - * | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files". | + * | Integration | File size | File extension |Supported transaction type + * |-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| + * | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | + * | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` | + * | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` | + * | **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types + * | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | + * | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF * @return The call builder */ public UploadExpenseAttachmentRequestBuilder upload() { @@ -76,18 +78,20 @@ public UploadExpenseAttachmentRequestBuilder upload() { * Upload attachment * The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. * - * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. + * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. * * **Integration-specific behaviour** * * Each accounting software supports different file formats and sizes. * - * | Integration | File Size | File Extension | - * |-------------|-------------|--------------------------------------------------------------------------------------------------------------| - * | Xero | 3MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | - * | QuickBooks Online | 100MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | - * | NetSuite | 100MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | - * | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files". | + * | Integration | File size | File extension |Supported transaction type + * |-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| + * | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | + * | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` | + * | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` | + * | **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types + * | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | + * | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -101,18 +105,20 @@ public UploadExpenseAttachmentResponse upload( * Upload attachment * The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. * - * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. + * [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. * * **Integration-specific behaviour** * * Each accounting software supports different file formats and sizes. * - * | Integration | File Size | File Extension | - * |-------------|-------------|--------------------------------------------------------------------------------------------------------------| - * | Xero | 3MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | - * | QuickBooks Online | 100MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | - * | NetSuite | 100MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | - * | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files". | + * | Integration | File size | File extension |Supported transaction type + * |-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------| + * | **Xero** | 3 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | All supported types | + * | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` | + * | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` | + * | **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types + * | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | + * | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -123,7 +129,7 @@ public UploadExpenseAttachmentResponse upload( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -145,7 +151,7 @@ public UploadExpenseAttachmentResponse upload( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/BankAccounts.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/BankAccounts.java index 130626a5..96175b90 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/BankAccounts.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/BankAccounts.java @@ -63,8 +63,6 @@ public class BankAccounts implements * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @return The call builder */ public CreateBankAccountRequestBuilder create() { @@ -80,8 +78,6 @@ public CreateBankAccountRequestBuilder create() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -100,8 +96,6 @@ public CreateBankAccountResponse create( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -112,7 +106,7 @@ public CreateBankAccountResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -134,7 +128,7 @@ public CreateBankAccountResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateBankAccountRequest.class, @@ -272,8 +266,6 @@ public CreateBankAccountResponse create( * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @return The call builder */ public GetCreateBankAccountsModelRequestBuilder getCreateModel() { @@ -290,8 +282,6 @@ public GetCreateBankAccountsModelRequestBuilder getCreateModel() { * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -311,8 +301,6 @@ public GetCreateBankAccountsModelResponse getCreateModel( * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -323,7 +311,7 @@ public GetCreateBankAccountsModelResponse getCreateModel( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -335,7 +323,7 @@ public GetCreateBankAccountsModelResponse getCreateModel( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/CodatSyncExpenses.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/CodatSyncExpenses.java index eb693205..54147de4 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/CodatSyncExpenses.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/CodatSyncExpenses.java @@ -8,6 +8,7 @@ import io.codat.sync.expenses.utils.HTTPClient; import io.codat.sync.expenses.utils.RetryConfig; import io.codat.sync.expenses.utils.SpeakeasyHTTPClient; +import io.codat.sync.expenses.utils.Utils; import java.lang.String; import java.util.Map; import java.util.Optional; @@ -90,6 +91,11 @@ public class CodatSyncExpenses { */ private final ManageData manageData; + /** + * View the company information of your customers' linked accounting software. + */ + private final CompanyInfo companyInfo; + /** * View historic push operations. */ @@ -189,6 +195,13 @@ public ManageData manageData() { return manageData; } + /** + * View the company information of your customers' linked accounting software. + */ + public CompanyInfo companyInfo() { + return companyInfo; + } + /** * View historic push operations. */ @@ -323,7 +336,7 @@ public Builder serverURL(String serverUrl) { * @return The builder instance. */ public Builder serverURL(String serverUrl, Map params) { - this.sdkConfiguration.serverUrl = io.codat.sync.expenses.utils.Utils.templateUrl(serverUrl, params); + this.sdkConfiguration.serverUrl = Utils.templateUrl(serverUrl, params); return this; } @@ -393,6 +406,7 @@ private CodatSyncExpenses(SDKConfiguration sdkConfiguration) { this.customers = new Customers(sdkConfiguration); this.suppliers = new Suppliers(sdkConfiguration); this.manageData = new ManageData(sdkConfiguration); + this.companyInfo = new CompanyInfo(sdkConfiguration); this.pushOperations = new PushOperations(sdkConfiguration); this.adjustments = new Adjustments(sdkConfiguration); this.configuration = new Configuration(sdkConfiguration); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Companies.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Companies.java index 28f8bbac..14418df3 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Companies.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Companies.java @@ -113,7 +113,7 @@ public CreateCompanyResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -133,7 +133,7 @@ public CreateCompanyResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -302,7 +302,7 @@ public DeleteCompanyResponse delete( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -314,7 +314,7 @@ public DeleteCompanyResponse delete( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -472,7 +472,7 @@ public GetCompanyResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -484,7 +484,7 @@ public GetCompanyResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -609,7 +609,7 @@ public GetCompanyResponse get( /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -621,7 +621,7 @@ public ListCompaniesRequestBuilder list() { /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -636,7 +636,7 @@ public ListCompaniesResponse list( /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -650,7 +650,7 @@ public ListCompaniesResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -660,7 +660,7 @@ public ListCompaniesResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListCompaniesRequest.class, @@ -791,7 +791,6 @@ public ListCompaniesResponse list( /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/sync-for-expenses-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/sync-for-expenses-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/sync-for-expenses-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -804,7 +803,6 @@ public UpdateCompanyRequestBuilder update() { /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/sync-for-expenses-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/sync-for-expenses-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/sync-for-expenses-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -820,7 +818,6 @@ public UpdateCompanyResponse update( /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/sync-for-expenses-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/sync-for-expenses-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/sync-for-expenses-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -834,7 +831,7 @@ public UpdateCompanyResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -856,7 +853,7 @@ public UpdateCompanyResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/CompanyInfo.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/CompanyInfo.java new file mode 100644 index 00000000..594b44d6 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/CompanyInfo.java @@ -0,0 +1,217 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses; + +import com.fasterxml.jackson.core.type.TypeReference; +import io.codat.sync.expenses.models.components.CompanyInformation; +import io.codat.sync.expenses.models.errors.ErrorMessage; +import io.codat.sync.expenses.models.errors.SDKError; +import io.codat.sync.expenses.models.operations.GetCompanyInfoRequest; +import io.codat.sync.expenses.models.operations.GetCompanyInfoRequestBuilder; +import io.codat.sync.expenses.models.operations.GetCompanyInfoResponse; +import io.codat.sync.expenses.models.operations.SDKMethodInterfaces.*; +import io.codat.sync.expenses.utils.BackoffStrategy; +import io.codat.sync.expenses.utils.HTTPClient; +import io.codat.sync.expenses.utils.HTTPRequest; +import io.codat.sync.expenses.utils.Hook.AfterErrorContextImpl; +import io.codat.sync.expenses.utils.Hook.AfterSuccessContextImpl; +import io.codat.sync.expenses.utils.Hook.BeforeRequestContextImpl; +import io.codat.sync.expenses.utils.Options; +import io.codat.sync.expenses.utils.Retries.NonRetryableException; +import io.codat.sync.expenses.utils.Retries; +import io.codat.sync.expenses.utils.RetryConfig; +import io.codat.sync.expenses.utils.Utils; +import java.io.InputStream; +import java.lang.Exception; +import java.lang.String; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.TimeUnit; + +/** + * View the company information of your customers' linked accounting software. + */ +public class CompanyInfo implements + MethodCallGetCompanyInfo { + + private final SDKConfiguration sdkConfiguration; + + CompanyInfo(SDKConfiguration sdkConfiguration) { + this.sdkConfiguration = sdkConfiguration; + } + + + /** + * Get company info + * Gets the latest basic info for a company. + * @return The call builder + */ + public GetCompanyInfoRequestBuilder get() { + return new GetCompanyInfoRequestBuilder(this); + } + + /** + * Get company info + * Gets the latest basic info for a company. + * @param request The request object containing all of the parameters for the API call. + * @return The response from the API call + * @throws Exception if the API call fails + */ + public GetCompanyInfoResponse get( + GetCompanyInfoRequest request) throws Exception { + return get(request, Optional.empty()); + } + + /** + * Get company info + * Gets the latest basic info for a company. + * @param request The request object containing all of the parameters for the API call. + * @param options additional options + * @return The response from the API call + * @throws Exception if the API call fails + */ + public GetCompanyInfoResponse get( + GetCompanyInfoRequest request, + Optional options) throws Exception { + + if (options.isPresent()) { + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); + } + String _baseUrl = this.sdkConfiguration.serverUrl; + String _url = Utils.generateURL( + GetCompanyInfoRequest.class, + _baseUrl, + "/companies/{companyId}/data/info", + request, null); + + HTTPRequest _req = new HTTPRequest(_url, "GET"); + _req.addHeader("Accept", "application/json") + .addHeader("user-agent", + SDKConfiguration.USER_AGENT); + + Utils.configureSecurity(_req, + this.sdkConfiguration.securitySource.getSecurity()); + + HTTPClient _client = this.sdkConfiguration.defaultClient; + HTTPRequest _finalReq = _req; + RetryConfig _retryConfig; + if (options.isPresent() && options.get().retryConfig().isPresent()) { + _retryConfig = options.get().retryConfig().get(); + } else if (this.sdkConfiguration.retryConfig.isPresent()) { + _retryConfig = this.sdkConfiguration.retryConfig.get(); + } else { + _retryConfig = RetryConfig.builder() + .backoff(BackoffStrategy.builder() + .initialInterval(500, TimeUnit.MILLISECONDS) + .maxInterval(60000, TimeUnit.MILLISECONDS) + .baseFactor((double)(1.5)) + .maxElapsedTime(3600000, TimeUnit.MILLISECONDS) + .retryConnectError(true) + .build()) + .build(); + } + List _statusCodes = new ArrayList<>(); + _statusCodes.add("408"); + _statusCodes.add("429"); + _statusCodes.add("5XX"); + Retries _retries = Retries.builder() + .action(() -> { + HttpRequest _r = null; + try { + _r = sdkConfiguration.hooks() + .beforeRequest( + new BeforeRequestContextImpl( + "get-company-info", + Optional.of(List.of()), + sdkConfiguration.securitySource()), + _finalReq.build()); + } catch (Exception _e) { + throw new NonRetryableException(_e); + } + try { + return _client.send(_r); + } catch (Exception _e) { + return sdkConfiguration.hooks() + .afterError( + new AfterErrorContextImpl( + "get-company-info", + Optional.of(List.of()), + sdkConfiguration.securitySource()), + Optional.empty(), + Optional.of(_e)); + } + }) + .retryConfig(_retryConfig) + .statusCodes(_statusCodes) + .build(); + HttpResponse _httpRes = sdkConfiguration.hooks() + .afterSuccess( + new AfterSuccessContextImpl( + "get-company-info", + Optional.of(List.of()), + sdkConfiguration.securitySource()), + _retries.run()); + String _contentType = _httpRes + .headers() + .firstValue("Content-Type") + .orElse("application/octet-stream"); + GetCompanyInfoResponse.Builder _resBuilder = + GetCompanyInfoResponse + .builder() + .contentType(_contentType) + .statusCode(_httpRes.statusCode()) + .rawResponse(_httpRes); + + GetCompanyInfoResponse _res = _resBuilder.build(); + + if (Utils.statusCodeMatches(_httpRes.statusCode(), "200")) { + if (Utils.contentTypeMatches(_contentType, "application/json")) { + CompanyInformation _out = Utils.mapper().readValue( + Utils.toUtf8AndClose(_httpRes.body()), + new TypeReference() {}); + _res.withCompanyInformation(Optional.ofNullable(_out)); + return _res; + } else { + throw new SDKError( + _httpRes, + _httpRes.statusCode(), + "Unexpected content-type received: " + _contentType, + Utils.extractByteArrayFromBody(_httpRes)); + } + } + if (Utils.statusCodeMatches(_httpRes.statusCode(), "401", "402", "403", "404", "409", "429", "500", "503")) { + if (Utils.contentTypeMatches(_contentType, "application/json")) { + ErrorMessage _out = Utils.mapper().readValue( + Utils.toUtf8AndClose(_httpRes.body()), + new TypeReference() {}); + throw _out; + } else { + throw new SDKError( + _httpRes, + _httpRes.statusCode(), + "Unexpected content-type received: " + _contentType, + Utils.extractByteArrayFromBody(_httpRes)); + } + } + if (Utils.statusCodeMatches(_httpRes.statusCode(), "4XX", "5XX")) { + // no content + throw new SDKError( + _httpRes, + _httpRes.statusCode(), + "API error occurred", + Utils.extractByteArrayFromBody(_httpRes)); + } + throw new SDKError( + _httpRes, + _httpRes.statusCode(), + "Unexpected status code received: " + _httpRes.statusCode(), + Utils.extractByteArrayFromBody(_httpRes)); + } + +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Configuration.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Configuration.java index 915f9051..641b4795 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Configuration.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Configuration.java @@ -88,7 +88,7 @@ public GetCompanyConfigurationResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -100,7 +100,7 @@ public GetCompanyConfigurationResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -257,7 +257,7 @@ public SetCompanyConfigurationResponse set( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -279,7 +279,7 @@ public SetCompanyConfigurationResponse set( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Connections.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Connections.java index 752459ac..0570d96e 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Connections.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Connections.java @@ -74,7 +74,7 @@ public class Connections implements * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/sync-for-expenses-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @return The call builder */ public CreateConnectionRequestBuilder create() { @@ -85,7 +85,7 @@ public CreateConnectionRequestBuilder create() { * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/sync-for-expenses-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -99,7 +99,7 @@ public CreateConnectionResponse create( * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/sync-for-expenses-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -110,7 +110,7 @@ public CreateConnectionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -132,7 +132,7 @@ public CreateConnectionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -289,7 +289,7 @@ public CreatePartnerExpenseConnectionResponse createPartnerExpenseConnection( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -301,7 +301,7 @@ public CreatePartnerExpenseConnectionResponse createPartnerExpenseConnection( HTTPRequest _req = new HTTPRequest(_url, "POST"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -461,7 +461,7 @@ public DeleteConnectionResponse delete( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -473,7 +473,7 @@ public DeleteConnectionResponse delete( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -619,7 +619,7 @@ public GetConnectionResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -631,7 +631,7 @@ public GetConnectionResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -788,7 +788,7 @@ public ListConnectionsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -800,7 +800,7 @@ public ListConnectionsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListConnectionsRequest.class, @@ -962,7 +962,7 @@ public UnlinkConnectionResponse unlink( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -984,7 +984,7 @@ public UnlinkConnectionResponse unlink( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Customers.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Customers.java index 9e951068..8dd6e80e 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Customers.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Customers.java @@ -72,9 +72,6 @@ public class Customers implements * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @return The call builder */ public CreateCustomerRequestBuilder create() { @@ -90,9 +87,6 @@ public CreateCustomerRequestBuilder create() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -111,9 +105,6 @@ public CreateCustomerResponse create( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -124,7 +115,7 @@ public CreateCustomerResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -146,7 +137,7 @@ public CreateCustomerResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateCustomerRequest.class, @@ -280,8 +271,6 @@ public CreateCustomerResponse create( * * [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @return The call builder @@ -296,8 +285,6 @@ public GetCustomerRequestBuilder get() { * * [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @param request The request object containing all of the parameters for the API call. @@ -315,8 +302,6 @@ public GetCustomerResponse get( * * [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @param request The request object containing all of the parameters for the API call. @@ -329,7 +314,7 @@ public GetCustomerResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -341,7 +326,7 @@ public GetCustomerResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -513,7 +498,7 @@ public ListCustomersResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -525,7 +510,7 @@ public ListCustomersResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListCustomersRequest.class, @@ -662,9 +647,6 @@ public ListCustomersResponse list( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @return The call builder */ public UpdateCustomerRequestBuilder update() { @@ -680,9 +662,6 @@ public UpdateCustomerRequestBuilder update() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -701,9 +680,6 @@ public UpdateCustomerResponse update( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -714,7 +690,7 @@ public UpdateCustomerResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -736,7 +712,7 @@ public UpdateCustomerResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( UpdateCustomerRequest.class, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Expenses.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Expenses.java index 70282cdb..c78fb947 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Expenses.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Expenses.java @@ -128,7 +128,7 @@ public CreateExpenseTransactionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -150,7 +150,7 @@ public CreateExpenseTransactionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -340,7 +340,7 @@ public UpdateExpenseTransactionResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -362,7 +362,7 @@ public UpdateExpenseTransactionResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/ManageData.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/ManageData.java index f2b850fb..78345a93 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/ManageData.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/ManageData.java @@ -99,7 +99,7 @@ public GetDataStatusResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -111,7 +111,7 @@ public GetDataStatusResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -268,7 +268,7 @@ public GetPullOperationResponse getPullOperation( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -280,7 +280,7 @@ public GetPullOperationResponse getPullOperation( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -437,7 +437,7 @@ public ListPullOperationsResponse listPullOperations( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -449,7 +449,7 @@ public ListPullOperationsResponse listPullOperations( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListPullOperationsRequest.class, @@ -623,7 +623,7 @@ public RefreshAllDataTypesResponse refreshAllDataTypes( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -635,7 +635,7 @@ public RefreshAllDataTypesResponse refreshAllDataTypes( HTTPRequest _req = new HTTPRequest(_url, "POST"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -787,7 +787,7 @@ public RefreshDataTypeResponse refreshDataType( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -799,7 +799,7 @@ public RefreshDataTypeResponse refreshDataType( HTTPRequest _req = new HTTPRequest(_url, "POST"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( RefreshDataTypeRequest.class, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/MappingOptions.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/MappingOptions.java index 929114f7..74e0c936 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/MappingOptions.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/MappingOptions.java @@ -80,7 +80,7 @@ public GetMappingOptionsResponse getMappingOptions( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -92,7 +92,7 @@ public GetMappingOptionsResponse getMappingOptions( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/PushOperations.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/PushOperations.java index 6a3baf30..3cb484ca 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/PushOperations.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/PushOperations.java @@ -85,7 +85,7 @@ public GetPushOperationResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -97,7 +97,7 @@ public GetPushOperationResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -254,7 +254,7 @@ public ListPushOperationsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -266,7 +266,7 @@ public ListPushOperationsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListPushOperationsRequest.class, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Reimbursements.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Reimbursements.java index 1f3ba397..278fb460 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Reimbursements.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Reimbursements.java @@ -118,7 +118,7 @@ public CreateReimbursableExpenseTransactionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -140,7 +140,7 @@ public CreateReimbursableExpenseTransactionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -273,7 +273,6 @@ public CreateReimbursableExpenseTransactionResponse create( * | Integration | Supported | * |-----------------------|-----------| * | FreeAgent | Yes | - * | QuickBooks Desktop | Yes | * | QuickBooks Online | Yes | * | Oracle NetSuite | Yes | * @return The call builder @@ -292,7 +291,6 @@ public UpdateReimbursableExpenseTransactionRequestBuilder update() { * | Integration | Supported | * |-----------------------|-----------| * | FreeAgent | Yes | - * | QuickBooks Desktop | Yes | * | QuickBooks Online | Yes | * | Oracle NetSuite | Yes | * @param request The request object containing all of the parameters for the API call. @@ -314,7 +312,6 @@ public UpdateReimbursableExpenseTransactionResponse update( * | Integration | Supported | * |-----------------------|-----------| * | FreeAgent | Yes | - * | QuickBooks Desktop | Yes | * | QuickBooks Online | Yes | * | Oracle NetSuite | Yes | * @param request The request object containing all of the parameters for the API call. @@ -327,7 +324,7 @@ public UpdateReimbursableExpenseTransactionResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -349,7 +346,7 @@ public UpdateReimbursableExpenseTransactionResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/SDKConfiguration.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/SDKConfiguration.java index 3ee8752c..385fec82 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/SDKConfiguration.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/SDKConfiguration.java @@ -21,11 +21,14 @@ public Optional securitySource() { public HTTPClient defaultClient; public String serverUrl; public int serverIdx = 0; - public String language = "java"; - public String openapiDocVersion = "prealpha"; - public String sdkVersion = "0.3.0"; - public String genVersion = "2.415.6"; - public String userAgent = "speakeasy-sdk/java 0.3.0 2.415.6 prealpha io.codat.sync.expenses"; + private static final String LANGUAGE = "java"; + public static final String OPENAPI_DOC_VERSION = "prealpha"; + public static final String SDK_VERSION = "1.0.0"; + public static final String GEN_VERSION = "2.463.0"; + private static final String BASE_PACKAGE = "io.codat.sync.expenses"; + public static final String USER_AGENT = + String.format("speakeasy-sdk/%s %s %s %s %s", + LANGUAGE, SDK_VERSION, GEN_VERSION, OPENAPI_DOC_VERSION, BASE_PACKAGE); private Hooks _hooks = createHooks(); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Suppliers.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Suppliers.java index af3a8b40..35c7b96d 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Suppliers.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Suppliers.java @@ -73,8 +73,6 @@ public class Suppliers implements * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @return The call builder */ public CreateSupplierRequestBuilder create() { @@ -91,8 +89,6 @@ public CreateSupplierRequestBuilder create() { * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -112,8 +108,6 @@ public CreateSupplierResponse create( * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -124,7 +118,7 @@ public CreateSupplierResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -146,7 +140,7 @@ public CreateSupplierResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateSupplierRequest.class, @@ -280,8 +274,6 @@ public CreateSupplierResponse create( * * [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @return The call builder @@ -296,8 +288,6 @@ public GetSupplierRequestBuilder get() { * * [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @param request The request object containing all of the parameters for the API call. @@ -315,8 +305,6 @@ public GetSupplierResponse get( * * [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier. - * * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). * * @param request The request object containing all of the parameters for the API call. @@ -329,7 +317,7 @@ public GetSupplierResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -341,7 +329,7 @@ public GetSupplierResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -513,7 +501,7 @@ public ListSuppliersResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -525,7 +513,7 @@ public ListSuppliersResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListSuppliersRequest.class, @@ -662,9 +650,6 @@ public ListSuppliersResponse list( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @return The call builder */ public UpdateSupplierRequestBuilder update() { @@ -680,9 +665,6 @@ public UpdateSupplierRequestBuilder update() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -701,9 +683,6 @@ public UpdateSupplierResponse update( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -714,7 +693,7 @@ public UpdateSupplierResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -736,7 +715,7 @@ public UpdateSupplierResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( UpdateSupplierRequest.class, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Sync.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Sync.java index 30b9d64b..fa5a7c3a 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Sync.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Sync.java @@ -93,7 +93,7 @@ public GetSyncByIdResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -105,7 +105,7 @@ public GetSyncByIdResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -262,7 +262,7 @@ public GetLastSuccessfulSyncResponse getLastSuccessfulSync( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -274,7 +274,7 @@ public GetLastSuccessfulSyncResponse getLastSuccessfulSync( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -431,7 +431,7 @@ public GetLatestSyncResponse getLatestSync( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -443,7 +443,7 @@ public GetLatestSyncResponse getLatestSync( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -600,7 +600,7 @@ public ListSyncsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -612,7 +612,7 @@ public ListSyncsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/TransactionStatus.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/TransactionStatus.java index a52ecc16..75511250 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/TransactionStatus.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/TransactionStatus.java @@ -5,7 +5,7 @@ package io.codat.sync.expenses; import com.fasterxml.jackson.core.type.TypeReference; -import io.codat.sync.expenses.models.components.Transaction; +import io.codat.sync.expenses.models.components.SchemaTransaction; import io.codat.sync.expenses.models.components.Transactions; import io.codat.sync.expenses.models.errors.ErrorMessage; import io.codat.sync.expenses.models.errors.SDKError; @@ -86,7 +86,7 @@ public GetSyncTransactionResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -98,7 +98,7 @@ public GetSyncTransactionResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -177,9 +177,9 @@ public GetSyncTransactionResponse get( if (Utils.statusCodeMatches(_httpRes.statusCode(), "200")) { if (Utils.contentTypeMatches(_contentType, "application/json")) { - List _out = Utils.mapper().readValue( + List _out = Utils.mapper().readValue( Utils.toUtf8AndClose(_httpRes.body()), - new TypeReference>() {}); + new TypeReference>() {}); _res.withTransactionResponse(Optional.ofNullable(_out)); return _res; } else { @@ -255,7 +255,7 @@ public ListSyncTransactionsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -267,7 +267,7 @@ public ListSyncTransactionsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListSyncTransactionsRequest.class, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Transfers.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Transfers.java index 4dd169d6..64e609c9 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/Transfers.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/Transfers.java @@ -120,7 +120,7 @@ public CreateTransferTransactionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.sync.expenses.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -142,7 +142,7 @@ public CreateTransferTransactionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountMappingInfo.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountMappingInfo.java index 8656a489..a0e65520 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountMappingInfo.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountMappingInfo.java @@ -72,6 +72,13 @@ public class AccountMappingInfo { @JsonProperty("nominalCode") private JsonNullable nominalCode; + /** + * Supported endpoints for the account. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("validFor") + private Optional> validFor; + /** * Supported transaction types for the account. */ @@ -88,6 +95,7 @@ public AccountMappingInfo( @JsonProperty("isBankAccount") Optional isBankAccount, @JsonProperty("name") Optional name, @JsonProperty("nominalCode") JsonNullable nominalCode, + @JsonProperty("validFor") Optional> validFor, @JsonProperty("validTransactionTypes") Optional> validTransactionTypes) { Utils.checkNotNull(accountType, "accountType"); Utils.checkNotNull(currency, "currency"); @@ -96,6 +104,7 @@ public AccountMappingInfo( Utils.checkNotNull(isBankAccount, "isBankAccount"); Utils.checkNotNull(name, "name"); Utils.checkNotNull(nominalCode, "nominalCode"); + Utils.checkNotNull(validFor, "validFor"); Utils.checkNotNull(validTransactionTypes, "validTransactionTypes"); this.accountType = accountType; this.currency = currency; @@ -104,11 +113,12 @@ public AccountMappingInfo( this.isBankAccount = isBankAccount; this.name = name; this.nominalCode = nominalCode; + this.validFor = validFor; this.validTransactionTypes = validTransactionTypes; } public AccountMappingInfo() { - this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), JsonNullable.undefined(), Optional.empty()); + this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), JsonNullable.undefined(), Optional.empty(), Optional.empty()); } /** @@ -168,6 +178,15 @@ public JsonNullable nominalCode() { return nominalCode; } + /** + * Supported endpoints for the account. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> validFor() { + return (Optional>) validFor; + } + /** * Supported transaction types for the account. */ @@ -307,6 +326,24 @@ public AccountMappingInfo withNominalCode(JsonNullable nominalCode) { return this; } + /** + * Supported endpoints for the account. + */ + public AccountMappingInfo withValidFor(List validFor) { + Utils.checkNotNull(validFor, "validFor"); + this.validFor = Optional.ofNullable(validFor); + return this; + } + + /** + * Supported endpoints for the account. + */ + public AccountMappingInfo withValidFor(Optional> validFor) { + Utils.checkNotNull(validFor, "validFor"); + this.validFor = validFor; + return this; + } + /** * Supported transaction types for the account. */ @@ -342,6 +379,7 @@ public boolean equals(java.lang.Object o) { Objects.deepEquals(this.isBankAccount, other.isBankAccount) && Objects.deepEquals(this.name, other.name) && Objects.deepEquals(this.nominalCode, other.nominalCode) && + Objects.deepEquals(this.validFor, other.validFor) && Objects.deepEquals(this.validTransactionTypes, other.validTransactionTypes); } @@ -355,6 +393,7 @@ public int hashCode() { isBankAccount, name, nominalCode, + validFor, validTransactionTypes); } @@ -368,6 +407,7 @@ public String toString() { "isBankAccount", isBankAccount, "name", name, "nominalCode", nominalCode, + "validFor", validFor, "validTransactionTypes", validTransactionTypes); } @@ -387,6 +427,8 @@ public final static class Builder { private JsonNullable nominalCode = JsonNullable.undefined(); + private Optional> validFor = Optional.empty(); + private Optional> validTransactionTypes = Optional.empty(); private Builder() { @@ -519,6 +561,24 @@ public Builder nominalCode(JsonNullable nominalCode) { return this; } + /** + * Supported endpoints for the account. + */ + public Builder validFor(List validFor) { + Utils.checkNotNull(validFor, "validFor"); + this.validFor = Optional.ofNullable(validFor); + return this; + } + + /** + * Supported endpoints for the account. + */ + public Builder validFor(Optional> validFor) { + Utils.checkNotNull(validFor, "validFor"); + this.validFor = validFor; + return this; + } + /** * Supported transaction types for the account. */ @@ -546,6 +606,7 @@ public AccountMappingInfo build() { isBankAccount, name, nominalCode, + validFor, validTransactionTypes); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingAccount.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingAccount.java index c3a016f4..e76b7a46 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingAccount.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingAccount.java @@ -25,8 +25,6 @@ /** * AccountingAccount - > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**. * - * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>. - * * ## Overview * * Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company. diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingBankAccount.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingBankAccount.java index c4aa9280..8b9bc995 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingBankAccount.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingBankAccount.java @@ -25,9 +25,7 @@ * > * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. * > - * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) - * - * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>. + * > To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. * * ## Overview * diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingCustomer.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingCustomer.java index e279fa88..febf8c09 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingCustomer.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingCustomer.java @@ -21,9 +21,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * AccountingCustomer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * AccountingCustomer - ## Overview * * A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). * @@ -39,7 +37,7 @@ public class AccountingCustomer { */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("addresses") - private JsonNullable> addresses; + private JsonNullable> addresses; /** * Name of the main contact for the identified customer. @@ -139,7 +137,7 @@ public class AccountingCustomer { @JsonCreator public AccountingCustomer( - @JsonProperty("addresses") JsonNullable> addresses, + @JsonProperty("addresses") JsonNullable> addresses, @JsonProperty("contactName") JsonNullable contactName, @JsonProperty("contacts") JsonNullable> contacts, @JsonProperty("customerName") JsonNullable customerName, @@ -196,8 +194,8 @@ public AccountingCustomer( */ @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable> addresses() { - return (JsonNullable>) addresses; + public JsonNullable> addresses() { + return (JsonNullable>) addresses; } /** @@ -321,7 +319,7 @@ public final static Builder builder() { /** * An array of Addresses. */ - public AccountingCustomer withAddresses(List addresses) { + public AccountingCustomer withAddresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -330,7 +328,7 @@ public AccountingCustomer withAddresses(List> addresses) { + public AccountingCustomer withAddresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; @@ -646,7 +644,7 @@ public String toString() { public final static class Builder { - private JsonNullable> addresses = JsonNullable.undefined(); + private JsonNullable> addresses = JsonNullable.undefined(); private JsonNullable contactName = JsonNullable.undefined(); @@ -683,7 +681,7 @@ private Builder() { /** * An array of Addresses. */ - public Builder addresses(List addresses) { + public Builder addresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -692,7 +690,7 @@ public Builder addresses(List addresses /** * An array of Addresses. */ - public Builder addresses(JsonNullable> addresses) { + public Builder addresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingSupplier.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingSupplier.java index eb86e55f..5f8ed399 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingSupplier.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/AccountingSupplier.java @@ -21,9 +21,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * AccountingSupplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * AccountingSupplier - ## Overview * * From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/GroupReference.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ApAccountRef.java similarity index 63% rename from sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/GroupReference.java rename to sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ApAccountRef.java index 7ac03984..0f20b7c2 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/GroupReference.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ApAccountRef.java @@ -17,28 +17,28 @@ import java.util.Optional; -public class GroupReference { +public class ApAccountRef { /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("id") private Optional id; @JsonCreator - public GroupReference( + public ApAccountRef( @JsonProperty("id") Optional id) { Utils.checkNotNull(id, "id"); this.id = id; } - public GroupReference() { + public ApAccountRef() { this(Optional.empty()); } /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ @JsonIgnore public Optional id() { @@ -50,18 +50,18 @@ public final static Builder builder() { } /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ - public GroupReference withId(String id) { + public ApAccountRef withId(String id) { Utils.checkNotNull(id, "id"); this.id = Optional.ofNullable(id); return this; } /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ - public GroupReference withId(Optional id) { + public ApAccountRef withId(Optional id) { Utils.checkNotNull(id, "id"); this.id = id; return this; @@ -75,7 +75,7 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - GroupReference other = (GroupReference) o; + ApAccountRef other = (ApAccountRef) o; return Objects.deepEquals(this.id, other.id); } @@ -88,7 +88,7 @@ public int hashCode() { @Override public String toString() { - return Utils.toString(GroupReference.class, + return Utils.toString(ApAccountRef.class, "id", id); } @@ -101,7 +101,7 @@ private Builder() { } /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ public Builder id(String id) { Utils.checkNotNull(id, "id"); @@ -110,7 +110,7 @@ public Builder id(String id) { } /** - * Unique identifier for the group. + * Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. */ public Builder id(Optional id) { Utils.checkNotNull(id, "id"); @@ -118,8 +118,8 @@ public Builder id(Optional id) { return this; } - public GroupReference build() { - return new GroupReference( + public ApAccountRef build() { + return new ApAccountRef( id); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/BankAccount.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/BankAccount.java index f7121685..794702eb 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/BankAccount.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/BankAccount.java @@ -24,9 +24,7 @@ * > * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. * > - * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) - * - * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>. + * > To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. * * ## Overview * diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Company.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Company.java index 73de1c6e..44459f48 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Company.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Company.java @@ -15,6 +15,7 @@ import java.lang.String; import java.lang.SuppressWarnings; import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Optional; import org.openapitools.jackson.nullable.JsonNullable; @@ -109,18 +110,36 @@ public class Company { @JsonProperty("name") private String name; + /** + * An array of products that are currently enabled for the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("products") + private Optional> products; + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @JsonProperty("redirect") private String redirect; + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("referenceParentCompany") + private Optional referenceParentCompany; + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("referenceSubsidiaryCompanies") + private Optional> referenceSubsidiaryCompanies; + /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("tags") - private Optional tags; + private Optional> tags; @JsonCreator public Company( @@ -131,8 +150,11 @@ public Company( @JsonProperty("id") String id, @JsonProperty("lastSync") Optional lastSync, @JsonProperty("name") String name, + @JsonProperty("products") Optional> products, @JsonProperty("redirect") String redirect, - @JsonProperty("tags") Optional tags) { + @JsonProperty("referenceParentCompany") Optional referenceParentCompany, + @JsonProperty("referenceSubsidiaryCompanies") Optional> referenceSubsidiaryCompanies, + @JsonProperty("tags") Optional> tags) { Utils.checkNotNull(created, "created"); Utils.checkNotNull(createdByUserName, "createdByUserName"); Utils.checkNotNull(dataConnections, "dataConnections"); @@ -140,7 +162,10 @@ public Company( Utils.checkNotNull(id, "id"); Utils.checkNotNull(lastSync, "lastSync"); Utils.checkNotNull(name, "name"); + Utils.checkNotNull(products, "products"); Utils.checkNotNull(redirect, "redirect"); + Utils.checkNotNull(referenceParentCompany, "referenceParentCompany"); + Utils.checkNotNull(referenceSubsidiaryCompanies, "referenceSubsidiaryCompanies"); Utils.checkNotNull(tags, "tags"); this.created = created; this.createdByUserName = createdByUserName; @@ -149,7 +174,10 @@ public Company( this.id = id; this.lastSync = lastSync; this.name = name; + this.products = products; this.redirect = redirect; + this.referenceParentCompany = referenceParentCompany; + this.referenceSubsidiaryCompanies = referenceSubsidiaryCompanies; this.tags = tags; } @@ -157,7 +185,7 @@ public Company( String id, String name, String redirect) { - this(Optional.empty(), JsonNullable.undefined(), Optional.empty(), Optional.empty(), id, Optional.empty(), name, redirect, Optional.empty()); + this(Optional.empty(), JsonNullable.undefined(), Optional.empty(), Optional.empty(), id, Optional.empty(), name, Optional.empty(), redirect, Optional.empty(), Optional.empty(), Optional.empty()); } /** @@ -250,6 +278,15 @@ public String name() { return name; } + /** + * An array of products that are currently enabled for the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> products() { + return (Optional>) products; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -258,13 +295,28 @@ public String redirect() { return redirect; } + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional referenceParentCompany() { + return (Optional) referenceParentCompany; + } + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> referenceSubsidiaryCompanies() { + return (Optional>) referenceSubsidiaryCompanies; + } + /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ @SuppressWarnings("unchecked") @JsonIgnore - public Optional tags() { - return (Optional) tags; + public Optional> tags() { + return (Optional>) tags; } public final static Builder builder() { @@ -445,6 +497,24 @@ public Company withName(String name) { return this; } + /** + * An array of products that are currently enabled for the company. + */ + public Company withProducts(List products) { + Utils.checkNotNull(products, "products"); + this.products = Optional.ofNullable(products); + return this; + } + + /** + * An array of products that are currently enabled for the company. + */ + public Company withProducts(Optional> products) { + Utils.checkNotNull(products, "products"); + this.products = products; + return this; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -454,10 +524,40 @@ public Company withRedirect(String redirect) { return this; } + public Company withReferenceParentCompany(CompanyReference referenceParentCompany) { + Utils.checkNotNull(referenceParentCompany, "referenceParentCompany"); + this.referenceParentCompany = Optional.ofNullable(referenceParentCompany); + return this; + } + + public Company withReferenceParentCompany(Optional referenceParentCompany) { + Utils.checkNotNull(referenceParentCompany, "referenceParentCompany"); + this.referenceParentCompany = referenceParentCompany; + return this; + } + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + public Company withReferenceSubsidiaryCompanies(List referenceSubsidiaryCompanies) { + Utils.checkNotNull(referenceSubsidiaryCompanies, "referenceSubsidiaryCompanies"); + this.referenceSubsidiaryCompanies = Optional.ofNullable(referenceSubsidiaryCompanies); + return this; + } + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + public Company withReferenceSubsidiaryCompanies(Optional> referenceSubsidiaryCompanies) { + Utils.checkNotNull(referenceSubsidiaryCompanies, "referenceSubsidiaryCompanies"); + this.referenceSubsidiaryCompanies = referenceSubsidiaryCompanies; + return this; + } + /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Company withTags(Tags tags) { + public Company withTags(Map tags) { Utils.checkNotNull(tags, "tags"); this.tags = Optional.ofNullable(tags); return this; @@ -466,7 +566,7 @@ public Company withTags(Tags tags) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Company withTags(Optional tags) { + public Company withTags(Optional> tags) { Utils.checkNotNull(tags, "tags"); this.tags = tags; return this; @@ -489,7 +589,10 @@ public boolean equals(java.lang.Object o) { Objects.deepEquals(this.id, other.id) && Objects.deepEquals(this.lastSync, other.lastSync) && Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.products, other.products) && Objects.deepEquals(this.redirect, other.redirect) && + Objects.deepEquals(this.referenceParentCompany, other.referenceParentCompany) && + Objects.deepEquals(this.referenceSubsidiaryCompanies, other.referenceSubsidiaryCompanies) && Objects.deepEquals(this.tags, other.tags); } @@ -503,7 +606,10 @@ public int hashCode() { id, lastSync, name, + products, redirect, + referenceParentCompany, + referenceSubsidiaryCompanies, tags); } @@ -517,7 +623,10 @@ public String toString() { "id", id, "lastSync", lastSync, "name", name, + "products", products, "redirect", redirect, + "referenceParentCompany", referenceParentCompany, + "referenceSubsidiaryCompanies", referenceSubsidiaryCompanies, "tags", tags); } @@ -537,9 +646,15 @@ public final static class Builder { private String name; + private Optional> products = Optional.empty(); + private String redirect; - private Optional tags = Optional.empty(); + private Optional referenceParentCompany = Optional.empty(); + + private Optional> referenceSubsidiaryCompanies = Optional.empty(); + + private Optional> tags = Optional.empty(); private Builder() { // force use of static builder() method @@ -719,6 +834,24 @@ public Builder name(String name) { return this; } + /** + * An array of products that are currently enabled for the company. + */ + public Builder products(List products) { + Utils.checkNotNull(products, "products"); + this.products = Optional.ofNullable(products); + return this; + } + + /** + * An array of products that are currently enabled for the company. + */ + public Builder products(Optional> products) { + Utils.checkNotNull(products, "products"); + this.products = products; + return this; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -728,10 +861,40 @@ public Builder redirect(String redirect) { return this; } + public Builder referenceParentCompany(CompanyReference referenceParentCompany) { + Utils.checkNotNull(referenceParentCompany, "referenceParentCompany"); + this.referenceParentCompany = Optional.ofNullable(referenceParentCompany); + return this; + } + + public Builder referenceParentCompany(Optional referenceParentCompany) { + Utils.checkNotNull(referenceParentCompany, "referenceParentCompany"); + this.referenceParentCompany = referenceParentCompany; + return this; + } + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + public Builder referenceSubsidiaryCompanies(List referenceSubsidiaryCompanies) { + Utils.checkNotNull(referenceSubsidiaryCompanies, "referenceSubsidiaryCompanies"); + this.referenceSubsidiaryCompanies = Optional.ofNullable(referenceSubsidiaryCompanies); + return this; + } + + /** + * A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + */ + public Builder referenceSubsidiaryCompanies(Optional> referenceSubsidiaryCompanies) { + Utils.checkNotNull(referenceSubsidiaryCompanies, "referenceSubsidiaryCompanies"); + this.referenceSubsidiaryCompanies = referenceSubsidiaryCompanies; + return this; + } + /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder tags(Tags tags) { + public Builder tags(Map tags) { Utils.checkNotNull(tags, "tags"); this.tags = Optional.ofNullable(tags); return this; @@ -740,7 +903,7 @@ public Builder tags(Tags tags) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder tags(Optional tags) { + public Builder tags(Optional> tags) { Utils.checkNotNull(tags, "tags"); this.tags = tags; return this; @@ -755,7 +918,10 @@ public Company build() { id, lastSync, name, + products, redirect, + referenceParentCompany, + referenceSubsidiaryCompanies, tags); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformation.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformation.java new file mode 100644 index 00000000..03a9eca0 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformation.java @@ -0,0 +1,1271 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.openapitools.jackson.nullable.JsonNullable; + +/** + * CompanyInformation - Company info provides standard details about a linked company such as their address, phone number, and company registration. + * + * > **Company information or companies?** + * > + * > Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. + */ + +public class CompanyInformation { + + /** + * Identifier or reference for the company in the accounting software. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("accountingPlatformRef") + private JsonNullable accountingPlatformRef; + + /** + * An array of Addresses. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("addresses") + private JsonNullable> addresses; + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("baseCurrency") + private JsonNullable baseCurrency; + + /** + * Registered legal name of the linked company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("companyLegalName") + private JsonNullable companyLegalName; + + /** + * Name of the linked company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("companyName") + private JsonNullable companyName; + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("createdDate") + private Optional createdDate; + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("financialYearStartDate") + private Optional financialYearStartDate; + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("ledgerLockDate") + private Optional ledgerLockDate; + + /** + * An array of phone numbers. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("phoneNumbers") + private JsonNullable> phoneNumbers; + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("registrationNumber") + private JsonNullable registrationNumber; + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("sourceUrls") + private JsonNullable> sourceUrls; + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("supplementalData") + private Optional supplementalData; + + /** + * Company tax number. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("taxNumber") + private JsonNullable taxNumber; + + /** + * An array of weblinks. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("webLinks") + private JsonNullable> webLinks; + + @JsonCreator + public CompanyInformation( + @JsonProperty("accountingPlatformRef") JsonNullable accountingPlatformRef, + @JsonProperty("addresses") JsonNullable> addresses, + @JsonProperty("baseCurrency") JsonNullable baseCurrency, + @JsonProperty("companyLegalName") JsonNullable companyLegalName, + @JsonProperty("companyName") JsonNullable companyName, + @JsonProperty("createdDate") Optional createdDate, + @JsonProperty("financialYearStartDate") Optional financialYearStartDate, + @JsonProperty("ledgerLockDate") Optional ledgerLockDate, + @JsonProperty("phoneNumbers") JsonNullable> phoneNumbers, + @JsonProperty("registrationNumber") JsonNullable registrationNumber, + @JsonProperty("sourceUrls") JsonNullable> sourceUrls, + @JsonProperty("supplementalData") Optional supplementalData, + @JsonProperty("taxNumber") JsonNullable taxNumber, + @JsonProperty("webLinks") JsonNullable> webLinks) { + Utils.checkNotNull(accountingPlatformRef, "accountingPlatformRef"); + Utils.checkNotNull(addresses, "addresses"); + Utils.checkNotNull(baseCurrency, "baseCurrency"); + Utils.checkNotNull(companyLegalName, "companyLegalName"); + Utils.checkNotNull(companyName, "companyName"); + Utils.checkNotNull(createdDate, "createdDate"); + Utils.checkNotNull(financialYearStartDate, "financialYearStartDate"); + Utils.checkNotNull(ledgerLockDate, "ledgerLockDate"); + Utils.checkNotNull(phoneNumbers, "phoneNumbers"); + Utils.checkNotNull(registrationNumber, "registrationNumber"); + Utils.checkNotNull(sourceUrls, "sourceUrls"); + Utils.checkNotNull(supplementalData, "supplementalData"); + Utils.checkNotNull(taxNumber, "taxNumber"); + Utils.checkNotNull(webLinks, "webLinks"); + this.accountingPlatformRef = accountingPlatformRef; + this.addresses = addresses; + this.baseCurrency = baseCurrency; + this.companyLegalName = companyLegalName; + this.companyName = companyName; + this.createdDate = createdDate; + this.financialYearStartDate = financialYearStartDate; + this.ledgerLockDate = ledgerLockDate; + this.phoneNumbers = phoneNumbers; + this.registrationNumber = registrationNumber; + this.sourceUrls = sourceUrls; + this.supplementalData = supplementalData; + this.taxNumber = taxNumber; + this.webLinks = webLinks; + } + + public CompanyInformation() { + this(JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), Optional.empty(), Optional.empty(), Optional.empty(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), Optional.empty(), JsonNullable.undefined(), JsonNullable.undefined()); + } + + /** + * Identifier or reference for the company in the accounting software. + */ + @JsonIgnore + public JsonNullable accountingPlatformRef() { + return accountingPlatformRef; + } + + /** + * An array of Addresses. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable> addresses() { + return (JsonNullable>) addresses; + } + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + @JsonIgnore + public JsonNullable baseCurrency() { + return baseCurrency; + } + + /** + * Registered legal name of the linked company. + */ + @JsonIgnore + public JsonNullable companyLegalName() { + return companyLegalName; + } + + /** + * Name of the linked company. + */ + @JsonIgnore + public JsonNullable companyName() { + return companyName; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonIgnore + public Optional createdDate() { + return createdDate; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonIgnore + public Optional financialYearStartDate() { + return financialYearStartDate; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonIgnore + public Optional ledgerLockDate() { + return ledgerLockDate; + } + + /** + * An array of phone numbers. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable> phoneNumbers() { + return (JsonNullable>) phoneNumbers; + } + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + @JsonIgnore + public JsonNullable registrationNumber() { + return registrationNumber; + } + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable> sourceUrls() { + return (JsonNullable>) sourceUrls; + } + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional supplementalData() { + return (Optional) supplementalData; + } + + /** + * Company tax number. + */ + @JsonIgnore + public JsonNullable taxNumber() { + return taxNumber; + } + + /** + * An array of weblinks. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable> webLinks() { + return (JsonNullable>) webLinks; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Identifier or reference for the company in the accounting software. + */ + public CompanyInformation withAccountingPlatformRef(String accountingPlatformRef) { + Utils.checkNotNull(accountingPlatformRef, "accountingPlatformRef"); + this.accountingPlatformRef = JsonNullable.of(accountingPlatformRef); + return this; + } + + /** + * Identifier or reference for the company in the accounting software. + */ + public CompanyInformation withAccountingPlatformRef(JsonNullable accountingPlatformRef) { + Utils.checkNotNull(accountingPlatformRef, "accountingPlatformRef"); + this.accountingPlatformRef = accountingPlatformRef; + return this; + } + + /** + * An array of Addresses. + */ + public CompanyInformation withAddresses(List addresses) { + Utils.checkNotNull(addresses, "addresses"); + this.addresses = JsonNullable.of(addresses); + return this; + } + + /** + * An array of Addresses. + */ + public CompanyInformation withAddresses(JsonNullable> addresses) { + Utils.checkNotNull(addresses, "addresses"); + this.addresses = addresses; + return this; + } + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + public CompanyInformation withBaseCurrency(String baseCurrency) { + Utils.checkNotNull(baseCurrency, "baseCurrency"); + this.baseCurrency = JsonNullable.of(baseCurrency); + return this; + } + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + public CompanyInformation withBaseCurrency(JsonNullable baseCurrency) { + Utils.checkNotNull(baseCurrency, "baseCurrency"); + this.baseCurrency = baseCurrency; + return this; + } + + /** + * Registered legal name of the linked company. + */ + public CompanyInformation withCompanyLegalName(String companyLegalName) { + Utils.checkNotNull(companyLegalName, "companyLegalName"); + this.companyLegalName = JsonNullable.of(companyLegalName); + return this; + } + + /** + * Registered legal name of the linked company. + */ + public CompanyInformation withCompanyLegalName(JsonNullable companyLegalName) { + Utils.checkNotNull(companyLegalName, "companyLegalName"); + this.companyLegalName = companyLegalName; + return this; + } + + /** + * Name of the linked company. + */ + public CompanyInformation withCompanyName(String companyName) { + Utils.checkNotNull(companyName, "companyName"); + this.companyName = JsonNullable.of(companyName); + return this; + } + + /** + * Name of the linked company. + */ + public CompanyInformation withCompanyName(JsonNullable companyName) { + Utils.checkNotNull(companyName, "companyName"); + this.companyName = companyName; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withCreatedDate(String createdDate) { + Utils.checkNotNull(createdDate, "createdDate"); + this.createdDate = Optional.ofNullable(createdDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withCreatedDate(Optional createdDate) { + Utils.checkNotNull(createdDate, "createdDate"); + this.createdDate = createdDate; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withFinancialYearStartDate(String financialYearStartDate) { + Utils.checkNotNull(financialYearStartDate, "financialYearStartDate"); + this.financialYearStartDate = Optional.ofNullable(financialYearStartDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withFinancialYearStartDate(Optional financialYearStartDate) { + Utils.checkNotNull(financialYearStartDate, "financialYearStartDate"); + this.financialYearStartDate = financialYearStartDate; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withLedgerLockDate(String ledgerLockDate) { + Utils.checkNotNull(ledgerLockDate, "ledgerLockDate"); + this.ledgerLockDate = Optional.ofNullable(ledgerLockDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public CompanyInformation withLedgerLockDate(Optional ledgerLockDate) { + Utils.checkNotNull(ledgerLockDate, "ledgerLockDate"); + this.ledgerLockDate = ledgerLockDate; + return this; + } + + /** + * An array of phone numbers. + */ + public CompanyInformation withPhoneNumbers(List phoneNumbers) { + Utils.checkNotNull(phoneNumbers, "phoneNumbers"); + this.phoneNumbers = JsonNullable.of(phoneNumbers); + return this; + } + + /** + * An array of phone numbers. + */ + public CompanyInformation withPhoneNumbers(JsonNullable> phoneNumbers) { + Utils.checkNotNull(phoneNumbers, "phoneNumbers"); + this.phoneNumbers = phoneNumbers; + return this; + } + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + public CompanyInformation withRegistrationNumber(String registrationNumber) { + Utils.checkNotNull(registrationNumber, "registrationNumber"); + this.registrationNumber = JsonNullable.of(registrationNumber); + return this; + } + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + public CompanyInformation withRegistrationNumber(JsonNullable registrationNumber) { + Utils.checkNotNull(registrationNumber, "registrationNumber"); + this.registrationNumber = registrationNumber; + return this; + } + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + public CompanyInformation withSourceUrls(Map sourceUrls) { + Utils.checkNotNull(sourceUrls, "sourceUrls"); + this.sourceUrls = JsonNullable.of(sourceUrls); + return this; + } + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + public CompanyInformation withSourceUrls(JsonNullable> sourceUrls) { + Utils.checkNotNull(sourceUrls, "sourceUrls"); + this.sourceUrls = sourceUrls; + return this; + } + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + public CompanyInformation withSupplementalData(SupplementalData supplementalData) { + Utils.checkNotNull(supplementalData, "supplementalData"); + this.supplementalData = Optional.ofNullable(supplementalData); + return this; + } + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + public CompanyInformation withSupplementalData(Optional supplementalData) { + Utils.checkNotNull(supplementalData, "supplementalData"); + this.supplementalData = supplementalData; + return this; + } + + /** + * Company tax number. + */ + public CompanyInformation withTaxNumber(String taxNumber) { + Utils.checkNotNull(taxNumber, "taxNumber"); + this.taxNumber = JsonNullable.of(taxNumber); + return this; + } + + /** + * Company tax number. + */ + public CompanyInformation withTaxNumber(JsonNullable taxNumber) { + Utils.checkNotNull(taxNumber, "taxNumber"); + this.taxNumber = taxNumber; + return this; + } + + /** + * An array of weblinks. + */ + public CompanyInformation withWebLinks(List webLinks) { + Utils.checkNotNull(webLinks, "webLinks"); + this.webLinks = JsonNullable.of(webLinks); + return this; + } + + /** + * An array of weblinks. + */ + public CompanyInformation withWebLinks(JsonNullable> webLinks) { + Utils.checkNotNull(webLinks, "webLinks"); + this.webLinks = webLinks; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompanyInformation other = (CompanyInformation) o; + return + Objects.deepEquals(this.accountingPlatformRef, other.accountingPlatformRef) && + Objects.deepEquals(this.addresses, other.addresses) && + Objects.deepEquals(this.baseCurrency, other.baseCurrency) && + Objects.deepEquals(this.companyLegalName, other.companyLegalName) && + Objects.deepEquals(this.companyName, other.companyName) && + Objects.deepEquals(this.createdDate, other.createdDate) && + Objects.deepEquals(this.financialYearStartDate, other.financialYearStartDate) && + Objects.deepEquals(this.ledgerLockDate, other.ledgerLockDate) && + Objects.deepEquals(this.phoneNumbers, other.phoneNumbers) && + Objects.deepEquals(this.registrationNumber, other.registrationNumber) && + Objects.deepEquals(this.sourceUrls, other.sourceUrls) && + Objects.deepEquals(this.supplementalData, other.supplementalData) && + Objects.deepEquals(this.taxNumber, other.taxNumber) && + Objects.deepEquals(this.webLinks, other.webLinks); + } + + @Override + public int hashCode() { + return Objects.hash( + accountingPlatformRef, + addresses, + baseCurrency, + companyLegalName, + companyName, + createdDate, + financialYearStartDate, + ledgerLockDate, + phoneNumbers, + registrationNumber, + sourceUrls, + supplementalData, + taxNumber, + webLinks); + } + + @Override + public String toString() { + return Utils.toString(CompanyInformation.class, + "accountingPlatformRef", accountingPlatformRef, + "addresses", addresses, + "baseCurrency", baseCurrency, + "companyLegalName", companyLegalName, + "companyName", companyName, + "createdDate", createdDate, + "financialYearStartDate", financialYearStartDate, + "ledgerLockDate", ledgerLockDate, + "phoneNumbers", phoneNumbers, + "registrationNumber", registrationNumber, + "sourceUrls", sourceUrls, + "supplementalData", supplementalData, + "taxNumber", taxNumber, + "webLinks", webLinks); + } + + public final static class Builder { + + private JsonNullable accountingPlatformRef = JsonNullable.undefined(); + + private JsonNullable> addresses = JsonNullable.undefined(); + + private JsonNullable baseCurrency = JsonNullable.undefined(); + + private JsonNullable companyLegalName = JsonNullable.undefined(); + + private JsonNullable companyName = JsonNullable.undefined(); + + private Optional createdDate = Optional.empty(); + + private Optional financialYearStartDate = Optional.empty(); + + private Optional ledgerLockDate = Optional.empty(); + + private JsonNullable> phoneNumbers = JsonNullable.undefined(); + + private JsonNullable registrationNumber = JsonNullable.undefined(); + + private JsonNullable> sourceUrls = JsonNullable.undefined(); + + private Optional supplementalData = Optional.empty(); + + private JsonNullable taxNumber = JsonNullable.undefined(); + + private JsonNullable> webLinks = JsonNullable.undefined(); + + private Builder() { + // force use of static builder() method + } + + /** + * Identifier or reference for the company in the accounting software. + */ + public Builder accountingPlatformRef(String accountingPlatformRef) { + Utils.checkNotNull(accountingPlatformRef, "accountingPlatformRef"); + this.accountingPlatformRef = JsonNullable.of(accountingPlatformRef); + return this; + } + + /** + * Identifier or reference for the company in the accounting software. + */ + public Builder accountingPlatformRef(JsonNullable accountingPlatformRef) { + Utils.checkNotNull(accountingPlatformRef, "accountingPlatformRef"); + this.accountingPlatformRef = accountingPlatformRef; + return this; + } + + /** + * An array of Addresses. + */ + public Builder addresses(List addresses) { + Utils.checkNotNull(addresses, "addresses"); + this.addresses = JsonNullable.of(addresses); + return this; + } + + /** + * An array of Addresses. + */ + public Builder addresses(JsonNullable> addresses) { + Utils.checkNotNull(addresses, "addresses"); + this.addresses = addresses; + return this; + } + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + public Builder baseCurrency(String baseCurrency) { + Utils.checkNotNull(baseCurrency, "baseCurrency"); + this.baseCurrency = JsonNullable.of(baseCurrency); + return this; + } + + /** + * Currency set in the accounting software of the linked company. Used by the currency rate. + */ + public Builder baseCurrency(JsonNullable baseCurrency) { + Utils.checkNotNull(baseCurrency, "baseCurrency"); + this.baseCurrency = baseCurrency; + return this; + } + + /** + * Registered legal name of the linked company. + */ + public Builder companyLegalName(String companyLegalName) { + Utils.checkNotNull(companyLegalName, "companyLegalName"); + this.companyLegalName = JsonNullable.of(companyLegalName); + return this; + } + + /** + * Registered legal name of the linked company. + */ + public Builder companyLegalName(JsonNullable companyLegalName) { + Utils.checkNotNull(companyLegalName, "companyLegalName"); + this.companyLegalName = companyLegalName; + return this; + } + + /** + * Name of the linked company. + */ + public Builder companyName(String companyName) { + Utils.checkNotNull(companyName, "companyName"); + this.companyName = JsonNullable.of(companyName); + return this; + } + + /** + * Name of the linked company. + */ + public Builder companyName(JsonNullable companyName) { + Utils.checkNotNull(companyName, "companyName"); + this.companyName = companyName; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder createdDate(String createdDate) { + Utils.checkNotNull(createdDate, "createdDate"); + this.createdDate = Optional.ofNullable(createdDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder createdDate(Optional createdDate) { + Utils.checkNotNull(createdDate, "createdDate"); + this.createdDate = createdDate; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder financialYearStartDate(String financialYearStartDate) { + Utils.checkNotNull(financialYearStartDate, "financialYearStartDate"); + this.financialYearStartDate = Optional.ofNullable(financialYearStartDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder financialYearStartDate(Optional financialYearStartDate) { + Utils.checkNotNull(financialYearStartDate, "financialYearStartDate"); + this.financialYearStartDate = financialYearStartDate; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder ledgerLockDate(String ledgerLockDate) { + Utils.checkNotNull(ledgerLockDate, "ledgerLockDate"); + this.ledgerLockDate = Optional.ofNullable(ledgerLockDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder ledgerLockDate(Optional ledgerLockDate) { + Utils.checkNotNull(ledgerLockDate, "ledgerLockDate"); + this.ledgerLockDate = ledgerLockDate; + return this; + } + + /** + * An array of phone numbers. + */ + public Builder phoneNumbers(List phoneNumbers) { + Utils.checkNotNull(phoneNumbers, "phoneNumbers"); + this.phoneNumbers = JsonNullable.of(phoneNumbers); + return this; + } + + /** + * An array of phone numbers. + */ + public Builder phoneNumbers(JsonNullable> phoneNumbers) { + Utils.checkNotNull(phoneNumbers, "phoneNumbers"); + this.phoneNumbers = phoneNumbers; + return this; + } + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + public Builder registrationNumber(String registrationNumber) { + Utils.checkNotNull(registrationNumber, "registrationNumber"); + this.registrationNumber = JsonNullable.of(registrationNumber); + return this; + } + + /** + * Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + */ + public Builder registrationNumber(JsonNullable registrationNumber) { + Utils.checkNotNull(registrationNumber, "registrationNumber"); + this.registrationNumber = registrationNumber; + return this; + } + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + public Builder sourceUrls(Map sourceUrls) { + Utils.checkNotNull(sourceUrls, "sourceUrls"); + this.sourceUrls = JsonNullable.of(sourceUrls); + return this; + } + + /** + * URL addresses for the accounting source. + * + * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + */ + public Builder sourceUrls(JsonNullable> sourceUrls) { + Utils.checkNotNull(sourceUrls, "sourceUrls"); + this.sourceUrls = sourceUrls; + return this; + } + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + public Builder supplementalData(SupplementalData supplementalData) { + Utils.checkNotNull(supplementalData, "supplementalData"); + this.supplementalData = Optional.ofNullable(supplementalData); + return this; + } + + /** + * Supplemental data is additional data you can include in our standard data types. + * + * It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + */ + public Builder supplementalData(Optional supplementalData) { + Utils.checkNotNull(supplementalData, "supplementalData"); + this.supplementalData = supplementalData; + return this; + } + + /** + * Company tax number. + */ + public Builder taxNumber(String taxNumber) { + Utils.checkNotNull(taxNumber, "taxNumber"); + this.taxNumber = JsonNullable.of(taxNumber); + return this; + } + + /** + * Company tax number. + */ + public Builder taxNumber(JsonNullable taxNumber) { + Utils.checkNotNull(taxNumber, "taxNumber"); + this.taxNumber = taxNumber; + return this; + } + + /** + * An array of weblinks. + */ + public Builder webLinks(List webLinks) { + Utils.checkNotNull(webLinks, "webLinks"); + this.webLinks = JsonNullable.of(webLinks); + return this; + } + + /** + * An array of weblinks. + */ + public Builder webLinks(JsonNullable> webLinks) { + Utils.checkNotNull(webLinks, "webLinks"); + this.webLinks = webLinks; + return this; + } + + public CompanyInformation build() { + return new CompanyInformation( + accountingPlatformRef, + addresses, + baseCurrency, + companyLegalName, + companyName, + createdDate, + financialYearStartDate, + ledgerLockDate, + phoneNumbers, + registrationNumber, + sourceUrls, + supplementalData, + taxNumber, + webLinks); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformationType.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformationType.java new file mode 100644 index 00000000..f99b79a4 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyInformationType.java @@ -0,0 +1,28 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + +import com.fasterxml.jackson.annotation.JsonValue; +import java.lang.String; + +/** + * CompanyInformationType - The type of the weblink. + */ +public enum CompanyInformationType { + WEBSITE("Website"), + SOCIAL("Social"), + UNKNOWN("Unknown"); + + @JsonValue + private final String value; + + private CompanyInformationType(String value) { + this.value = value; + } + + public String value() { + return value; + } +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReference.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReference.java new file mode 100644 index 00000000..2edbaede --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReference.java @@ -0,0 +1,371 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + + +public class CompanyReference { + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("description") + private Optional description; + + /** + * Unique identifier for your SMB in Codat. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("id") + private Optional id; + + /** + * A collection of links for the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("links") + private Optional links; + + /** + * The name of the company + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("name") + private Optional name; + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("tags") + private Optional> tags; + + @JsonCreator + public CompanyReference( + @JsonProperty("description") Optional description, + @JsonProperty("id") Optional id, + @JsonProperty("links") Optional links, + @JsonProperty("name") Optional name, + @JsonProperty("tags") Optional> tags) { + Utils.checkNotNull(description, "description"); + Utils.checkNotNull(id, "id"); + Utils.checkNotNull(links, "links"); + Utils.checkNotNull(name, "name"); + Utils.checkNotNull(tags, "tags"); + this.description = description; + this.id = id; + this.links = links; + this.name = name; + this.tags = tags; + } + + public CompanyReference() { + this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty()); + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + @JsonIgnore + public Optional description() { + return description; + } + + /** + * Unique identifier for your SMB in Codat. + */ + @JsonIgnore + public Optional id() { + return id; + } + + /** + * A collection of links for the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional links() { + return (Optional) links; + } + + /** + * The name of the company + */ + @JsonIgnore + public Optional name() { + return name; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> tags() { + return (Optional>) tags; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public CompanyReference withDescription(String description) { + Utils.checkNotNull(description, "description"); + this.description = Optional.ofNullable(description); + return this; + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public CompanyReference withDescription(Optional description) { + Utils.checkNotNull(description, "description"); + this.description = description; + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public CompanyReference withId(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public CompanyReference withId(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + /** + * A collection of links for the company. + */ + public CompanyReference withLinks(CompanyReferenceLinks links) { + Utils.checkNotNull(links, "links"); + this.links = Optional.ofNullable(links); + return this; + } + + /** + * A collection of links for the company. + */ + public CompanyReference withLinks(Optional links) { + Utils.checkNotNull(links, "links"); + this.links = links; + return this; + } + + /** + * The name of the company + */ + public CompanyReference withName(String name) { + Utils.checkNotNull(name, "name"); + this.name = Optional.ofNullable(name); + return this; + } + + /** + * The name of the company + */ + public CompanyReference withName(Optional name) { + Utils.checkNotNull(name, "name"); + this.name = name; + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public CompanyReference withTags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public CompanyReference withTags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompanyReference other = (CompanyReference) o; + return + Objects.deepEquals(this.description, other.description) && + Objects.deepEquals(this.id, other.id) && + Objects.deepEquals(this.links, other.links) && + Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.tags, other.tags); + } + + @Override + public int hashCode() { + return Objects.hash( + description, + id, + links, + name, + tags); + } + + @Override + public String toString() { + return Utils.toString(CompanyReference.class, + "description", description, + "id", id, + "links", links, + "name", name, + "tags", tags); + } + + public final static class Builder { + + private Optional description = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional links = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional> tags = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public Builder description(String description) { + Utils.checkNotNull(description, "description"); + this.description = Optional.ofNullable(description); + return this; + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public Builder description(Optional description) { + Utils.checkNotNull(description, "description"); + this.description = description; + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public Builder id(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public Builder id(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + /** + * A collection of links for the company. + */ + public Builder links(CompanyReferenceLinks links) { + Utils.checkNotNull(links, "links"); + this.links = Optional.ofNullable(links); + return this; + } + + /** + * A collection of links for the company. + */ + public Builder links(Optional links) { + Utils.checkNotNull(links, "links"); + this.links = links; + return this; + } + + /** + * The name of the company + */ + public Builder name(String name) { + Utils.checkNotNull(name, "name"); + this.name = Optional.ofNullable(name); + return this; + } + + /** + * The name of the company + */ + public Builder name(Optional name) { + Utils.checkNotNull(name, "name"); + this.name = name; + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public Builder tags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public Builder tags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; + return this; + } + + public CompanyReference build() { + return new CompanyReference( + description, + id, + links, + name, + tags); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReferenceLinks.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReferenceLinks.java new file mode 100644 index 00000000..cc3eb81e --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyReferenceLinks.java @@ -0,0 +1,130 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.util.Objects; +import java.util.Optional; + +/** + * CompanyReferenceLinks - A collection of links for the company. + */ + +public class CompanyReferenceLinks { + + /** + * Link to the company page in the portal. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("portal") + private Optional portal; + + @JsonCreator + public CompanyReferenceLinks( + @JsonProperty("portal") Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + } + + public CompanyReferenceLinks() { + this(Optional.empty()); + } + + /** + * Link to the company page in the portal. + */ + @JsonIgnore + public Optional portal() { + return portal; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Link to the company page in the portal. + */ + public CompanyReferenceLinks withPortal(String portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = Optional.ofNullable(portal); + return this; + } + + /** + * Link to the company page in the portal. + */ + public CompanyReferenceLinks withPortal(Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompanyReferenceLinks other = (CompanyReferenceLinks) o; + return + Objects.deepEquals(this.portal, other.portal); + } + + @Override + public int hashCode() { + return Objects.hash( + portal); + } + + @Override + public String toString() { + return Utils.toString(CompanyReferenceLinks.class, + "portal", portal); + } + + public final static class Builder { + + private Optional portal = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * Link to the company page in the portal. + */ + public Builder portal(String portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = Optional.ofNullable(portal); + return this; + } + + /** + * Link to the company page in the portal. + */ + public Builder portal(Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + return this; + } + + public CompanyReferenceLinks build() { + return new CompanyReferenceLinks( + portal); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyRequestBody.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyRequestBody.java index 5919a8eb..d37e0fad 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyRequestBody.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CompanyRequestBody.java @@ -14,7 +14,7 @@ import java.lang.Override; import java.lang.String; import java.lang.SuppressWarnings; -import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Optional; @@ -28,35 +28,35 @@ public class CompanyRequestBody { @JsonProperty("description") private Optional description; - /** - * Reference to the groups that the company is assigned to. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("groups") - private Optional> groups; - /** * Name of company being connected. */ @JsonProperty("name") private String name; + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("tags") + private Optional> tags; + @JsonCreator public CompanyRequestBody( @JsonProperty("description") Optional description, - @JsonProperty("groups") Optional> groups, - @JsonProperty("name") String name) { + @JsonProperty("name") String name, + @JsonProperty("tags") Optional> tags) { Utils.checkNotNull(description, "description"); - Utils.checkNotNull(groups, "groups"); Utils.checkNotNull(name, "name"); + Utils.checkNotNull(tags, "tags"); this.description = description; - this.groups = groups; this.name = name; + this.tags = tags; } public CompanyRequestBody( String name) { - this(Optional.empty(), Optional.empty(), name); + this(Optional.empty(), name, Optional.empty()); } /** @@ -68,20 +68,20 @@ public Optional description() { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - @SuppressWarnings("unchecked") @JsonIgnore - public Optional> groups() { - return (Optional>) groups; + public String name() { + return name; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ + @SuppressWarnings("unchecked") @JsonIgnore - public String name() { - return name; + public Optional> tags() { + return (Optional>) tags; } public final static Builder builder() { @@ -107,29 +107,29 @@ public CompanyRequestBody withDescription(Optional description) { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - public CompanyRequestBody withGroups(List groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = Optional.ofNullable(groups); + public CompanyRequestBody withName(String name) { + Utils.checkNotNull(name, "name"); + this.name = name; return this; } /** - * Reference to the groups that the company is assigned to. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public CompanyRequestBody withGroups(Optional> groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = groups; + public CompanyRequestBody withTags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); return this; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public CompanyRequestBody withName(String name) { - Utils.checkNotNull(name, "name"); - this.name = name; + public CompanyRequestBody withTags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; return this; } @@ -144,33 +144,33 @@ public boolean equals(java.lang.Object o) { CompanyRequestBody other = (CompanyRequestBody) o; return Objects.deepEquals(this.description, other.description) && - Objects.deepEquals(this.groups, other.groups) && - Objects.deepEquals(this.name, other.name); + Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.tags, other.tags); } @Override public int hashCode() { return Objects.hash( description, - groups, - name); + name, + tags); } @Override public String toString() { return Utils.toString(CompanyRequestBody.class, "description", description, - "groups", groups, - "name", name); + "name", name, + "tags", tags); } public final static class Builder { private Optional description = Optional.empty(); - private Optional> groups = Optional.empty(); + private String name; - private String name; + private Optional> tags = Optional.empty(); private Builder() { // force use of static builder() method @@ -195,37 +195,37 @@ public Builder description(Optional description) { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - public Builder groups(List groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = Optional.ofNullable(groups); + public Builder name(String name) { + Utils.checkNotNull(name, "name"); + this.name = name; return this; } /** - * Reference to the groups that the company is assigned to. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder groups(Optional> groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = groups; + public Builder tags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); return this; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder name(String name) { - Utils.checkNotNull(name, "name"); - this.name = name; + public Builder tags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; return this; } public CompanyRequestBody build() { return new CompanyRequestBody( description, - groups, - name); + name, + tags); } } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Connection.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Connection.java index 40ba9d60..6c79eacc 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Connection.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Connection.java @@ -11,7 +11,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import io.codat.sync.expenses.utils.Utils; -import java.lang.Object; import java.lang.Override; import java.lang.String; import java.lang.SuppressWarnings; @@ -19,6 +18,7 @@ import java.util.Map; import java.util.Objects; import java.util.Optional; +import org.openapitools.jackson.nullable.JsonNullable; /** * Connection - A connection represents a [company's](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. @@ -35,13 +35,9 @@ public class Connection { - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("additionalProperties") - private Optional additionalProperties; - @JsonInclude(Include.NON_ABSENT) @JsonProperty("connectionInfo") - private Optional> connectionInfo; + private JsonNullable> connectionInfo; /** * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: @@ -69,7 +65,7 @@ public class Connection { @JsonInclude(Include.NON_ABSENT) @JsonProperty("dataConnectionErrors") - private Optional> dataConnectionErrors; + private JsonNullable> dataConnectionErrors; /** * Unique identifier for a company's data connection. @@ -146,10 +142,9 @@ public class Connection { @JsonCreator public Connection( - @JsonProperty("additionalProperties") Optional additionalProperties, - @JsonProperty("connectionInfo") Optional> connectionInfo, + @JsonProperty("connectionInfo") JsonNullable> connectionInfo, @JsonProperty("created") String created, - @JsonProperty("dataConnectionErrors") Optional> dataConnectionErrors, + @JsonProperty("dataConnectionErrors") JsonNullable> dataConnectionErrors, @JsonProperty("id") String id, @JsonProperty("integrationId") String integrationId, @JsonProperty("integrationKey") String integrationKey, @@ -159,7 +154,6 @@ public Connection( @JsonProperty("sourceId") String sourceId, @JsonProperty("sourceType") SourceType sourceType, @JsonProperty("status") DataConnectionStatus status) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); Utils.checkNotNull(connectionInfo, "connectionInfo"); Utils.checkNotNull(created, "created"); Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); @@ -172,7 +166,6 @@ public Connection( Utils.checkNotNull(sourceId, "sourceId"); Utils.checkNotNull(sourceType, "sourceType"); Utils.checkNotNull(status, "status"); - this.additionalProperties = additionalProperties; this.connectionInfo = connectionInfo; this.created = created; this.dataConnectionErrors = dataConnectionErrors; @@ -197,19 +190,13 @@ public Connection( String sourceId, SourceType sourceType, DataConnectionStatus status) { - this(Optional.empty(), Optional.empty(), created, Optional.empty(), id, integrationId, integrationKey, Optional.empty(), linkUrl, platformName, sourceId, sourceType, status); - } - - @SuppressWarnings("unchecked") - @JsonIgnore - public Optional additionalProperties() { - return (Optional) additionalProperties; + this(JsonNullable.undefined(), created, JsonNullable.undefined(), id, integrationId, integrationKey, Optional.empty(), linkUrl, platformName, sourceId, sourceType, status); } @SuppressWarnings("unchecked") @JsonIgnore - public Optional> connectionInfo() { - return (Optional>) connectionInfo; + public JsonNullable> connectionInfo() { + return (JsonNullable>) connectionInfo; } /** @@ -240,8 +227,8 @@ public String created() { @SuppressWarnings("unchecked") @JsonIgnore - public Optional> dataConnectionErrors() { - return (Optional>) dataConnectionErrors; + public JsonNullable> dataConnectionErrors() { + return (JsonNullable>) dataConnectionErrors; } /** @@ -338,25 +325,13 @@ public final static Builder builder() { return new Builder(); } - public Connection withAdditionalProperties(Object additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = Optional.ofNullable(additionalProperties); - return this; - } - - public Connection withAdditionalProperties(Optional additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = additionalProperties; - return this; - } - public Connection withConnectionInfo(Map connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); - this.connectionInfo = Optional.ofNullable(connectionInfo); + this.connectionInfo = JsonNullable.of(connectionInfo); return this; } - public Connection withConnectionInfo(Optional> connectionInfo) { + public Connection withConnectionInfo(JsonNullable> connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); this.connectionInfo = connectionInfo; return this; @@ -391,11 +366,11 @@ public Connection withCreated(String created) { public Connection withDataConnectionErrors(List dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); - this.dataConnectionErrors = Optional.ofNullable(dataConnectionErrors); + this.dataConnectionErrors = JsonNullable.of(dataConnectionErrors); return this; } - public Connection withDataConnectionErrors(Optional> dataConnectionErrors) { + public Connection withDataConnectionErrors(JsonNullable> dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); this.dataConnectionErrors = dataConnectionErrors; return this; @@ -537,7 +512,6 @@ public boolean equals(java.lang.Object o) { } Connection other = (Connection) o; return - Objects.deepEquals(this.additionalProperties, other.additionalProperties) && Objects.deepEquals(this.connectionInfo, other.connectionInfo) && Objects.deepEquals(this.created, other.created) && Objects.deepEquals(this.dataConnectionErrors, other.dataConnectionErrors) && @@ -555,7 +529,6 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { return Objects.hash( - additionalProperties, connectionInfo, created, dataConnectionErrors, @@ -573,7 +546,6 @@ public int hashCode() { @Override public String toString() { return Utils.toString(Connection.class, - "additionalProperties", additionalProperties, "connectionInfo", connectionInfo, "created", created, "dataConnectionErrors", dataConnectionErrors, @@ -590,13 +562,11 @@ public String toString() { public final static class Builder { - private Optional additionalProperties = Optional.empty(); - - private Optional> connectionInfo = Optional.empty(); + private JsonNullable> connectionInfo = JsonNullable.undefined(); private String created; - private Optional> dataConnectionErrors = Optional.empty(); + private JsonNullable> dataConnectionErrors = JsonNullable.undefined(); private String id; @@ -620,25 +590,13 @@ private Builder() { // force use of static builder() method } - public Builder additionalProperties(Object additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = Optional.ofNullable(additionalProperties); - return this; - } - - public Builder additionalProperties(Optional additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = additionalProperties; - return this; - } - public Builder connectionInfo(Map connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); - this.connectionInfo = Optional.ofNullable(connectionInfo); + this.connectionInfo = JsonNullable.of(connectionInfo); return this; } - public Builder connectionInfo(Optional> connectionInfo) { + public Builder connectionInfo(JsonNullable> connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); this.connectionInfo = connectionInfo; return this; @@ -673,11 +631,11 @@ public Builder created(String created) { public Builder dataConnectionErrors(List dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); - this.dataConnectionErrors = Optional.ofNullable(dataConnectionErrors); + this.dataConnectionErrors = JsonNullable.of(dataConnectionErrors); return this; } - public Builder dataConnectionErrors(Optional> dataConnectionErrors) { + public Builder dataConnectionErrors(JsonNullable> dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); this.dataConnectionErrors = dataConnectionErrors; return this; @@ -811,7 +769,6 @@ public Builder status(DataConnectionStatus status) { public Connection build() { return new Connection( - additionalProperties, connectionInfo, created, dataConnectionErrors, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Contact.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Contact.java index 5847f617..7b2d4226 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Contact.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Contact.java @@ -70,7 +70,7 @@ public class Contact { */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("phone") - private JsonNullable> phone; + private JsonNullable> phone; /** * Status of customer. @@ -84,7 +84,7 @@ public Contact( @JsonProperty("email") JsonNullable email, @JsonProperty("modifiedDate") Optional modifiedDate, @JsonProperty("name") JsonNullable name, - @JsonProperty("phone") JsonNullable> phone, + @JsonProperty("phone") JsonNullable> phone, @JsonProperty("status") CustomerStatus status) { Utils.checkNotNull(address, "address"); Utils.checkNotNull(email, "email"); @@ -158,8 +158,8 @@ public JsonNullable name() { */ @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable> phone() { - return (JsonNullable>) phone; + public JsonNullable> phone() { + return (JsonNullable>) phone; } /** @@ -279,7 +279,7 @@ public Contact withName(JsonNullable name) { /** * An array of Phone numbers. */ - public Contact withPhone(List phone) { + public Contact withPhone(List phone) { Utils.checkNotNull(phone, "phone"); this.phone = JsonNullable.of(phone); return this; @@ -288,7 +288,7 @@ public Contact withPhone(List phone) { /** * An array of Phone numbers. */ - public Contact withPhone(JsonNullable> phone) { + public Contact withPhone(JsonNullable> phone) { Utils.checkNotNull(phone, "phone"); this.phone = phone; return this; @@ -353,7 +353,7 @@ public final static class Builder { private JsonNullable name = JsonNullable.undefined(); - private JsonNullable> phone = JsonNullable.undefined(); + private JsonNullable> phone = JsonNullable.undefined(); private CustomerStatus status; @@ -466,7 +466,7 @@ public Builder name(JsonNullable name) { /** * An array of Phone numbers. */ - public Builder phone(List phone) { + public Builder phone(List phone) { Utils.checkNotNull(phone, "phone"); this.phone = JsonNullable.of(phone); return this; @@ -475,7 +475,7 @@ public Builder phone(List phone) { /** * An array of Phone numbers. */ - public Builder phone(JsonNullable> phone) { + public Builder phone(JsonNullable> phone) { Utils.checkNotNull(phone, "phone"); this.phone = phone; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponseAccountingAddress.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponseAccountingAddress.java deleted file mode 100644 index 7569c021..00000000 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/CreateCustomerResponseAccountingAddress.java +++ /dev/null @@ -1,469 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -package io.codat.sync.expenses.models.components; - - -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonInclude.Include; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import io.codat.sync.expenses.utils.Utils; -import java.lang.Override; -import java.lang.String; -import java.util.Objects; -import org.openapitools.jackson.nullable.JsonNullable; - - -public class CreateCustomerResponseAccountingAddress { - - /** - * City of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("city") - private JsonNullable city; - - /** - * Country of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("country") - private JsonNullable country; - - /** - * Line 1 of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("line1") - private JsonNullable line1; - - /** - * Line 2 of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("line2") - private JsonNullable line2; - - /** - * Postal code or zip code. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("postalCode") - private JsonNullable postalCode; - - /** - * Region of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("region") - private JsonNullable region; - - /** - * The type of the address - */ - @JsonProperty("type") - private AccountingAddressType type; - - @JsonCreator - public CreateCustomerResponseAccountingAddress( - @JsonProperty("city") JsonNullable city, - @JsonProperty("country") JsonNullable country, - @JsonProperty("line1") JsonNullable line1, - @JsonProperty("line2") JsonNullable line2, - @JsonProperty("postalCode") JsonNullable postalCode, - @JsonProperty("region") JsonNullable region, - @JsonProperty("type") AccountingAddressType type) { - Utils.checkNotNull(city, "city"); - Utils.checkNotNull(country, "country"); - Utils.checkNotNull(line1, "line1"); - Utils.checkNotNull(line2, "line2"); - Utils.checkNotNull(postalCode, "postalCode"); - Utils.checkNotNull(region, "region"); - Utils.checkNotNull(type, "type"); - this.city = city; - this.country = country; - this.line1 = line1; - this.line2 = line2; - this.postalCode = postalCode; - this.region = region; - this.type = type; - } - - public CreateCustomerResponseAccountingAddress( - AccountingAddressType type) { - this(JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), type); - } - - /** - * City of the customer address. - */ - @JsonIgnore - public JsonNullable city() { - return city; - } - - /** - * Country of the customer address. - */ - @JsonIgnore - public JsonNullable country() { - return country; - } - - /** - * Line 1 of the customer address. - */ - @JsonIgnore - public JsonNullable line1() { - return line1; - } - - /** - * Line 2 of the customer address. - */ - @JsonIgnore - public JsonNullable line2() { - return line2; - } - - /** - * Postal code or zip code. - */ - @JsonIgnore - public JsonNullable postalCode() { - return postalCode; - } - - /** - * Region of the customer address. - */ - @JsonIgnore - public JsonNullable region() { - return region; - } - - /** - * The type of the address - */ - @JsonIgnore - public AccountingAddressType type() { - return type; - } - - public final static Builder builder() { - return new Builder(); - } - - /** - * City of the customer address. - */ - public CreateCustomerResponseAccountingAddress withCity(String city) { - Utils.checkNotNull(city, "city"); - this.city = JsonNullable.of(city); - return this; - } - - /** - * City of the customer address. - */ - public CreateCustomerResponseAccountingAddress withCity(JsonNullable city) { - Utils.checkNotNull(city, "city"); - this.city = city; - return this; - } - - /** - * Country of the customer address. - */ - public CreateCustomerResponseAccountingAddress withCountry(String country) { - Utils.checkNotNull(country, "country"); - this.country = JsonNullable.of(country); - return this; - } - - /** - * Country of the customer address. - */ - public CreateCustomerResponseAccountingAddress withCountry(JsonNullable country) { - Utils.checkNotNull(country, "country"); - this.country = country; - return this; - } - - /** - * Line 1 of the customer address. - */ - public CreateCustomerResponseAccountingAddress withLine1(String line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = JsonNullable.of(line1); - return this; - } - - /** - * Line 1 of the customer address. - */ - public CreateCustomerResponseAccountingAddress withLine1(JsonNullable line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = line1; - return this; - } - - /** - * Line 2 of the customer address. - */ - public CreateCustomerResponseAccountingAddress withLine2(String line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = JsonNullable.of(line2); - return this; - } - - /** - * Line 2 of the customer address. - */ - public CreateCustomerResponseAccountingAddress withLine2(JsonNullable line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = line2; - return this; - } - - /** - * Postal code or zip code. - */ - public CreateCustomerResponseAccountingAddress withPostalCode(String postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = JsonNullable.of(postalCode); - return this; - } - - /** - * Postal code or zip code. - */ - public CreateCustomerResponseAccountingAddress withPostalCode(JsonNullable postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = postalCode; - return this; - } - - /** - * Region of the customer address. - */ - public CreateCustomerResponseAccountingAddress withRegion(String region) { - Utils.checkNotNull(region, "region"); - this.region = JsonNullable.of(region); - return this; - } - - /** - * Region of the customer address. - */ - public CreateCustomerResponseAccountingAddress withRegion(JsonNullable region) { - Utils.checkNotNull(region, "region"); - this.region = region; - return this; - } - - /** - * The type of the address - */ - public CreateCustomerResponseAccountingAddress withType(AccountingAddressType type) { - Utils.checkNotNull(type, "type"); - this.type = type; - return this; - } - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CreateCustomerResponseAccountingAddress other = (CreateCustomerResponseAccountingAddress) o; - return - Objects.deepEquals(this.city, other.city) && - Objects.deepEquals(this.country, other.country) && - Objects.deepEquals(this.line1, other.line1) && - Objects.deepEquals(this.line2, other.line2) && - Objects.deepEquals(this.postalCode, other.postalCode) && - Objects.deepEquals(this.region, other.region) && - Objects.deepEquals(this.type, other.type); - } - - @Override - public int hashCode() { - return Objects.hash( - city, - country, - line1, - line2, - postalCode, - region, - type); - } - - @Override - public String toString() { - return Utils.toString(CreateCustomerResponseAccountingAddress.class, - "city", city, - "country", country, - "line1", line1, - "line2", line2, - "postalCode", postalCode, - "region", region, - "type", type); - } - - public final static class Builder { - - private JsonNullable city = JsonNullable.undefined(); - - private JsonNullable country = JsonNullable.undefined(); - - private JsonNullable line1 = JsonNullable.undefined(); - - private JsonNullable line2 = JsonNullable.undefined(); - - private JsonNullable postalCode = JsonNullable.undefined(); - - private JsonNullable region = JsonNullable.undefined(); - - private AccountingAddressType type; - - private Builder() { - // force use of static builder() method - } - - /** - * City of the customer address. - */ - public Builder city(String city) { - Utils.checkNotNull(city, "city"); - this.city = JsonNullable.of(city); - return this; - } - - /** - * City of the customer address. - */ - public Builder city(JsonNullable city) { - Utils.checkNotNull(city, "city"); - this.city = city; - return this; - } - - /** - * Country of the customer address. - */ - public Builder country(String country) { - Utils.checkNotNull(country, "country"); - this.country = JsonNullable.of(country); - return this; - } - - /** - * Country of the customer address. - */ - public Builder country(JsonNullable country) { - Utils.checkNotNull(country, "country"); - this.country = country; - return this; - } - - /** - * Line 1 of the customer address. - */ - public Builder line1(String line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = JsonNullable.of(line1); - return this; - } - - /** - * Line 1 of the customer address. - */ - public Builder line1(JsonNullable line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = line1; - return this; - } - - /** - * Line 2 of the customer address. - */ - public Builder line2(String line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = JsonNullable.of(line2); - return this; - } - - /** - * Line 2 of the customer address. - */ - public Builder line2(JsonNullable line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = line2; - return this; - } - - /** - * Postal code or zip code. - */ - public Builder postalCode(String postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = JsonNullable.of(postalCode); - return this; - } - - /** - * Postal code or zip code. - */ - public Builder postalCode(JsonNullable postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = postalCode; - return this; - } - - /** - * Region of the customer address. - */ - public Builder region(String region) { - Utils.checkNotNull(region, "region"); - this.region = JsonNullable.of(region); - return this; - } - - /** - * Region of the customer address. - */ - public Builder region(JsonNullable region) { - Utils.checkNotNull(region, "region"); - this.region = region; - return this; - } - - /** - * The type of the address - */ - public Builder type(AccountingAddressType type) { - Utils.checkNotNull(type, "type"); - this.type = type; - return this; - } - - public CreateCustomerResponseAccountingAddress build() { - return new CreateCustomerResponseAccountingAddress( - city, - country, - line1, - line2, - postalCode, - region, - type); - } - } -} - diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Customer.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Customer.java index 2e853a36..d6589e6a 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Customer.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Customer.java @@ -20,9 +20,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * Customer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * Customer - ## Overview * * A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). * @@ -37,7 +35,7 @@ public class Customer { */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("addresses") - private JsonNullable> addresses; + private JsonNullable> addresses; /** * Name of the main contact for the identified customer. @@ -137,7 +135,7 @@ public class Customer { @JsonCreator public Customer( - @JsonProperty("addresses") JsonNullable> addresses, + @JsonProperty("addresses") JsonNullable> addresses, @JsonProperty("contactName") JsonNullable contactName, @JsonProperty("contacts") JsonNullable> contacts, @JsonProperty("customerName") JsonNullable customerName, @@ -194,8 +192,8 @@ public Customer( */ @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable> addresses() { - return (JsonNullable>) addresses; + public JsonNullable> addresses() { + return (JsonNullable>) addresses; } /** @@ -319,7 +317,7 @@ public final static Builder builder() { /** * An array of Addresses. */ - public Customer withAddresses(List addresses) { + public Customer withAddresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -328,7 +326,7 @@ public Customer withAddresses(List addresses) { /** * An array of Addresses. */ - public Customer withAddresses(JsonNullable> addresses) { + public Customer withAddresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; @@ -644,7 +642,7 @@ public String toString() { public final static class Builder { - private JsonNullable> addresses = JsonNullable.undefined(); + private JsonNullable> addresses = JsonNullable.undefined(); private JsonNullable contactName = JsonNullable.undefined(); @@ -681,7 +679,7 @@ private Builder() { /** * An array of Addresses. */ - public Builder addresses(List addresses) { + public Builder addresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -690,7 +688,7 @@ public Builder addresses(List addresses) { /** * An array of Addresses. */ - public Builder addresses(JsonNullable> addresses) { + public Builder addresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpenseTransaction.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpenseTransaction.java index cd6a3950..f25d1834 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpenseTransaction.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpenseTransaction.java @@ -134,6 +134,13 @@ public class ExpenseTransaction { @JsonProperty("postAsDraft") private JsonNullable postAsDraft; + /** + * User-friendly reference for the expense transaction. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("reference") + private JsonNullable reference; + /** * The type of transaction. */ @@ -152,6 +159,7 @@ public ExpenseTransaction( @JsonProperty("merchantName") Optional merchantName, @JsonProperty("notes") Optional notes, @JsonProperty("postAsDraft") JsonNullable postAsDraft, + @JsonProperty("reference") JsonNullable reference, @JsonProperty("type") ExpenseTransactionType type) { Utils.checkNotNull(bankAccountRef, "bankAccountRef"); Utils.checkNotNull(contactRef, "contactRef"); @@ -163,6 +171,7 @@ public ExpenseTransaction( Utils.checkNotNull(merchantName, "merchantName"); Utils.checkNotNull(notes, "notes"); Utils.checkNotNull(postAsDraft, "postAsDraft"); + Utils.checkNotNull(reference, "reference"); Utils.checkNotNull(type, "type"); this.bankAccountRef = bankAccountRef; this.contactRef = contactRef; @@ -174,6 +183,7 @@ public ExpenseTransaction( this.merchantName = merchantName; this.notes = notes; this.postAsDraft = postAsDraft; + this.reference = reference; this.type = type; } @@ -182,7 +192,7 @@ public ExpenseTransaction( String id, String issueDate, ExpenseTransactionType type) { - this(Optional.empty(), Optional.empty(), currency, JsonNullable.undefined(), id, issueDate, Optional.empty(), Optional.empty(), Optional.empty(), JsonNullable.undefined(), type); + this(Optional.empty(), Optional.empty(), currency, JsonNullable.undefined(), id, issueDate, Optional.empty(), Optional.empty(), Optional.empty(), JsonNullable.undefined(), JsonNullable.undefined(), type); } @SuppressWarnings("unchecked") @@ -312,6 +322,14 @@ public JsonNullable postAsDraft() { return postAsDraft; } + /** + * User-friendly reference for the expense transaction. + */ + @JsonIgnore + public JsonNullable reference() { + return reference; + } + /** * The type of transaction. */ @@ -584,6 +602,24 @@ public ExpenseTransaction withPostAsDraft(JsonNullable postAsDraft) { return this; } + /** + * User-friendly reference for the expense transaction. + */ + public ExpenseTransaction withReference(String reference) { + Utils.checkNotNull(reference, "reference"); + this.reference = JsonNullable.of(reference); + return this; + } + + /** + * User-friendly reference for the expense transaction. + */ + public ExpenseTransaction withReference(JsonNullable reference) { + Utils.checkNotNull(reference, "reference"); + this.reference = reference; + return this; + } + /** * The type of transaction. */ @@ -613,6 +649,7 @@ public boolean equals(java.lang.Object o) { Objects.deepEquals(this.merchantName, other.merchantName) && Objects.deepEquals(this.notes, other.notes) && Objects.deepEquals(this.postAsDraft, other.postAsDraft) && + Objects.deepEquals(this.reference, other.reference) && Objects.deepEquals(this.type, other.type); } @@ -629,6 +666,7 @@ public int hashCode() { merchantName, notes, postAsDraft, + reference, type); } @@ -645,6 +683,7 @@ public String toString() { "merchantName", merchantName, "notes", notes, "postAsDraft", postAsDraft, + "reference", reference, "type", type); } @@ -670,6 +709,8 @@ public final static class Builder { private JsonNullable postAsDraft = JsonNullable.undefined(); + private JsonNullable reference = JsonNullable.undefined(); + private ExpenseTransactionType type; private Builder() { @@ -936,6 +977,24 @@ public Builder postAsDraft(JsonNullable postAsDraft) { return this; } + /** + * User-friendly reference for the expense transaction. + */ + public Builder reference(String reference) { + Utils.checkNotNull(reference, "reference"); + this.reference = JsonNullable.of(reference); + return this; + } + + /** + * User-friendly reference for the expense transaction. + */ + public Builder reference(JsonNullable reference) { + Utils.checkNotNull(reference, "reference"); + this.reference = reference; + return this; + } + /** * The type of transaction. */ @@ -957,6 +1016,7 @@ public ExpenseTransaction build() { merchantName, notes, postAsDraft, + reference, type); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhook.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhook.java new file mode 100644 index 00000000..43432635 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhook.java @@ -0,0 +1,399 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.Objects; +import java.util.Optional; + + +public class ExpensesSyncWebhook { + + /** + * The type of event. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("eventType") + private Optional eventType; + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("generatedDate") + private Optional generatedDate; + + /** + * Unique identifier of the event. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("id") + private Optional id; + + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("payload") + private Optional payload; + + @JsonCreator + public ExpensesSyncWebhook( + @JsonProperty("eventType") Optional eventType, + @JsonProperty("generatedDate") Optional generatedDate, + @JsonProperty("id") Optional id, + @JsonProperty("payload") Optional payload) { + Utils.checkNotNull(eventType, "eventType"); + Utils.checkNotNull(generatedDate, "generatedDate"); + Utils.checkNotNull(id, "id"); + Utils.checkNotNull(payload, "payload"); + this.eventType = eventType; + this.generatedDate = generatedDate; + this.id = id; + this.payload = payload; + } + + public ExpensesSyncWebhook() { + this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty()); + } + + /** + * The type of event. + */ + @JsonIgnore + public Optional eventType() { + return eventType; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + @JsonIgnore + public Optional generatedDate() { + return generatedDate; + } + + /** + * Unique identifier of the event. + */ + @JsonIgnore + public Optional id() { + return id; + } + + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional payload() { + return (Optional) payload; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * The type of event. + */ + public ExpensesSyncWebhook withEventType(String eventType) { + Utils.checkNotNull(eventType, "eventType"); + this.eventType = Optional.ofNullable(eventType); + return this; + } + + /** + * The type of event. + */ + public ExpensesSyncWebhook withEventType(Optional eventType) { + Utils.checkNotNull(eventType, "eventType"); + this.eventType = eventType; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public ExpensesSyncWebhook withGeneratedDate(String generatedDate) { + Utils.checkNotNull(generatedDate, "generatedDate"); + this.generatedDate = Optional.ofNullable(generatedDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public ExpensesSyncWebhook withGeneratedDate(Optional generatedDate) { + Utils.checkNotNull(generatedDate, "generatedDate"); + this.generatedDate = generatedDate; + return this; + } + + /** + * Unique identifier of the event. + */ + public ExpensesSyncWebhook withId(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier of the event. + */ + public ExpensesSyncWebhook withId(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + public ExpensesSyncWebhook withPayload(ExpensesSyncWebhookPayload payload) { + Utils.checkNotNull(payload, "payload"); + this.payload = Optional.ofNullable(payload); + return this; + } + + public ExpensesSyncWebhook withPayload(Optional payload) { + Utils.checkNotNull(payload, "payload"); + this.payload = payload; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExpensesSyncWebhook other = (ExpensesSyncWebhook) o; + return + Objects.deepEquals(this.eventType, other.eventType) && + Objects.deepEquals(this.generatedDate, other.generatedDate) && + Objects.deepEquals(this.id, other.id) && + Objects.deepEquals(this.payload, other.payload); + } + + @Override + public int hashCode() { + return Objects.hash( + eventType, + generatedDate, + id, + payload); + } + + @Override + public String toString() { + return Utils.toString(ExpensesSyncWebhook.class, + "eventType", eventType, + "generatedDate", generatedDate, + "id", id, + "payload", payload); + } + + public final static class Builder { + + private Optional eventType = Optional.empty(); + + private Optional generatedDate = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional payload = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * The type of event. + */ + public Builder eventType(String eventType) { + Utils.checkNotNull(eventType, "eventType"); + this.eventType = Optional.ofNullable(eventType); + return this; + } + + /** + * The type of event. + */ + public Builder eventType(Optional eventType) { + Utils.checkNotNull(eventType, "eventType"); + this.eventType = eventType; + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder generatedDate(String generatedDate) { + Utils.checkNotNull(generatedDate, "generatedDate"); + this.generatedDate = Optional.ofNullable(generatedDate); + return this; + } + + /** + * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. 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. + */ + public Builder generatedDate(Optional generatedDate) { + Utils.checkNotNull(generatedDate, "generatedDate"); + this.generatedDate = generatedDate; + return this; + } + + /** + * Unique identifier of the event. + */ + public Builder id(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier of the event. + */ + public Builder id(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + public Builder payload(ExpensesSyncWebhookPayload payload) { + Utils.checkNotNull(payload, "payload"); + this.payload = Optional.ofNullable(payload); + return this; + } + + public Builder payload(Optional payload) { + Utils.checkNotNull(payload, "payload"); + this.payload = payload; + return this; + } + + public ExpensesSyncWebhook build() { + return new ExpensesSyncWebhook( + eventType, + generatedDate, + id, + payload); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhookPayload.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhookPayload.java new file mode 100644 index 00000000..1757d3aa --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ExpensesSyncWebhookPayload.java @@ -0,0 +1,215 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.List; +import java.util.Objects; +import java.util.Optional; + + +public class ExpensesSyncWebhookPayload { + + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("referenceCompany") + private Optional referenceCompany; + + /** + * Unique identifier of the sync. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("syncId") + private Optional syncId; + + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("transactions") + private Optional> transactions; + + @JsonCreator + public ExpensesSyncWebhookPayload( + @JsonProperty("referenceCompany") Optional referenceCompany, + @JsonProperty("syncId") Optional syncId, + @JsonProperty("transactions") Optional> transactions) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + Utils.checkNotNull(syncId, "syncId"); + Utils.checkNotNull(transactions, "transactions"); + this.referenceCompany = referenceCompany; + this.syncId = syncId; + this.transactions = transactions; + } + + public ExpensesSyncWebhookPayload() { + this(Optional.empty(), Optional.empty(), Optional.empty()); + } + + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional referenceCompany() { + return (Optional) referenceCompany; + } + + /** + * Unique identifier of the sync. + */ + @JsonIgnore + public Optional syncId() { + return syncId; + } + + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> transactions() { + return (Optional>) transactions; + } + + public final static Builder builder() { + return new Builder(); + } + + public ExpensesSyncWebhookPayload withReferenceCompany(CompanyReference referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = Optional.ofNullable(referenceCompany); + return this; + } + + public ExpensesSyncWebhookPayload withReferenceCompany(Optional referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = referenceCompany; + return this; + } + + /** + * Unique identifier of the sync. + */ + public ExpensesSyncWebhookPayload withSyncId(String syncId) { + Utils.checkNotNull(syncId, "syncId"); + this.syncId = Optional.ofNullable(syncId); + return this; + } + + /** + * Unique identifier of the sync. + */ + public ExpensesSyncWebhookPayload withSyncId(Optional syncId) { + Utils.checkNotNull(syncId, "syncId"); + this.syncId = syncId; + return this; + } + + public ExpensesSyncWebhookPayload withTransactions(List transactions) { + Utils.checkNotNull(transactions, "transactions"); + this.transactions = Optional.ofNullable(transactions); + return this; + } + + public ExpensesSyncWebhookPayload withTransactions(Optional> transactions) { + Utils.checkNotNull(transactions, "transactions"); + this.transactions = transactions; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExpensesSyncWebhookPayload other = (ExpensesSyncWebhookPayload) o; + return + Objects.deepEquals(this.referenceCompany, other.referenceCompany) && + Objects.deepEquals(this.syncId, other.syncId) && + Objects.deepEquals(this.transactions, other.transactions); + } + + @Override + public int hashCode() { + return Objects.hash( + referenceCompany, + syncId, + transactions); + } + + @Override + public String toString() { + return Utils.toString(ExpensesSyncWebhookPayload.class, + "referenceCompany", referenceCompany, + "syncId", syncId, + "transactions", transactions); + } + + public final static class Builder { + + private Optional referenceCompany = Optional.empty(); + + private Optional syncId = Optional.empty(); + + private Optional> transactions = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + public Builder referenceCompany(CompanyReference referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = Optional.ofNullable(referenceCompany); + return this; + } + + public Builder referenceCompany(Optional referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = referenceCompany; + return this; + } + + /** + * Unique identifier of the sync. + */ + public Builder syncId(String syncId) { + Utils.checkNotNull(syncId, "syncId"); + this.syncId = Optional.ofNullable(syncId); + return this; + } + + /** + * Unique identifier of the sync. + */ + public Builder syncId(Optional syncId) { + Utils.checkNotNull(syncId, "syncId"); + this.syncId = syncId; + return this; + } + + public Builder transactions(List transactions) { + Utils.checkNotNull(transactions, "transactions"); + this.transactions = Optional.ofNullable(transactions); + return this; + } + + public Builder transactions(Optional> transactions) { + Utils.checkNotNull(transactions, "transactions"); + this.transactions = transactions; + return this; + } + + public ExpensesSyncWebhookPayload build() { + return new ExpensesSyncWebhookPayload( + referenceCompany, + syncId, + transactions); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/PhoneNumberItems.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/PhoneNumberItems.java new file mode 100644 index 00000000..2d5ec9da --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/PhoneNumberItems.java @@ -0,0 +1,169 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.util.Objects; +import org.openapitools.jackson.nullable.JsonNullable; + + +public class PhoneNumberItems { + + /** + * A phone number. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("number") + private JsonNullable number; + + /** + * The type of phone number + */ + @JsonProperty("type") + private PhoneNumberType type; + + @JsonCreator + public PhoneNumberItems( + @JsonProperty("number") JsonNullable number, + @JsonProperty("type") PhoneNumberType type) { + Utils.checkNotNull(number, "number"); + Utils.checkNotNull(type, "type"); + this.number = number; + this.type = type; + } + + public PhoneNumberItems( + PhoneNumberType type) { + this(JsonNullable.undefined(), type); + } + + /** + * A phone number. + */ + @JsonIgnore + public JsonNullable number() { + return number; + } + + /** + * The type of phone number + */ + @JsonIgnore + public PhoneNumberType type() { + return type; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * A phone number. + */ + public PhoneNumberItems withNumber(String number) { + Utils.checkNotNull(number, "number"); + this.number = JsonNullable.of(number); + return this; + } + + /** + * A phone number. + */ + public PhoneNumberItems withNumber(JsonNullable number) { + Utils.checkNotNull(number, "number"); + this.number = number; + return this; + } + + /** + * The type of phone number + */ + public PhoneNumberItems withType(PhoneNumberType type) { + Utils.checkNotNull(type, "type"); + this.type = type; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PhoneNumberItems other = (PhoneNumberItems) o; + return + Objects.deepEquals(this.number, other.number) && + Objects.deepEquals(this.type, other.type); + } + + @Override + public int hashCode() { + return Objects.hash( + number, + type); + } + + @Override + public String toString() { + return Utils.toString(PhoneNumberItems.class, + "number", number, + "type", type); + } + + public final static class Builder { + + private JsonNullable number = JsonNullable.undefined(); + + private PhoneNumberType type; + + private Builder() { + // force use of static builder() method + } + + /** + * A phone number. + */ + public Builder number(String number) { + Utils.checkNotNull(number, "number"); + this.number = JsonNullable.of(number); + return this; + } + + /** + * A phone number. + */ + public Builder number(JsonNullable number) { + Utils.checkNotNull(number, "number"); + this.number = number; + return this; + } + + /** + * The type of phone number + */ + public Builder type(PhoneNumberType type) { + Utils.checkNotNull(type, "type"); + this.type = type; + return this; + } + + public PhoneNumberItems build() { + return new PhoneNumberItems( + number, + type); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ReimbursableExpenseTransaction.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ReimbursableExpenseTransaction.java index d4124954..78d525db 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ReimbursableExpenseTransaction.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ReimbursableExpenseTransaction.java @@ -23,6 +23,10 @@ public class ReimbursableExpenseTransaction { + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("apAccountRef") + private JsonNullable apAccountRef; + @JsonProperty("contactRef") private ReimbursementContactRef contactRef; @@ -147,6 +151,7 @@ public class ReimbursableExpenseTransaction { @JsonCreator public ReimbursableExpenseTransaction( + @JsonProperty("apAccountRef") JsonNullable apAccountRef, @JsonProperty("contactRef") ReimbursementContactRef contactRef, @JsonProperty("currency") String currency, @JsonProperty("currencyRate") JsonNullable currencyRate, @@ -156,6 +161,7 @@ public ReimbursableExpenseTransaction( @JsonProperty("lines") Optional> lines, @JsonProperty("notes") Optional notes, @JsonProperty("reference") JsonNullable reference) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); Utils.checkNotNull(contactRef, "contactRef"); Utils.checkNotNull(currency, "currency"); Utils.checkNotNull(currencyRate, "currencyRate"); @@ -165,6 +171,7 @@ public ReimbursableExpenseTransaction( Utils.checkNotNull(lines, "lines"); Utils.checkNotNull(notes, "notes"); Utils.checkNotNull(reference, "reference"); + this.apAccountRef = apAccountRef; this.contactRef = contactRef; this.currency = currency; this.currencyRate = currencyRate; @@ -182,7 +189,13 @@ public ReimbursableExpenseTransaction( String dueDate, String id, String issueDate) { - this(contactRef, currency, JsonNullable.undefined(), dueDate, id, issueDate, Optional.empty(), Optional.empty(), JsonNullable.undefined()); + this(JsonNullable.undefined(), contactRef, currency, JsonNullable.undefined(), dueDate, id, issueDate, Optional.empty(), Optional.empty(), JsonNullable.undefined()); + } + + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable apAccountRef() { + return (JsonNullable) apAccountRef; } @JsonIgnore @@ -327,6 +340,18 @@ public final static Builder builder() { return new Builder(); } + public ReimbursableExpenseTransaction withApAccountRef(ApAccountRef apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = JsonNullable.of(apAccountRef); + return this; + } + + public ReimbursableExpenseTransaction withApAccountRef(JsonNullable apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = apAccountRef; + return this; + } + public ReimbursableExpenseTransaction withContactRef(ReimbursementContactRef contactRef) { Utils.checkNotNull(contactRef, "contactRef"); this.contactRef = contactRef; @@ -588,6 +613,7 @@ public boolean equals(java.lang.Object o) { } ReimbursableExpenseTransaction other = (ReimbursableExpenseTransaction) o; return + Objects.deepEquals(this.apAccountRef, other.apAccountRef) && Objects.deepEquals(this.contactRef, other.contactRef) && Objects.deepEquals(this.currency, other.currency) && Objects.deepEquals(this.currencyRate, other.currencyRate) && @@ -602,6 +628,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { return Objects.hash( + apAccountRef, contactRef, currency, currencyRate, @@ -616,6 +643,7 @@ public int hashCode() { @Override public String toString() { return Utils.toString(ReimbursableExpenseTransaction.class, + "apAccountRef", apAccountRef, "contactRef", contactRef, "currency", currency, "currencyRate", currencyRate, @@ -629,6 +657,8 @@ public String toString() { public final static class Builder { + private JsonNullable apAccountRef = JsonNullable.undefined(); + private ReimbursementContactRef contactRef; private String currency; @@ -651,6 +681,18 @@ private Builder() { // force use of static builder() method } + public Builder apAccountRef(ApAccountRef apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = JsonNullable.of(apAccountRef); + return this; + } + + public Builder apAccountRef(JsonNullable apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = apAccountRef; + return this; + } + public Builder contactRef(ReimbursementContactRef contactRef) { Utils.checkNotNull(contactRef, "contactRef"); this.contactRef = contactRef; @@ -904,6 +946,7 @@ public Builder reference(JsonNullable reference) { public ReimbursableExpenseTransaction build() { return new ReimbursableExpenseTransaction( + apAccountRef, contactRef, currency, currencyRate, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/SchemaTransaction.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/SchemaTransaction.java new file mode 100644 index 00000000..5d994a93 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/SchemaTransaction.java @@ -0,0 +1,320 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.type.TypeReference; +import io.codat.sync.expenses.utils.LazySingletonValue; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.Objects; +import org.openapitools.jackson.nullable.JsonNullable; + + +public class SchemaTransaction { + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("integrationType") + private JsonNullable integrationType; + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("message") + private JsonNullable message; + + /** + * Status of the transaction. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("status") + private JsonNullable status; + + /** + * Your unique idenfier of the transaction. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("transactionId") + private JsonNullable transactionId; + + @JsonCreator + public SchemaTransaction( + @JsonProperty("integrationType") JsonNullable integrationType, + @JsonProperty("message") JsonNullable message, + @JsonProperty("status") JsonNullable status, + @JsonProperty("transactionId") JsonNullable transactionId) { + Utils.checkNotNull(integrationType, "integrationType"); + Utils.checkNotNull(message, "message"); + Utils.checkNotNull(status, "status"); + Utils.checkNotNull(transactionId, "transactionId"); + this.integrationType = integrationType; + this.message = message; + this.status = status; + this.transactionId = transactionId; + } + + public SchemaTransaction() { + this(JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined()); + } + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable integrationType() { + return (JsonNullable) integrationType; + } + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + @JsonIgnore + public JsonNullable message() { + return message; + } + + /** + * Status of the transaction. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable status() { + return (JsonNullable) status; + } + + /** + * Your unique idenfier of the transaction. + */ + @JsonIgnore + public JsonNullable transactionId() { + return transactionId; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + public SchemaTransaction withIntegrationType(IntegrationType integrationType) { + Utils.checkNotNull(integrationType, "integrationType"); + this.integrationType = JsonNullable.of(integrationType); + return this; + } + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + public SchemaTransaction withIntegrationType(JsonNullable integrationType) { + Utils.checkNotNull(integrationType, "integrationType"); + this.integrationType = integrationType; + return this; + } + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + public SchemaTransaction withMessage(String message) { + Utils.checkNotNull(message, "message"); + this.message = JsonNullable.of(message); + return this; + } + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + public SchemaTransaction withMessage(JsonNullable message) { + Utils.checkNotNull(message, "message"); + this.message = message; + return this; + } + + /** + * Status of the transaction. + */ + public SchemaTransaction withStatus(TransactionStatus status) { + Utils.checkNotNull(status, "status"); + this.status = JsonNullable.of(status); + return this; + } + + /** + * Status of the transaction. + */ + public SchemaTransaction withStatus(JsonNullable status) { + Utils.checkNotNull(status, "status"); + this.status = status; + return this; + } + + /** + * Your unique idenfier of the transaction. + */ + public SchemaTransaction withTransactionId(String transactionId) { + Utils.checkNotNull(transactionId, "transactionId"); + this.transactionId = JsonNullable.of(transactionId); + return this; + } + + /** + * Your unique idenfier of the transaction. + */ + public SchemaTransaction withTransactionId(JsonNullable transactionId) { + Utils.checkNotNull(transactionId, "transactionId"); + this.transactionId = transactionId; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SchemaTransaction other = (SchemaTransaction) o; + return + Objects.deepEquals(this.integrationType, other.integrationType) && + Objects.deepEquals(this.message, other.message) && + Objects.deepEquals(this.status, other.status) && + Objects.deepEquals(this.transactionId, other.transactionId); + } + + @Override + public int hashCode() { + return Objects.hash( + integrationType, + message, + status, + transactionId); + } + + @Override + public String toString() { + return Utils.toString(SchemaTransaction.class, + "integrationType", integrationType, + "message", message, + "status", status, + "transactionId", transactionId); + } + + public final static class Builder { + + private JsonNullable integrationType; + + private JsonNullable message = JsonNullable.undefined(); + + private JsonNullable status = JsonNullable.undefined(); + + private JsonNullable transactionId = JsonNullable.undefined(); + + private Builder() { + // force use of static builder() method + } + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + public Builder integrationType(IntegrationType integrationType) { + Utils.checkNotNull(integrationType, "integrationType"); + this.integrationType = JsonNullable.of(integrationType); + return this; + } + + /** + * Type of transaction that has been processed e.g. Expense or Bank Feed. + */ + public Builder integrationType(JsonNullable integrationType) { + Utils.checkNotNull(integrationType, "integrationType"); + this.integrationType = integrationType; + return this; + } + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + public Builder message(String message) { + Utils.checkNotNull(message, "message"); + this.message = JsonNullable.of(message); + return this; + } + + /** + * Metadata such as validation errors or the resulting record created in the accounting software. + */ + public Builder message(JsonNullable message) { + Utils.checkNotNull(message, "message"); + this.message = message; + return this; + } + + /** + * Status of the transaction. + */ + public Builder status(TransactionStatus status) { + Utils.checkNotNull(status, "status"); + this.status = JsonNullable.of(status); + return this; + } + + /** + * Status of the transaction. + */ + public Builder status(JsonNullable status) { + Utils.checkNotNull(status, "status"); + this.status = status; + return this; + } + + /** + * Your unique idenfier of the transaction. + */ + public Builder transactionId(String transactionId) { + Utils.checkNotNull(transactionId, "transactionId"); + this.transactionId = JsonNullable.of(transactionId); + return this; + } + + /** + * Your unique idenfier of the transaction. + */ + public Builder transactionId(JsonNullable transactionId) { + Utils.checkNotNull(transactionId, "transactionId"); + this.transactionId = transactionId; + return this; + } + + public SchemaTransaction build() { + if (integrationType == null) { + integrationType = _SINGLETON_VALUE_IntegrationType.value(); + } return new SchemaTransaction( + integrationType, + message, + status, + transactionId); + } + + private static final LazySingletonValue> _SINGLETON_VALUE_IntegrationType = + new LazySingletonValue<>( + "integrationType", + "\"expenses\"", + new TypeReference>() {}); + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Supplier.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Supplier.java index a0176a62..d57f5558 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Supplier.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Supplier.java @@ -20,9 +20,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * Supplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * Supplier - ## Overview * * From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). */ diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Tags.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Tags.java deleted file mode 100644 index e1c287f5..00000000 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Tags.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -package io.codat.sync.expenses.models.components; - - -import com.fasterxml.jackson.annotation.JsonCreator; -import io.codat.sync.expenses.utils.Utils; -import java.lang.Override; -import java.lang.String; -import java.util.Objects; - -/** - * Tags - A collection of user-defined key-value pairs that store custom metadata against the company. - */ - -public class Tags { - - @JsonCreator - public Tags() { - - - } - - public final static Builder builder() { - return new Builder(); - } - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash( - ); - } - - @Override - public String toString() { - return Utils.toString(Tags.class); - } - - public final static class Builder { - - private Builder() { - // force use of static builder() method - } - - public Tags build() { - return new Tags( - ); - } - } -} - diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transaction.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transaction.java index 9942b8da..4c453be6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transaction.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transaction.java @@ -10,98 +10,78 @@ import com.fasterxml.jackson.annotation.JsonInclude.Include; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.core.type.TypeReference; -import io.codat.sync.expenses.utils.LazySingletonValue; import io.codat.sync.expenses.utils.Utils; import java.lang.Override; import java.lang.String; import java.lang.SuppressWarnings; import java.util.Objects; +import java.util.Optional; import org.openapitools.jackson.nullable.JsonNullable; public class Transaction { /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ @JsonInclude(Include.NON_ABSENT) - @JsonProperty("integrationType") - private JsonNullable integrationType; + @JsonProperty("errorMessage") + private JsonNullable errorMessage; /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ @JsonInclude(Include.NON_ABSENT) - @JsonProperty("message") - private JsonNullable message; + @JsonProperty("id") + private Optional id; /** - * Status of the transaction. + * Status of transaction. */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("status") - private JsonNullable status; - - /** - * Your unique idenfier of the transaction. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("transactionId") - private JsonNullable transactionId; + private Optional status; @JsonCreator public Transaction( - @JsonProperty("integrationType") JsonNullable integrationType, - @JsonProperty("message") JsonNullable message, - @JsonProperty("status") JsonNullable status, - @JsonProperty("transactionId") JsonNullable transactionId) { - Utils.checkNotNull(integrationType, "integrationType"); - Utils.checkNotNull(message, "message"); + @JsonProperty("errorMessage") JsonNullable errorMessage, + @JsonProperty("id") Optional id, + @JsonProperty("status") Optional status) { + Utils.checkNotNull(errorMessage, "errorMessage"); + Utils.checkNotNull(id, "id"); Utils.checkNotNull(status, "status"); - Utils.checkNotNull(transactionId, "transactionId"); - this.integrationType = integrationType; - this.message = message; + this.errorMessage = errorMessage; + this.id = id; this.status = status; - this.transactionId = transactionId; } public Transaction() { - this(JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined()); + this(JsonNullable.undefined(), Optional.empty(), Optional.empty()); } /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ - @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable integrationType() { - return (JsonNullable) integrationType; + public JsonNullable errorMessage() { + return errorMessage; } /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ @JsonIgnore - public JsonNullable message() { - return message; + public Optional id() { + return id; } /** - * Status of the transaction. + * Status of transaction. */ @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable status() { - return (JsonNullable) status; - } - - /** - * Your unique idenfier of the transaction. - */ - @JsonIgnore - public JsonNullable transactionId() { - return transactionId; + public Optional status() { + return (Optional) status; } public final static Builder builder() { @@ -109,76 +89,58 @@ public final static Builder builder() { } /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ - public Transaction withIntegrationType(IntegrationType integrationType) { - Utils.checkNotNull(integrationType, "integrationType"); - this.integrationType = JsonNullable.of(integrationType); + public Transaction withErrorMessage(String errorMessage) { + Utils.checkNotNull(errorMessage, "errorMessage"); + this.errorMessage = JsonNullable.of(errorMessage); return this; } /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ - public Transaction withIntegrationType(JsonNullable integrationType) { - Utils.checkNotNull(integrationType, "integrationType"); - this.integrationType = integrationType; + public Transaction withErrorMessage(JsonNullable errorMessage) { + Utils.checkNotNull(errorMessage, "errorMessage"); + this.errorMessage = errorMessage; return this; } /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ - public Transaction withMessage(String message) { - Utils.checkNotNull(message, "message"); - this.message = JsonNullable.of(message); + public Transaction withId(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); return this; } /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ - public Transaction withMessage(JsonNullable message) { - Utils.checkNotNull(message, "message"); - this.message = message; + public Transaction withId(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; return this; } /** - * Status of the transaction. + * Status of transaction. */ - public Transaction withStatus(TransactionStatus status) { + public Transaction withStatus(TransactionDefinitionsStatus status) { Utils.checkNotNull(status, "status"); - this.status = JsonNullable.of(status); + this.status = Optional.ofNullable(status); return this; } /** - * Status of the transaction. + * Status of transaction. */ - public Transaction withStatus(JsonNullable status) { + public Transaction withStatus(Optional status) { Utils.checkNotNull(status, "status"); this.status = status; return this; } - - /** - * Your unique idenfier of the transaction. - */ - public Transaction withTransactionId(String transactionId) { - Utils.checkNotNull(transactionId, "transactionId"); - this.transactionId = JsonNullable.of(transactionId); - return this; - } - - /** - * Your unique idenfier of the transaction. - */ - public Transaction withTransactionId(JsonNullable transactionId) { - Utils.checkNotNull(transactionId, "transactionId"); - this.transactionId = transactionId; - return this; - } @Override public boolean equals(java.lang.Object o) { @@ -190,131 +152,99 @@ public boolean equals(java.lang.Object o) { } Transaction other = (Transaction) o; return - Objects.deepEquals(this.integrationType, other.integrationType) && - Objects.deepEquals(this.message, other.message) && - Objects.deepEquals(this.status, other.status) && - Objects.deepEquals(this.transactionId, other.transactionId); + Objects.deepEquals(this.errorMessage, other.errorMessage) && + Objects.deepEquals(this.id, other.id) && + Objects.deepEquals(this.status, other.status); } @Override public int hashCode() { return Objects.hash( - integrationType, - message, - status, - transactionId); + errorMessage, + id, + status); } @Override public String toString() { return Utils.toString(Transaction.class, - "integrationType", integrationType, - "message", message, - "status", status, - "transactionId", transactionId); + "errorMessage", errorMessage, + "id", id, + "status", status); } public final static class Builder { - private JsonNullable integrationType; + private JsonNullable errorMessage = JsonNullable.undefined(); - private JsonNullable message = JsonNullable.undefined(); + private Optional id = Optional.empty(); - private JsonNullable status = JsonNullable.undefined(); - - private JsonNullable transactionId = JsonNullable.undefined(); + private Optional status = Optional.empty(); private Builder() { // force use of static builder() method } /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ - public Builder integrationType(IntegrationType integrationType) { - Utils.checkNotNull(integrationType, "integrationType"); - this.integrationType = JsonNullable.of(integrationType); + public Builder errorMessage(String errorMessage) { + Utils.checkNotNull(errorMessage, "errorMessage"); + this.errorMessage = JsonNullable.of(errorMessage); return this; } /** - * Type of transaction that has been processed e.g. Expense or Bank Feed. + * Error message for failed transaction. */ - public Builder integrationType(JsonNullable integrationType) { - Utils.checkNotNull(integrationType, "integrationType"); - this.integrationType = integrationType; + public Builder errorMessage(JsonNullable errorMessage) { + Utils.checkNotNull(errorMessage, "errorMessage"); + this.errorMessage = errorMessage; return this; } /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ - public Builder message(String message) { - Utils.checkNotNull(message, "message"); - this.message = JsonNullable.of(message); + public Builder id(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); return this; } /** - * Metadata such as validation errors or the resulting record created in the accounting software. + * Unique identifier of the transaction. */ - public Builder message(JsonNullable message) { - Utils.checkNotNull(message, "message"); - this.message = message; + public Builder id(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; return this; } /** - * Status of the transaction. + * Status of transaction. */ - public Builder status(TransactionStatus status) { + public Builder status(TransactionDefinitionsStatus status) { Utils.checkNotNull(status, "status"); - this.status = JsonNullable.of(status); + this.status = Optional.ofNullable(status); return this; } /** - * Status of the transaction. + * Status of transaction. */ - public Builder status(JsonNullable status) { + public Builder status(Optional status) { Utils.checkNotNull(status, "status"); this.status = status; return this; } - - /** - * Your unique idenfier of the transaction. - */ - public Builder transactionId(String transactionId) { - Utils.checkNotNull(transactionId, "transactionId"); - this.transactionId = JsonNullable.of(transactionId); - return this; - } - - /** - * Your unique idenfier of the transaction. - */ - public Builder transactionId(JsonNullable transactionId) { - Utils.checkNotNull(transactionId, "transactionId"); - this.transactionId = transactionId; - return this; - } public Transaction build() { - if (integrationType == null) { - integrationType = _SINGLETON_VALUE_IntegrationType.value(); - } return new Transaction( - integrationType, - message, - status, - transactionId); + return new Transaction( + errorMessage, + id, + status); } - - private static final LazySingletonValue> _SINGLETON_VALUE_IntegrationType = - new LazySingletonValue<>( - "integrationType", - "\"expenses\"", - new TypeReference>() {}); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/TransactionDefinitionsStatus.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/TransactionDefinitionsStatus.java new file mode 100644 index 00000000..b98fbdd5 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/TransactionDefinitionsStatus.java @@ -0,0 +1,30 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + +import com.fasterxml.jackson.annotation.JsonValue; +import java.lang.String; + +/** + * TransactionDefinitionsStatus - Status of transaction. + */ +public enum TransactionDefinitionsStatus { + UNKNOWN("Unknown"), + PUSH_ERROR("PushError"), + COMPLETED("Completed"), + FAILED("Failed"), + PENDING("Pending"); + + @JsonValue + private final String value; + + private TransactionDefinitionsStatus(String value) { + this.value = value; + } + + public String value() { + return value; + } +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transactions.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transactions.java index 576d9cc6..98130388 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transactions.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Transactions.java @@ -39,7 +39,7 @@ public class Transactions { @JsonInclude(Include.NON_ABSENT) @JsonProperty("results") - private Optional> results; + private Optional> results; /** * Total number of items. @@ -52,7 +52,7 @@ public Transactions( @JsonProperty("_links") Links links, @JsonProperty("pageNumber") long pageNumber, @JsonProperty("pageSize") long pageSize, - @JsonProperty("results") Optional> results, + @JsonProperty("results") Optional> results, @JsonProperty("totalResults") long totalResults) { Utils.checkNotNull(links, "links"); Utils.checkNotNull(pageNumber, "pageNumber"); @@ -97,8 +97,8 @@ public long pageSize() { @SuppressWarnings("unchecked") @JsonIgnore - public Optional> results() { - return (Optional>) results; + public Optional> results() { + return (Optional>) results; } /** @@ -137,13 +137,13 @@ public Transactions withPageSize(long pageSize) { return this; } - public Transactions withResults(List results) { + public Transactions withResults(List results) { Utils.checkNotNull(results, "results"); this.results = Optional.ofNullable(results); return this; } - public Transactions withResults(Optional> results) { + public Transactions withResults(Optional> results) { Utils.checkNotNull(results, "results"); this.results = results; return this; @@ -203,7 +203,7 @@ public final static class Builder { private Long pageSize; - private Optional> results = Optional.empty(); + private Optional> results = Optional.empty(); private Long totalResults; @@ -235,13 +235,13 @@ public Builder pageSize(long pageSize) { return this; } - public Builder results(List results) { + public Builder results(List results) { Utils.checkNotNull(results, "results"); this.results = Optional.ofNullable(results); return this; } - public Builder results(Optional> results) { + public Builder results(Optional> results) { Utils.checkNotNull(results, "results"); this.results = results; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingAddress.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingAddress.java deleted file mode 100644 index 4e565c25..00000000 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingAddress.java +++ /dev/null @@ -1,469 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -package io.codat.sync.expenses.models.components; - - -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonInclude.Include; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import io.codat.sync.expenses.utils.Utils; -import java.lang.Override; -import java.lang.String; -import java.util.Objects; -import org.openapitools.jackson.nullable.JsonNullable; - - -public class UpdateCustomerResponseAccountingAddress { - - /** - * City of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("city") - private JsonNullable city; - - /** - * Country of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("country") - private JsonNullable country; - - /** - * Line 1 of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("line1") - private JsonNullable line1; - - /** - * Line 2 of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("line2") - private JsonNullable line2; - - /** - * Postal code or zip code. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("postalCode") - private JsonNullable postalCode; - - /** - * Region of the customer address. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("region") - private JsonNullable region; - - /** - * The type of the address - */ - @JsonProperty("type") - private AccountingAddressType type; - - @JsonCreator - public UpdateCustomerResponseAccountingAddress( - @JsonProperty("city") JsonNullable city, - @JsonProperty("country") JsonNullable country, - @JsonProperty("line1") JsonNullable line1, - @JsonProperty("line2") JsonNullable line2, - @JsonProperty("postalCode") JsonNullable postalCode, - @JsonProperty("region") JsonNullable region, - @JsonProperty("type") AccountingAddressType type) { - Utils.checkNotNull(city, "city"); - Utils.checkNotNull(country, "country"); - Utils.checkNotNull(line1, "line1"); - Utils.checkNotNull(line2, "line2"); - Utils.checkNotNull(postalCode, "postalCode"); - Utils.checkNotNull(region, "region"); - Utils.checkNotNull(type, "type"); - this.city = city; - this.country = country; - this.line1 = line1; - this.line2 = line2; - this.postalCode = postalCode; - this.region = region; - this.type = type; - } - - public UpdateCustomerResponseAccountingAddress( - AccountingAddressType type) { - this(JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), JsonNullable.undefined(), type); - } - - /** - * City of the customer address. - */ - @JsonIgnore - public JsonNullable city() { - return city; - } - - /** - * Country of the customer address. - */ - @JsonIgnore - public JsonNullable country() { - return country; - } - - /** - * Line 1 of the customer address. - */ - @JsonIgnore - public JsonNullable line1() { - return line1; - } - - /** - * Line 2 of the customer address. - */ - @JsonIgnore - public JsonNullable line2() { - return line2; - } - - /** - * Postal code or zip code. - */ - @JsonIgnore - public JsonNullable postalCode() { - return postalCode; - } - - /** - * Region of the customer address. - */ - @JsonIgnore - public JsonNullable region() { - return region; - } - - /** - * The type of the address - */ - @JsonIgnore - public AccountingAddressType type() { - return type; - } - - public final static Builder builder() { - return new Builder(); - } - - /** - * City of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withCity(String city) { - Utils.checkNotNull(city, "city"); - this.city = JsonNullable.of(city); - return this; - } - - /** - * City of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withCity(JsonNullable city) { - Utils.checkNotNull(city, "city"); - this.city = city; - return this; - } - - /** - * Country of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withCountry(String country) { - Utils.checkNotNull(country, "country"); - this.country = JsonNullable.of(country); - return this; - } - - /** - * Country of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withCountry(JsonNullable country) { - Utils.checkNotNull(country, "country"); - this.country = country; - return this; - } - - /** - * Line 1 of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withLine1(String line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = JsonNullable.of(line1); - return this; - } - - /** - * Line 1 of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withLine1(JsonNullable line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = line1; - return this; - } - - /** - * Line 2 of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withLine2(String line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = JsonNullable.of(line2); - return this; - } - - /** - * Line 2 of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withLine2(JsonNullable line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = line2; - return this; - } - - /** - * Postal code or zip code. - */ - public UpdateCustomerResponseAccountingAddress withPostalCode(String postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = JsonNullable.of(postalCode); - return this; - } - - /** - * Postal code or zip code. - */ - public UpdateCustomerResponseAccountingAddress withPostalCode(JsonNullable postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = postalCode; - return this; - } - - /** - * Region of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withRegion(String region) { - Utils.checkNotNull(region, "region"); - this.region = JsonNullable.of(region); - return this; - } - - /** - * Region of the customer address. - */ - public UpdateCustomerResponseAccountingAddress withRegion(JsonNullable region) { - Utils.checkNotNull(region, "region"); - this.region = region; - return this; - } - - /** - * The type of the address - */ - public UpdateCustomerResponseAccountingAddress withType(AccountingAddressType type) { - Utils.checkNotNull(type, "type"); - this.type = type; - return this; - } - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UpdateCustomerResponseAccountingAddress other = (UpdateCustomerResponseAccountingAddress) o; - return - Objects.deepEquals(this.city, other.city) && - Objects.deepEquals(this.country, other.country) && - Objects.deepEquals(this.line1, other.line1) && - Objects.deepEquals(this.line2, other.line2) && - Objects.deepEquals(this.postalCode, other.postalCode) && - Objects.deepEquals(this.region, other.region) && - Objects.deepEquals(this.type, other.type); - } - - @Override - public int hashCode() { - return Objects.hash( - city, - country, - line1, - line2, - postalCode, - region, - type); - } - - @Override - public String toString() { - return Utils.toString(UpdateCustomerResponseAccountingAddress.class, - "city", city, - "country", country, - "line1", line1, - "line2", line2, - "postalCode", postalCode, - "region", region, - "type", type); - } - - public final static class Builder { - - private JsonNullable city = JsonNullable.undefined(); - - private JsonNullable country = JsonNullable.undefined(); - - private JsonNullable line1 = JsonNullable.undefined(); - - private JsonNullable line2 = JsonNullable.undefined(); - - private JsonNullable postalCode = JsonNullable.undefined(); - - private JsonNullable region = JsonNullable.undefined(); - - private AccountingAddressType type; - - private Builder() { - // force use of static builder() method - } - - /** - * City of the customer address. - */ - public Builder city(String city) { - Utils.checkNotNull(city, "city"); - this.city = JsonNullable.of(city); - return this; - } - - /** - * City of the customer address. - */ - public Builder city(JsonNullable city) { - Utils.checkNotNull(city, "city"); - this.city = city; - return this; - } - - /** - * Country of the customer address. - */ - public Builder country(String country) { - Utils.checkNotNull(country, "country"); - this.country = JsonNullable.of(country); - return this; - } - - /** - * Country of the customer address. - */ - public Builder country(JsonNullable country) { - Utils.checkNotNull(country, "country"); - this.country = country; - return this; - } - - /** - * Line 1 of the customer address. - */ - public Builder line1(String line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = JsonNullable.of(line1); - return this; - } - - /** - * Line 1 of the customer address. - */ - public Builder line1(JsonNullable line1) { - Utils.checkNotNull(line1, "line1"); - this.line1 = line1; - return this; - } - - /** - * Line 2 of the customer address. - */ - public Builder line2(String line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = JsonNullable.of(line2); - return this; - } - - /** - * Line 2 of the customer address. - */ - public Builder line2(JsonNullable line2) { - Utils.checkNotNull(line2, "line2"); - this.line2 = line2; - return this; - } - - /** - * Postal code or zip code. - */ - public Builder postalCode(String postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = JsonNullable.of(postalCode); - return this; - } - - /** - * Postal code or zip code. - */ - public Builder postalCode(JsonNullable postalCode) { - Utils.checkNotNull(postalCode, "postalCode"); - this.postalCode = postalCode; - return this; - } - - /** - * Region of the customer address. - */ - public Builder region(String region) { - Utils.checkNotNull(region, "region"); - this.region = JsonNullable.of(region); - return this; - } - - /** - * Region of the customer address. - */ - public Builder region(JsonNullable region) { - Utils.checkNotNull(region, "region"); - this.region = region; - return this; - } - - /** - * The type of the address - */ - public Builder type(AccountingAddressType type) { - Utils.checkNotNull(type, "type"); - this.type = type; - return this; - } - - public UpdateCustomerResponseAccountingAddress build() { - return new UpdateCustomerResponseAccountingAddress( - city, - country, - line1, - line2, - postalCode, - region, - type); - } - } -} - diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingCustomer.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingCustomer.java index bae6af9f..f4ccaa1f 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingCustomer.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateCustomerResponseAccountingCustomer.java @@ -21,9 +21,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * UpdateCustomerResponseAccountingCustomer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * UpdateCustomerResponseAccountingCustomer - ## Overview * * A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). * @@ -39,7 +37,7 @@ public class UpdateCustomerResponseAccountingCustomer { */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("addresses") - private JsonNullable> addresses; + private JsonNullable> addresses; /** * Name of the main contact for the identified customer. @@ -139,7 +137,7 @@ public class UpdateCustomerResponseAccountingCustomer { @JsonCreator public UpdateCustomerResponseAccountingCustomer( - @JsonProperty("addresses") JsonNullable> addresses, + @JsonProperty("addresses") JsonNullable> addresses, @JsonProperty("contactName") JsonNullable contactName, @JsonProperty("contacts") JsonNullable> contacts, @JsonProperty("customerName") JsonNullable customerName, @@ -196,8 +194,8 @@ public UpdateCustomerResponseAccountingCustomer( */ @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable> addresses() { - return (JsonNullable>) addresses; + public JsonNullable> addresses() { + return (JsonNullable>) addresses; } /** @@ -321,7 +319,7 @@ public final static Builder builder() { /** * An array of Addresses. */ - public UpdateCustomerResponseAccountingCustomer withAddresses(List addresses) { + public UpdateCustomerResponseAccountingCustomer withAddresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -330,7 +328,7 @@ public UpdateCustomerResponseAccountingCustomer withAddresses(List> addresses) { + public UpdateCustomerResponseAccountingCustomer withAddresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; @@ -646,7 +644,7 @@ public String toString() { public final static class Builder { - private JsonNullable> addresses = JsonNullable.undefined(); + private JsonNullable> addresses = JsonNullable.undefined(); private JsonNullable contactName = JsonNullable.undefined(); @@ -683,7 +681,7 @@ private Builder() { /** * An array of Addresses. */ - public Builder addresses(List addresses) { + public Builder addresses(List addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = JsonNullable.of(addresses); return this; @@ -692,7 +690,7 @@ public Builder addresses(List addresses /** * An array of Addresses. */ - public Builder addresses(JsonNullable> addresses) { + public Builder addresses(JsonNullable> addresses) { Utils.checkNotNull(addresses, "addresses"); this.addresses = addresses; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateReimbursableExpenseTransactionRequest.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateReimbursableExpenseTransactionRequest.java index a92b61b7..14a8182a 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateReimbursableExpenseTransactionRequest.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateReimbursableExpenseTransactionRequest.java @@ -23,6 +23,10 @@ public class UpdateReimbursableExpenseTransactionRequest { + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("apAccountRef") + private JsonNullable apAccountRef; + @JsonProperty("contactRef") private ReimbursementContactRef contactRef; @@ -141,6 +145,7 @@ public class UpdateReimbursableExpenseTransactionRequest { @JsonCreator public UpdateReimbursableExpenseTransactionRequest( + @JsonProperty("apAccountRef") JsonNullable apAccountRef, @JsonProperty("contactRef") ReimbursementContactRef contactRef, @JsonProperty("currency") String currency, @JsonProperty("currencyRate") JsonNullable currencyRate, @@ -149,6 +154,7 @@ public UpdateReimbursableExpenseTransactionRequest( @JsonProperty("lines") Optional> lines, @JsonProperty("notes") Optional notes, @JsonProperty("reference") JsonNullable reference) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); Utils.checkNotNull(contactRef, "contactRef"); Utils.checkNotNull(currency, "currency"); Utils.checkNotNull(currencyRate, "currencyRate"); @@ -157,6 +163,7 @@ public UpdateReimbursableExpenseTransactionRequest( Utils.checkNotNull(lines, "lines"); Utils.checkNotNull(notes, "notes"); Utils.checkNotNull(reference, "reference"); + this.apAccountRef = apAccountRef; this.contactRef = contactRef; this.currency = currency; this.currencyRate = currencyRate; @@ -172,7 +179,13 @@ public UpdateReimbursableExpenseTransactionRequest( String currency, String dueDate, String issueDate) { - this(contactRef, currency, JsonNullable.undefined(), dueDate, issueDate, Optional.empty(), Optional.empty(), JsonNullable.undefined()); + this(JsonNullable.undefined(), contactRef, currency, JsonNullable.undefined(), dueDate, issueDate, Optional.empty(), Optional.empty(), JsonNullable.undefined()); + } + + @SuppressWarnings("unchecked") + @JsonIgnore + public JsonNullable apAccountRef() { + return (JsonNullable) apAccountRef; } @JsonIgnore @@ -309,6 +322,18 @@ public final static Builder builder() { return new Builder(); } + public UpdateReimbursableExpenseTransactionRequest withApAccountRef(ApAccountRef apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = JsonNullable.of(apAccountRef); + return this; + } + + public UpdateReimbursableExpenseTransactionRequest withApAccountRef(JsonNullable apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = apAccountRef; + return this; + } + public UpdateReimbursableExpenseTransactionRequest withContactRef(ReimbursementContactRef contactRef) { Utils.checkNotNull(contactRef, "contactRef"); this.contactRef = contactRef; @@ -561,6 +586,7 @@ public boolean equals(java.lang.Object o) { } UpdateReimbursableExpenseTransactionRequest other = (UpdateReimbursableExpenseTransactionRequest) o; return + Objects.deepEquals(this.apAccountRef, other.apAccountRef) && Objects.deepEquals(this.contactRef, other.contactRef) && Objects.deepEquals(this.currency, other.currency) && Objects.deepEquals(this.currencyRate, other.currencyRate) && @@ -574,6 +600,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { return Objects.hash( + apAccountRef, contactRef, currency, currencyRate, @@ -587,6 +614,7 @@ public int hashCode() { @Override public String toString() { return Utils.toString(UpdateReimbursableExpenseTransactionRequest.class, + "apAccountRef", apAccountRef, "contactRef", contactRef, "currency", currency, "currencyRate", currencyRate, @@ -599,6 +627,8 @@ public String toString() { public final static class Builder { + private JsonNullable apAccountRef = JsonNullable.undefined(); + private ReimbursementContactRef contactRef; private String currency; @@ -619,6 +649,18 @@ private Builder() { // force use of static builder() method } + public Builder apAccountRef(ApAccountRef apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = JsonNullable.of(apAccountRef); + return this; + } + + public Builder apAccountRef(JsonNullable apAccountRef) { + Utils.checkNotNull(apAccountRef, "apAccountRef"); + this.apAccountRef = apAccountRef; + return this; + } + public Builder contactRef(ReimbursementContactRef contactRef) { Utils.checkNotNull(contactRef, "contactRef"); this.contactRef = contactRef; @@ -863,6 +905,7 @@ public Builder reference(JsonNullable reference) { public UpdateReimbursableExpenseTransactionRequest build() { return new UpdateReimbursableExpenseTransactionRequest( + apAccountRef, contactRef, currency, currencyRate, diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponseAccountingSupplier.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponseAccountingSupplier.java index 8d58c5d9..94cf4be5 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponseAccountingSupplier.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/UpdateSupplierResponseAccountingSupplier.java @@ -21,9 +21,7 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * UpdateSupplierResponseAccountingSupplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>. - * - * ## Overview + * UpdateSupplierResponseAccountingSupplier - ## Overview * * From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-api#/schemas/Bill). * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ValidFor.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ValidFor.java new file mode 100644 index 00000000..50136c75 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/ValidFor.java @@ -0,0 +1,29 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + +import com.fasterxml.jackson.annotation.JsonValue; +import java.lang.String; + +public enum ValidFor { + EXPENSE_TRANSACTIONS_PAYMENT("expense-transactions.Payment"), + EXPENSE_TRANSACTIONS_REFUND("expense-transactions.Refund"), + EXPENSE_TRANSACTIONS_REWARD("expense-transactions.Reward"), + EXPENSE_TRANSACTIONS_CHARGEBACK("expense-transactions.Chargeback"), + REIMBURSABLE_EXPENSE_TRANSACTIONS("reimbursable-expense-transactions"), + TRANSFER_TRANSACTIONS("transfer-transactions"), + ADJUSTMENT_TRANSACTIONS("adjustment-transactions"); + + @JsonValue + private final String value; + + private ValidFor(String value) { + this.value = value; + } + + public String value() { + return value; + } +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Weblink.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Weblink.java new file mode 100644 index 00000000..7eb4a91c --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/components/Weblink.java @@ -0,0 +1,192 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.Objects; +import java.util.Optional; + +/** + * Weblink - Weblink associated with the company. + */ + +public class Weblink { + + /** + * The type of the weblink. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("type") + private Optional type; + + /** + * The full URL for the weblink. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("url") + private Optional url; + + @JsonCreator + public Weblink( + @JsonProperty("type") Optional type, + @JsonProperty("url") Optional url) { + Utils.checkNotNull(type, "type"); + Utils.checkNotNull(url, "url"); + this.type = type; + this.url = url; + } + + public Weblink() { + this(Optional.empty(), Optional.empty()); + } + + /** + * The type of the weblink. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional type() { + return (Optional) type; + } + + /** + * The full URL for the weblink. + */ + @JsonIgnore + public Optional url() { + return url; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * The type of the weblink. + */ + public Weblink withType(CompanyInformationType type) { + Utils.checkNotNull(type, "type"); + this.type = Optional.ofNullable(type); + return this; + } + + /** + * The type of the weblink. + */ + public Weblink withType(Optional type) { + Utils.checkNotNull(type, "type"); + this.type = type; + return this; + } + + /** + * The full URL for the weblink. + */ + public Weblink withUrl(String url) { + Utils.checkNotNull(url, "url"); + this.url = Optional.ofNullable(url); + return this; + } + + /** + * The full URL for the weblink. + */ + public Weblink withUrl(Optional url) { + Utils.checkNotNull(url, "url"); + this.url = url; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Weblink other = (Weblink) o; + return + Objects.deepEquals(this.type, other.type) && + Objects.deepEquals(this.url, other.url); + } + + @Override + public int hashCode() { + return Objects.hash( + type, + url); + } + + @Override + public String toString() { + return Utils.toString(Weblink.class, + "type", type, + "url", url); + } + + public final static class Builder { + + private Optional type = Optional.empty(); + + private Optional url = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * The type of the weblink. + */ + public Builder type(CompanyInformationType type) { + Utils.checkNotNull(type, "type"); + this.type = Optional.ofNullable(type); + return this; + } + + /** + * The type of the weblink. + */ + public Builder type(Optional type) { + Utils.checkNotNull(type, "type"); + this.type = type; + return this; + } + + /** + * The full URL for the weblink. + */ + public Builder url(String url) { + Utils.checkNotNull(url, "url"); + this.url = Optional.ofNullable(url); + return this; + } + + /** + * The full URL for the weblink. + */ + public Builder url(Optional url) { + Utils.checkNotNull(url, "url"); + this.url = url; + return this; + } + + public Weblink build() { + return new Weblink( + type, + url); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/errors/ErrorMessage.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/errors/ErrorMessage.java index bd84a123..aae8b476 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/errors/ErrorMessage.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/errors/ErrorMessage.java @@ -19,8 +19,9 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * ErrorMessage - The request made is not valid. + * ErrorMessage - Your `query` parameter was not correctly formed */ +@SuppressWarnings("serial") public class ErrorMessage extends RuntimeException { /** diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAccountRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAccountRequestBuilder.java index c37b9a02..094030d0 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAccountRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAccountRequestBuilder.java @@ -19,19 +19,19 @@ public CreateAccountRequestBuilder(SDKMethodInterfaces.MethodCallCreateAccount s this.sdk = sdk; } - public CreateAccountRequestBuilder request(io.codat.sync.expenses.models.operations.CreateAccountRequest request) { + public CreateAccountRequestBuilder request(CreateAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateAccountRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAdjustmentTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAdjustmentTransactionRequestBuilder.java index 6233e466..5409c236 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAdjustmentTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateAdjustmentTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateAdjustmentTransactionRequestBuilder(SDKMethodInterfaces.MethodCallC this.sdk = sdk; } - public CreateAdjustmentTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.CreateAdjustmentTransactionRequest request) { + public CreateAdjustmentTransactionRequestBuilder request(CreateAdjustmentTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateAdjustmentTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateAdjustmentTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateAdjustmentTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateAdjustmentTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateBankAccountRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateBankAccountRequestBuilder.java index 7939a687..b13becb6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateBankAccountRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateBankAccountRequestBuilder.java @@ -19,19 +19,19 @@ public CreateBankAccountRequestBuilder(SDKMethodInterfaces.MethodCallCreateBankA this.sdk = sdk; } - public CreateBankAccountRequestBuilder request(io.codat.sync.expenses.models.operations.CreateBankAccountRequest request) { + public CreateBankAccountRequestBuilder request(CreateBankAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateBankAccountRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateBankAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateBankAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateBankAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCompanyRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCompanyRequestBuilder.java index b18b9b70..070fd7c1 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCompanyRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCompanyRequestBuilder.java @@ -20,25 +20,25 @@ public CreateCompanyRequestBuilder(SDKMethodInterfaces.MethodCallCreateCompany s this.sdk = sdk; } - public CreateCompanyRequestBuilder request(io.codat.sync.expenses.models.components.CompanyRequestBody request) { + public CreateCompanyRequestBuilder request(CompanyRequestBody request) { Utils.checkNotNull(request, "request"); this.request = Optional.of(request); return this; } - public CreateCompanyRequestBuilder request(java.util.Optional request) { + public CreateCompanyRequestBuilder request(Optional request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateCompanyRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateConnectionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateConnectionRequestBuilder.java index 21f15af4..886b96fc 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateConnectionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateConnectionRequestBuilder(SDKMethodInterfaces.MethodCallCreateConnec this.sdk = sdk; } - public CreateConnectionRequestBuilder request(io.codat.sync.expenses.models.operations.CreateConnectionRequest request) { + public CreateConnectionRequestBuilder request(CreateConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateConnectionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCustomerRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCustomerRequestBuilder.java index 8ce4ec4c..b050b248 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCustomerRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateCustomerRequestBuilder.java @@ -19,19 +19,19 @@ public CreateCustomerRequestBuilder(SDKMethodInterfaces.MethodCallCreateCustomer this.sdk = sdk; } - public CreateCustomerRequestBuilder request(io.codat.sync.expenses.models.operations.CreateCustomerRequest request) { + public CreateCustomerRequestBuilder request(CreateCustomerRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateCustomerRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateCustomerRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateCustomerRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateCustomerRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateExpenseTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateExpenseTransactionRequestBuilder.java index f7f9df0e..90287950 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateExpenseTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateExpenseTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateExpenseTransactionRequestBuilder(SDKMethodInterfaces.MethodCallCrea this.sdk = sdk; } - public CreateExpenseTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.CreateExpenseTransactionRequest request) { + public CreateExpenseTransactionRequestBuilder request(CreateExpenseTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateExpenseTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateExpenseTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateExpenseTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateExpenseTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreatePartnerExpenseConnectionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreatePartnerExpenseConnectionRequestBuilder.java index 87cc712d..4c133d04 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreatePartnerExpenseConnectionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreatePartnerExpenseConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public CreatePartnerExpenseConnectionRequestBuilder(SDKMethodInterfaces.MethodCa this.sdk = sdk; } - public CreatePartnerExpenseConnectionRequestBuilder request(io.codat.sync.expenses.models.operations.CreatePartnerExpenseConnectionRequest request) { + public CreatePartnerExpenseConnectionRequestBuilder request(CreatePartnerExpenseConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreatePartnerExpenseConnectionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreatePartnerExpenseConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreatePartnerExpenseConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreatePartnerExpenseConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateReimbursableExpenseTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateReimbursableExpenseTransactionRequestBuilder.java index 5bfce9b9..d59ef288 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateReimbursableExpenseTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateReimbursableExpenseTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateReimbursableExpenseTransactionRequestBuilder(SDKMethodInterfaces.Me this.sdk = sdk; } - public CreateReimbursableExpenseTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.CreateReimbursableExpenseTransactionRequest request) { + public CreateReimbursableExpenseTransactionRequestBuilder request(CreateReimbursableExpenseTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateReimbursableExpenseTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateReimbursableExpenseTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateReimbursableExpenseTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateReimbursableExpenseTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateSupplierRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateSupplierRequestBuilder.java index 0dfc54ff..467cadbe 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateSupplierRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateSupplierRequestBuilder.java @@ -19,19 +19,19 @@ public CreateSupplierRequestBuilder(SDKMethodInterfaces.MethodCallCreateSupplier this.sdk = sdk; } - public CreateSupplierRequestBuilder request(io.codat.sync.expenses.models.operations.CreateSupplierRequest request) { + public CreateSupplierRequestBuilder request(CreateSupplierRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateSupplierRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateSupplierRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateSupplierRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateSupplierRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateTransferTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateTransferTransactionRequestBuilder.java index 3972c9c3..0f4174de 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateTransferTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/CreateTransferTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateTransferTransactionRequestBuilder(SDKMethodInterfaces.MethodCallCre this.sdk = sdk; } - public CreateTransferTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.CreateTransferTransactionRequest request) { + public CreateTransferTransactionRequestBuilder request(CreateTransferTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateTransferTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public CreateTransferTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateTransferTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateTransferTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteCompanyRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteCompanyRequestBuilder.java index 9fc803c9..d12d9ebd 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteCompanyRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteCompanyRequestBuilder(SDKMethodInterfaces.MethodCallDeleteCompany s this.sdk = sdk; } - public DeleteCompanyRequestBuilder request(io.codat.sync.expenses.models.operations.DeleteCompanyRequest request) { + public DeleteCompanyRequestBuilder request(DeleteCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteCompanyRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public DeleteCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteConnectionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteConnectionRequestBuilder.java index 893877e5..95ff9982 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteConnectionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/DeleteConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteConnectionRequestBuilder(SDKMethodInterfaces.MethodCallDeleteConnec this.sdk = sdk; } - public DeleteConnectionRequestBuilder request(io.codat.sync.expenses.models.operations.DeleteConnectionRequest request) { + public DeleteConnectionRequestBuilder request(DeleteConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteConnectionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public DeleteConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequestBuilder.java index fb80f88a..0dcc6668 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyConfigurationRequestBuilder.java @@ -19,19 +19,19 @@ public GetCompanyConfigurationRequestBuilder(SDKMethodInterfaces.MethodCallGetCo this.sdk = sdk; } - public GetCompanyConfigurationRequestBuilder request(io.codat.sync.expenses.models.operations.GetCompanyConfigurationRequest request) { + public GetCompanyConfigurationRequestBuilder request(GetCompanyConfigurationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCompanyConfigurationRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetCompanyConfigurationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCompanyConfigurationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCompanyConfigurationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequest.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequest.java new file mode 100644 index 00000000..4ce73dbe --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequest.java @@ -0,0 +1,101 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.operations; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import io.codat.sync.expenses.utils.SpeakeasyMetadata; +import io.codat.sync.expenses.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.util.Objects; + + +public class GetCompanyInfoRequest { + + /** + * Unique identifier for a company. + */ + @SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId") + private String companyId; + + @JsonCreator + public GetCompanyInfoRequest( + String companyId) { + Utils.checkNotNull(companyId, "companyId"); + this.companyId = companyId; + } + + /** + * Unique identifier for a company. + */ + @JsonIgnore + public String companyId() { + return companyId; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Unique identifier for a company. + */ + public GetCompanyInfoRequest withCompanyId(String companyId) { + Utils.checkNotNull(companyId, "companyId"); + this.companyId = companyId; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GetCompanyInfoRequest other = (GetCompanyInfoRequest) o; + return + Objects.deepEquals(this.companyId, other.companyId); + } + + @Override + public int hashCode() { + return Objects.hash( + companyId); + } + + @Override + public String toString() { + return Utils.toString(GetCompanyInfoRequest.class, + "companyId", companyId); + } + + public final static class Builder { + + private String companyId; + + private Builder() { + // force use of static builder() method + } + + /** + * Unique identifier for a company. + */ + public Builder companyId(String companyId) { + Utils.checkNotNull(companyId, "companyId"); + this.companyId = companyId; + return this; + } + + public GetCompanyInfoRequest build() { + return new GetCompanyInfoRequest( + companyId); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequestBuilder.java new file mode 100644 index 00000000..cbe1ff7a --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoRequestBuilder.java @@ -0,0 +1,48 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.operations; + +import io.codat.sync.expenses.utils.Options; +import io.codat.sync.expenses.utils.RetryConfig; +import io.codat.sync.expenses.utils.Utils; +import java.util.Optional; + +public class GetCompanyInfoRequestBuilder { + + private GetCompanyInfoRequest request; + private Optional retryConfig = Optional.empty(); + private final SDKMethodInterfaces.MethodCallGetCompanyInfo sdk; + + public GetCompanyInfoRequestBuilder(SDKMethodInterfaces.MethodCallGetCompanyInfo sdk) { + this.sdk = sdk; + } + + public GetCompanyInfoRequestBuilder request(GetCompanyInfoRequest request) { + Utils.checkNotNull(request, "request"); + this.request = request; + return this; + } + + public GetCompanyInfoRequestBuilder retryConfig(RetryConfig retryConfig) { + Utils.checkNotNull(retryConfig, "retryConfig"); + this.retryConfig = Optional.of(retryConfig); + return this; + } + + public GetCompanyInfoRequestBuilder retryConfig(Optional retryConfig) { + Utils.checkNotNull(retryConfig, "retryConfig"); + this.retryConfig = retryConfig; + return this; + } + + public GetCompanyInfoResponse call() throws Exception { + Optional options = Optional.of(Options.builder() + .retryConfig(retryConfig) + .build()); + return sdk.get( + request, + options); + } +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoResponse.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoResponse.java new file mode 100644 index 00000000..846e4d35 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyInfoResponse.java @@ -0,0 +1,252 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.operations; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import io.codat.sync.expenses.models.components.CompanyInformation; +import io.codat.sync.expenses.utils.Response; +import io.codat.sync.expenses.utils.Utils; +import java.io.InputStream; +import java.lang.Integer; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.net.http.HttpResponse; +import java.util.Objects; +import java.util.Optional; + + +public class GetCompanyInfoResponse implements Response { + + /** + * Success + */ + private Optional companyInformation; + + /** + * HTTP response content type for this operation + */ + private String contentType; + + /** + * HTTP response status code for this operation + */ + private int statusCode; + + /** + * Raw HTTP response; suitable for custom response parsing + */ + private HttpResponse rawResponse; + + @JsonCreator + public GetCompanyInfoResponse( + Optional companyInformation, + String contentType, + int statusCode, + HttpResponse rawResponse) { + Utils.checkNotNull(companyInformation, "companyInformation"); + Utils.checkNotNull(contentType, "contentType"); + Utils.checkNotNull(statusCode, "statusCode"); + Utils.checkNotNull(rawResponse, "rawResponse"); + this.companyInformation = companyInformation; + this.contentType = contentType; + this.statusCode = statusCode; + this.rawResponse = rawResponse; + } + + public GetCompanyInfoResponse( + String contentType, + int statusCode, + HttpResponse rawResponse) { + this(Optional.empty(), contentType, statusCode, rawResponse); + } + + /** + * Success + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional companyInformation() { + return (Optional) companyInformation; + } + + /** + * HTTP response content type for this operation + */ + @JsonIgnore + public String contentType() { + return contentType; + } + + /** + * HTTP response status code for this operation + */ + @JsonIgnore + public int statusCode() { + return statusCode; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + @JsonIgnore + public HttpResponse rawResponse() { + return rawResponse; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Success + */ + public GetCompanyInfoResponse withCompanyInformation(CompanyInformation companyInformation) { + Utils.checkNotNull(companyInformation, "companyInformation"); + this.companyInformation = Optional.ofNullable(companyInformation); + return this; + } + + /** + * Success + */ + public GetCompanyInfoResponse withCompanyInformation(Optional companyInformation) { + Utils.checkNotNull(companyInformation, "companyInformation"); + this.companyInformation = companyInformation; + return this; + } + + /** + * HTTP response content type for this operation + */ + public GetCompanyInfoResponse withContentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public GetCompanyInfoResponse withStatusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public GetCompanyInfoResponse withRawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GetCompanyInfoResponse other = (GetCompanyInfoResponse) o; + return + Objects.deepEquals(this.companyInformation, other.companyInformation) && + Objects.deepEquals(this.contentType, other.contentType) && + Objects.deepEquals(this.statusCode, other.statusCode) && + Objects.deepEquals(this.rawResponse, other.rawResponse); + } + + @Override + public int hashCode() { + return Objects.hash( + companyInformation, + contentType, + statusCode, + rawResponse); + } + + @Override + public String toString() { + return Utils.toString(GetCompanyInfoResponse.class, + "companyInformation", companyInformation, + "contentType", contentType, + "statusCode", statusCode, + "rawResponse", rawResponse); + } + + public final static class Builder { + + private Optional companyInformation = Optional.empty(); + + private String contentType; + + private Integer statusCode; + + private HttpResponse rawResponse; + + private Builder() { + // force use of static builder() method + } + + /** + * Success + */ + public Builder companyInformation(CompanyInformation companyInformation) { + Utils.checkNotNull(companyInformation, "companyInformation"); + this.companyInformation = Optional.ofNullable(companyInformation); + return this; + } + + /** + * Success + */ + public Builder companyInformation(Optional companyInformation) { + Utils.checkNotNull(companyInformation, "companyInformation"); + this.companyInformation = companyInformation; + return this; + } + + /** + * HTTP response content type for this operation + */ + public Builder contentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public Builder statusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public Builder rawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + public GetCompanyInfoResponse build() { + return new GetCompanyInfoResponse( + companyInformation, + contentType, + statusCode, + rawResponse); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequestBuilder.java index eb61a5ae..fc357b7f 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public GetCompanyRequestBuilder(SDKMethodInterfaces.MethodCallGetCompany sdk) { this.sdk = sdk; } - public GetCompanyRequestBuilder request(io.codat.sync.expenses.models.operations.GetCompanyRequest request) { + public GetCompanyRequestBuilder request(GetCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCompanyRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetConnectionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetConnectionRequestBuilder.java index f18e9b5e..0d28d121 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetConnectionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public GetConnectionRequestBuilder(SDKMethodInterfaces.MethodCallGetConnection s this.sdk = sdk; } - public GetConnectionRequestBuilder request(io.codat.sync.expenses.models.operations.GetConnectionRequest request) { + public GetConnectionRequestBuilder request(GetConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetConnectionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateBankAccountsModelRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateBankAccountsModelRequestBuilder.java index ec2970a6..1ad5c693 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateBankAccountsModelRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateBankAccountsModelRequestBuilder.java @@ -19,19 +19,19 @@ public GetCreateBankAccountsModelRequestBuilder(SDKMethodInterfaces.MethodCallGe this.sdk = sdk; } - public GetCreateBankAccountsModelRequestBuilder request(io.codat.sync.expenses.models.operations.GetCreateBankAccountsModelRequest request) { + public GetCreateBankAccountsModelRequestBuilder request(GetCreateBankAccountsModelRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCreateBankAccountsModelRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetCreateBankAccountsModelRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCreateBankAccountsModelRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCreateBankAccountsModelRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateChartOfAccountsModelRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateChartOfAccountsModelRequestBuilder.java index 56f0f91e..b01c169b 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateChartOfAccountsModelRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCreateChartOfAccountsModelRequestBuilder.java @@ -19,19 +19,19 @@ public GetCreateChartOfAccountsModelRequestBuilder(SDKMethodInterfaces.MethodCal this.sdk = sdk; } - public GetCreateChartOfAccountsModelRequestBuilder request(io.codat.sync.expenses.models.operations.GetCreateChartOfAccountsModelRequest request) { + public GetCreateChartOfAccountsModelRequestBuilder request(GetCreateChartOfAccountsModelRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCreateChartOfAccountsModelRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetCreateChartOfAccountsModelRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCreateChartOfAccountsModelRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCreateChartOfAccountsModelRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCustomerRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCustomerRequestBuilder.java index ac4c1ab0..30f81e0d 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCustomerRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetCustomerRequestBuilder.java @@ -19,19 +19,19 @@ public GetCustomerRequestBuilder(SDKMethodInterfaces.MethodCallGetCustomer sdk) this.sdk = sdk; } - public GetCustomerRequestBuilder request(io.codat.sync.expenses.models.operations.GetCustomerRequest request) { + public GetCustomerRequestBuilder request(GetCustomerRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCustomerRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetCustomerRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCustomerRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCustomerRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetDataStatusRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetDataStatusRequestBuilder.java index d4f271f7..25b3cd1d 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetDataStatusRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetDataStatusRequestBuilder.java @@ -19,19 +19,19 @@ public GetDataStatusRequestBuilder(SDKMethodInterfaces.MethodCallGetDataStatus s this.sdk = sdk; } - public GetDataStatusRequestBuilder request(io.codat.sync.expenses.models.operations.GetDataStatusRequest request) { + public GetDataStatusRequestBuilder request(GetDataStatusRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetDataStatusRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetDataStatusRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetDataStatusRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetDataStatusRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLastSuccessfulSyncRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLastSuccessfulSyncRequestBuilder.java index 01a126f4..f7e8b168 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLastSuccessfulSyncRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLastSuccessfulSyncRequestBuilder.java @@ -19,19 +19,19 @@ public GetLastSuccessfulSyncRequestBuilder(SDKMethodInterfaces.MethodCallGetLast this.sdk = sdk; } - public GetLastSuccessfulSyncRequestBuilder request(io.codat.sync.expenses.models.operations.GetLastSuccessfulSyncRequest request) { + public GetLastSuccessfulSyncRequestBuilder request(GetLastSuccessfulSyncRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetLastSuccessfulSyncRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetLastSuccessfulSyncRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetLastSuccessfulSyncRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetLastSuccessfulSyncRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLatestSyncRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLatestSyncRequestBuilder.java index fc54d5d3..5eb502a6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLatestSyncRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetLatestSyncRequestBuilder.java @@ -19,19 +19,19 @@ public GetLatestSyncRequestBuilder(SDKMethodInterfaces.MethodCallGetLatestSync s this.sdk = sdk; } - public GetLatestSyncRequestBuilder request(io.codat.sync.expenses.models.operations.GetLatestSyncRequest request) { + public GetLatestSyncRequestBuilder request(GetLatestSyncRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetLatestSyncRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetLatestSyncRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetLatestSyncRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetLatestSyncRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetMappingOptionsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetMappingOptionsRequestBuilder.java index c973baf2..74ec9cd2 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetMappingOptionsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetMappingOptionsRequestBuilder.java @@ -19,19 +19,19 @@ public GetMappingOptionsRequestBuilder(SDKMethodInterfaces.MethodCallGetMappingO this.sdk = sdk; } - public GetMappingOptionsRequestBuilder request(io.codat.sync.expenses.models.operations.GetMappingOptionsRequest request) { + public GetMappingOptionsRequestBuilder request(GetMappingOptionsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetMappingOptionsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetMappingOptionsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetMappingOptionsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetMappingOptionsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPullOperationRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPullOperationRequestBuilder.java index 6a323da1..55d0858a 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPullOperationRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPullOperationRequestBuilder.java @@ -19,19 +19,19 @@ public GetPullOperationRequestBuilder(SDKMethodInterfaces.MethodCallGetPullOpera this.sdk = sdk; } - public GetPullOperationRequestBuilder request(io.codat.sync.expenses.models.operations.GetPullOperationRequest request) { + public GetPullOperationRequestBuilder request(GetPullOperationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetPullOperationRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetPullOperationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetPullOperationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetPullOperationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPushOperationRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPushOperationRequestBuilder.java index cdf20cc1..a45cbc11 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPushOperationRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetPushOperationRequestBuilder.java @@ -19,19 +19,19 @@ public GetPushOperationRequestBuilder(SDKMethodInterfaces.MethodCallGetPushOpera this.sdk = sdk; } - public GetPushOperationRequestBuilder request(io.codat.sync.expenses.models.operations.GetPushOperationRequest request) { + public GetPushOperationRequestBuilder request(GetPushOperationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetPushOperationRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetPushOperationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetPushOperationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetPushOperationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSupplierRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSupplierRequestBuilder.java index a26d7365..b7a6d17f 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSupplierRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSupplierRequestBuilder.java @@ -19,19 +19,19 @@ public GetSupplierRequestBuilder(SDKMethodInterfaces.MethodCallGetSupplier sdk) this.sdk = sdk; } - public GetSupplierRequestBuilder request(io.codat.sync.expenses.models.operations.GetSupplierRequest request) { + public GetSupplierRequestBuilder request(GetSupplierRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetSupplierRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetSupplierRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetSupplierRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetSupplierRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncByIdRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncByIdRequestBuilder.java index 99113ebc..1b2508c4 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncByIdRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncByIdRequestBuilder.java @@ -19,19 +19,19 @@ public GetSyncByIdRequestBuilder(SDKMethodInterfaces.MethodCallGetSyncById sdk) this.sdk = sdk; } - public GetSyncByIdRequestBuilder request(io.codat.sync.expenses.models.operations.GetSyncByIdRequest request) { + public GetSyncByIdRequestBuilder request(GetSyncByIdRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetSyncByIdRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetSyncByIdRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetSyncByIdRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetSyncByIdRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionRequestBuilder.java index 388026ef..771e34d5 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public GetSyncTransactionRequestBuilder(SDKMethodInterfaces.MethodCallGetSyncTra this.sdk = sdk; } - public GetSyncTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.GetSyncTransactionRequest request) { + public GetSyncTransactionRequestBuilder request(GetSyncTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetSyncTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public GetSyncTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetSyncTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetSyncTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionResponse.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionResponse.java index fafe66ed..179218a9 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionResponse.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/GetSyncTransactionResponse.java @@ -7,7 +7,7 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnore; -import io.codat.sync.expenses.models.components.Transaction; +import io.codat.sync.expenses.models.components.SchemaTransaction; import io.codat.sync.expenses.utils.Response; import io.codat.sync.expenses.utils.Utils; import java.io.InputStream; @@ -41,14 +41,14 @@ public class GetSyncTransactionResponse implements Response { /** * Success */ - private Optional> transactionResponse; + private Optional> transactionResponse; @JsonCreator public GetSyncTransactionResponse( String contentType, int statusCode, HttpResponse rawResponse, - Optional> transactionResponse) { + Optional> transactionResponse) { Utils.checkNotNull(contentType, "contentType"); Utils.checkNotNull(statusCode, "statusCode"); Utils.checkNotNull(rawResponse, "rawResponse"); @@ -95,8 +95,8 @@ public HttpResponse rawResponse() { */ @SuppressWarnings("unchecked") @JsonIgnore - public Optional> transactionResponse() { - return (Optional>) transactionResponse; + public Optional> transactionResponse() { + return (Optional>) transactionResponse; } public final static Builder builder() { @@ -133,7 +133,7 @@ public GetSyncTransactionResponse withRawResponse(HttpResponse rawR /** * Success */ - public GetSyncTransactionResponse withTransactionResponse(List transactionResponse) { + public GetSyncTransactionResponse withTransactionResponse(List transactionResponse) { Utils.checkNotNull(transactionResponse, "transactionResponse"); this.transactionResponse = Optional.ofNullable(transactionResponse); return this; @@ -142,7 +142,7 @@ public GetSyncTransactionResponse withTransactionResponse(List tran /** * Success */ - public GetSyncTransactionResponse withTransactionResponse(Optional> transactionResponse) { + public GetSyncTransactionResponse withTransactionResponse(Optional> transactionResponse) { Utils.checkNotNull(transactionResponse, "transactionResponse"); this.transactionResponse = transactionResponse; return this; @@ -190,7 +190,7 @@ public final static class Builder { private HttpResponse rawResponse; - private Optional> transactionResponse = Optional.empty(); + private Optional> transactionResponse = Optional.empty(); private Builder() { // force use of static builder() method @@ -226,7 +226,7 @@ public Builder rawResponse(HttpResponse rawResponse) { /** * Success */ - public Builder transactionResponse(List transactionResponse) { + public Builder transactionResponse(List transactionResponse) { Utils.checkNotNull(transactionResponse, "transactionResponse"); this.transactionResponse = Optional.ofNullable(transactionResponse); return this; @@ -235,7 +235,7 @@ public Builder transactionResponse(List transactionResponse) { /** * Success */ - public Builder transactionResponse(Optional> transactionResponse) { + public Builder transactionResponse(Optional> transactionResponse) { Utils.checkNotNull(transactionResponse, "transactionResponse"); this.transactionResponse = transactionResponse; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCompaniesRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCompaniesRequestBuilder.java index 7ede5525..58acf896 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCompaniesRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCompaniesRequestBuilder.java @@ -19,19 +19,19 @@ public ListCompaniesRequestBuilder(SDKMethodInterfaces.MethodCallListCompanies s this.sdk = sdk; } - public ListCompaniesRequestBuilder request(io.codat.sync.expenses.models.operations.ListCompaniesRequest request) { + public ListCompaniesRequestBuilder request(ListCompaniesRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListCompaniesRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListCompaniesRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListCompaniesRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListCompaniesRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListConnectionsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListConnectionsRequestBuilder.java index d1f699fb..16d97a32 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListConnectionsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListConnectionsRequestBuilder.java @@ -19,19 +19,19 @@ public ListConnectionsRequestBuilder(SDKMethodInterfaces.MethodCallListConnectio this.sdk = sdk; } - public ListConnectionsRequestBuilder request(io.codat.sync.expenses.models.operations.ListConnectionsRequest request) { + public ListConnectionsRequestBuilder request(ListConnectionsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListConnectionsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListConnectionsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListConnectionsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListConnectionsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCustomersRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCustomersRequestBuilder.java index 272950e7..d9ff4443 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCustomersRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListCustomersRequestBuilder.java @@ -19,19 +19,19 @@ public ListCustomersRequestBuilder(SDKMethodInterfaces.MethodCallListCustomers s this.sdk = sdk; } - public ListCustomersRequestBuilder request(io.codat.sync.expenses.models.operations.ListCustomersRequest request) { + public ListCustomersRequestBuilder request(ListCustomersRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListCustomersRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListCustomersRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListCustomersRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListCustomersRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPullOperationsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPullOperationsRequestBuilder.java index 6ffb72f1..fe0fd876 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPullOperationsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPullOperationsRequestBuilder.java @@ -19,19 +19,19 @@ public ListPullOperationsRequestBuilder(SDKMethodInterfaces.MethodCallListPullOp this.sdk = sdk; } - public ListPullOperationsRequestBuilder request(io.codat.sync.expenses.models.operations.ListPullOperationsRequest request) { + public ListPullOperationsRequestBuilder request(ListPullOperationsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListPullOperationsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListPullOperationsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListPullOperationsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListPullOperationsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPushOperationsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPushOperationsRequestBuilder.java index 429a8e1f..be4df401 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPushOperationsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListPushOperationsRequestBuilder.java @@ -19,19 +19,19 @@ public ListPushOperationsRequestBuilder(SDKMethodInterfaces.MethodCallListPushOp this.sdk = sdk; } - public ListPushOperationsRequestBuilder request(io.codat.sync.expenses.models.operations.ListPushOperationsRequest request) { + public ListPushOperationsRequestBuilder request(ListPushOperationsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListPushOperationsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListPushOperationsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListPushOperationsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListPushOperationsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSuppliersRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSuppliersRequestBuilder.java index 2c54e5ed..353f59b6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSuppliersRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSuppliersRequestBuilder.java @@ -19,19 +19,19 @@ public ListSuppliersRequestBuilder(SDKMethodInterfaces.MethodCallListSuppliers s this.sdk = sdk; } - public ListSuppliersRequestBuilder request(io.codat.sync.expenses.models.operations.ListSuppliersRequest request) { + public ListSuppliersRequestBuilder request(ListSuppliersRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListSuppliersRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListSuppliersRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListSuppliersRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListSuppliersRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncTransactionsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncTransactionsRequestBuilder.java index bac38703..65d8e427 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncTransactionsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncTransactionsRequestBuilder.java @@ -19,19 +19,19 @@ public ListSyncTransactionsRequestBuilder(SDKMethodInterfaces.MethodCallListSync this.sdk = sdk; } - public ListSyncTransactionsRequestBuilder request(io.codat.sync.expenses.models.operations.ListSyncTransactionsRequest request) { + public ListSyncTransactionsRequestBuilder request(ListSyncTransactionsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListSyncTransactionsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListSyncTransactionsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListSyncTransactionsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListSyncTransactionsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncsRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncsRequestBuilder.java index cf93a8dc..11cd0d4d 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncsRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/ListSyncsRequestBuilder.java @@ -19,19 +19,19 @@ public ListSyncsRequestBuilder(SDKMethodInterfaces.MethodCallListSyncs sdk) { this.sdk = sdk; } - public ListSyncsRequestBuilder request(io.codat.sync.expenses.models.operations.ListSyncsRequest request) { + public ListSyncsRequestBuilder request(ListSyncsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListSyncsRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public ListSyncsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListSyncsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListSyncsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshAllDataTypesRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshAllDataTypesRequestBuilder.java index be2805a7..ee347a86 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshAllDataTypesRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshAllDataTypesRequestBuilder.java @@ -19,19 +19,19 @@ public RefreshAllDataTypesRequestBuilder(SDKMethodInterfaces.MethodCallRefreshAl this.sdk = sdk; } - public RefreshAllDataTypesRequestBuilder request(io.codat.sync.expenses.models.operations.RefreshAllDataTypesRequest request) { + public RefreshAllDataTypesRequestBuilder request(RefreshAllDataTypesRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public RefreshAllDataTypesRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public RefreshAllDataTypesRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public RefreshAllDataTypesRequestBuilder retryConfig(java.util.Optional retryConfig) { + public RefreshAllDataTypesRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshDataTypeRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshDataTypeRequestBuilder.java index a30679fe..5c41a57e 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshDataTypeRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/RefreshDataTypeRequestBuilder.java @@ -19,19 +19,19 @@ public RefreshDataTypeRequestBuilder(SDKMethodInterfaces.MethodCallRefreshDataTy this.sdk = sdk; } - public RefreshDataTypeRequestBuilder request(io.codat.sync.expenses.models.operations.RefreshDataTypeRequest request) { + public RefreshDataTypeRequestBuilder request(RefreshDataTypeRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public RefreshDataTypeRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public RefreshDataTypeRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public RefreshDataTypeRequestBuilder retryConfig(java.util.Optional retryConfig) { + public RefreshDataTypeRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SDKMethodInterfaces.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SDKMethodInterfaces.java index 39ec607f..3ea541e4 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SDKMethodInterfaces.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SDKMethodInterfaces.java @@ -6,328 +6,336 @@ import io.codat.sync.expenses.models.components.CompanyRequestBody; import io.codat.sync.expenses.utils.Options; +import java.lang.Exception; import java.util.Optional; public class SDKMethodInterfaces { public interface MethodCallCreateCompany { - io.codat.sync.expenses.models.operations.CreateCompanyResponse create( + CreateCompanyResponse create( Optional request, Optional options) throws Exception; } public interface MethodCallDeleteCompany { - io.codat.sync.expenses.models.operations.DeleteCompanyResponse delete( + DeleteCompanyResponse delete( DeleteCompanyRequest request, Optional options) throws Exception; } public interface MethodCallGetCompany { - io.codat.sync.expenses.models.operations.GetCompanyResponse get( + GetCompanyResponse get( GetCompanyRequest request, Optional options) throws Exception; } public interface MethodCallListCompanies { - io.codat.sync.expenses.models.operations.ListCompaniesResponse list( + ListCompaniesResponse list( ListCompaniesRequest request, Optional options) throws Exception; } public interface MethodCallUpdateCompany { - io.codat.sync.expenses.models.operations.UpdateCompanyResponse update( + UpdateCompanyResponse update( UpdateCompanyRequest request, Optional options) throws Exception; } public interface MethodCallCreateConnection { - io.codat.sync.expenses.models.operations.CreateConnectionResponse create( + CreateConnectionResponse create( CreateConnectionRequest request, Optional options) throws Exception; } public interface MethodCallCreatePartnerExpenseConnection { - io.codat.sync.expenses.models.operations.CreatePartnerExpenseConnectionResponse createPartnerExpenseConnection( + CreatePartnerExpenseConnectionResponse createPartnerExpenseConnection( CreatePartnerExpenseConnectionRequest request, Optional options) throws Exception; } public interface MethodCallDeleteConnection { - io.codat.sync.expenses.models.operations.DeleteConnectionResponse delete( + DeleteConnectionResponse delete( DeleteConnectionRequest request, Optional options) throws Exception; } public interface MethodCallGetConnection { - io.codat.sync.expenses.models.operations.GetConnectionResponse get( + GetConnectionResponse get( GetConnectionRequest request, Optional options) throws Exception; } public interface MethodCallListConnections { - io.codat.sync.expenses.models.operations.ListConnectionsResponse list( + ListConnectionsResponse list( ListConnectionsRequest request, Optional options) throws Exception; } public interface MethodCallUnlinkConnection { - io.codat.sync.expenses.models.operations.UnlinkConnectionResponse unlink( + UnlinkConnectionResponse unlink( UnlinkConnectionRequest request, Optional options) throws Exception; } public interface MethodCallCreateBankAccount { - io.codat.sync.expenses.models.operations.CreateBankAccountResponse create( + CreateBankAccountResponse create( CreateBankAccountRequest request, Optional options) throws Exception; } public interface MethodCallGetCreateBankAccountsModel { - io.codat.sync.expenses.models.operations.GetCreateBankAccountsModelResponse getCreateModel( + GetCreateBankAccountsModelResponse getCreateModel( GetCreateBankAccountsModelRequest request, Optional options) throws Exception; } public interface MethodCallCreateAccount { - io.codat.sync.expenses.models.operations.CreateAccountResponse create( + CreateAccountResponse create( CreateAccountRequest request, Optional options) throws Exception; } public interface MethodCallGetCreateChartOfAccountsModel { - io.codat.sync.expenses.models.operations.GetCreateChartOfAccountsModelResponse getCreateModel( + GetCreateChartOfAccountsModelResponse getCreateModel( GetCreateChartOfAccountsModelRequest request, Optional options) throws Exception; } public interface MethodCallCreateCustomer { - io.codat.sync.expenses.models.operations.CreateCustomerResponse create( + CreateCustomerResponse create( CreateCustomerRequest request, Optional options) throws Exception; } public interface MethodCallGetCustomer { - io.codat.sync.expenses.models.operations.GetCustomerResponse get( + GetCustomerResponse get( GetCustomerRequest request, Optional options) throws Exception; } public interface MethodCallListCustomers { - io.codat.sync.expenses.models.operations.ListCustomersResponse list( + ListCustomersResponse list( ListCustomersRequest request, Optional options) throws Exception; } public interface MethodCallUpdateCustomer { - io.codat.sync.expenses.models.operations.UpdateCustomerResponse update( + UpdateCustomerResponse update( UpdateCustomerRequest request, Optional options) throws Exception; } public interface MethodCallCreateSupplier { - io.codat.sync.expenses.models.operations.CreateSupplierResponse create( + CreateSupplierResponse create( CreateSupplierRequest request, Optional options) throws Exception; } public interface MethodCallGetSupplier { - io.codat.sync.expenses.models.operations.GetSupplierResponse get( + GetSupplierResponse get( GetSupplierRequest request, Optional options) throws Exception; } public interface MethodCallListSuppliers { - io.codat.sync.expenses.models.operations.ListSuppliersResponse list( + ListSuppliersResponse list( ListSuppliersRequest request, Optional options) throws Exception; } public interface MethodCallUpdateSupplier { - io.codat.sync.expenses.models.operations.UpdateSupplierResponse update( + UpdateSupplierResponse update( UpdateSupplierRequest request, Optional options) throws Exception; } public interface MethodCallGetDataStatus { - io.codat.sync.expenses.models.operations.GetDataStatusResponse get( + GetDataStatusResponse get( GetDataStatusRequest request, Optional options) throws Exception; } public interface MethodCallGetPullOperation { - io.codat.sync.expenses.models.operations.GetPullOperationResponse getPullOperation( + GetPullOperationResponse getPullOperation( GetPullOperationRequest request, Optional options) throws Exception; } public interface MethodCallListPullOperations { - io.codat.sync.expenses.models.operations.ListPullOperationsResponse listPullOperations( + ListPullOperationsResponse listPullOperations( ListPullOperationsRequest request, Optional options) throws Exception; } public interface MethodCallRefreshAllDataTypes { - io.codat.sync.expenses.models.operations.RefreshAllDataTypesResponse refreshAllDataTypes( + RefreshAllDataTypesResponse refreshAllDataTypes( RefreshAllDataTypesRequest request, Optional options) throws Exception; } public interface MethodCallRefreshDataType { - io.codat.sync.expenses.models.operations.RefreshDataTypeResponse refreshDataType( + RefreshDataTypeResponse refreshDataType( RefreshDataTypeRequest request, Optional options) throws Exception; } + public interface MethodCallGetCompanyInfo { + GetCompanyInfoResponse get( + GetCompanyInfoRequest request, + Optional options) throws Exception; + } + + public interface MethodCallGetPushOperation { - io.codat.sync.expenses.models.operations.GetPushOperationResponse get( + GetPushOperationResponse get( GetPushOperationRequest request, Optional options) throws Exception; } public interface MethodCallListPushOperations { - io.codat.sync.expenses.models.operations.ListPushOperationsResponse list( + ListPushOperationsResponse list( ListPushOperationsRequest request, Optional options) throws Exception; } public interface MethodCallCreateAdjustmentTransaction { - io.codat.sync.expenses.models.operations.CreateAdjustmentTransactionResponse create( + CreateAdjustmentTransactionResponse create( CreateAdjustmentTransactionRequest request, Optional options) throws Exception; } public interface MethodCallGetCompanyConfiguration { - io.codat.sync.expenses.models.operations.GetCompanyConfigurationResponse get( + GetCompanyConfigurationResponse get( GetCompanyConfigurationRequest request, Optional options) throws Exception; } public interface MethodCallSetCompanyConfiguration { - io.codat.sync.expenses.models.operations.SetCompanyConfigurationResponse set( + SetCompanyConfigurationResponse set( SetCompanyConfigurationRequest request, Optional options) throws Exception; } public interface MethodCallCreateExpenseTransaction { - io.codat.sync.expenses.models.operations.CreateExpenseTransactionResponse create( + CreateExpenseTransactionResponse create( CreateExpenseTransactionRequest request, Optional options) throws Exception; } public interface MethodCallUpdateExpenseTransaction { - io.codat.sync.expenses.models.operations.UpdateExpenseTransactionResponse update( + UpdateExpenseTransactionResponse update( UpdateExpenseTransactionRequest request, Optional options) throws Exception; } public interface MethodCallGetMappingOptions { - io.codat.sync.expenses.models.operations.GetMappingOptionsResponse getMappingOptions( + GetMappingOptionsResponse getMappingOptions( GetMappingOptionsRequest request, Optional options) throws Exception; } public interface MethodCallCreateReimbursableExpenseTransaction { - io.codat.sync.expenses.models.operations.CreateReimbursableExpenseTransactionResponse create( + CreateReimbursableExpenseTransactionResponse create( CreateReimbursableExpenseTransactionRequest request, Optional options) throws Exception; } public interface MethodCallUpdateReimbursableExpenseTransaction { - io.codat.sync.expenses.models.operations.UpdateReimbursableExpenseTransactionResponse update( + UpdateReimbursableExpenseTransactionResponse update( UpdateReimbursableExpenseTransactionRequest request, Optional options) throws Exception; } public interface MethodCallGetSyncById { - io.codat.sync.expenses.models.operations.GetSyncByIdResponse get( + GetSyncByIdResponse get( GetSyncByIdRequest request, Optional options) throws Exception; } public interface MethodCallGetLastSuccessfulSync { - io.codat.sync.expenses.models.operations.GetLastSuccessfulSyncResponse getLastSuccessfulSync( + GetLastSuccessfulSyncResponse getLastSuccessfulSync( GetLastSuccessfulSyncRequest request, Optional options) throws Exception; } public interface MethodCallGetLatestSync { - io.codat.sync.expenses.models.operations.GetLatestSyncResponse getLatestSync( + GetLatestSyncResponse getLatestSync( GetLatestSyncRequest request, Optional options) throws Exception; } public interface MethodCallListSyncs { - io.codat.sync.expenses.models.operations.ListSyncsResponse list( + ListSyncsResponse list( ListSyncsRequest request, Optional options) throws Exception; } public interface MethodCallGetSyncTransaction { - io.codat.sync.expenses.models.operations.GetSyncTransactionResponse get( + GetSyncTransactionResponse get( GetSyncTransactionRequest request, Optional options) throws Exception; } public interface MethodCallListSyncTransactions { - io.codat.sync.expenses.models.operations.ListSyncTransactionsResponse list( + ListSyncTransactionsResponse list( ListSyncTransactionsRequest request, Optional options) throws Exception; } public interface MethodCallUploadExpenseAttachment { - io.codat.sync.expenses.models.operations.UploadExpenseAttachmentResponse upload( + UploadExpenseAttachmentResponse upload( UploadExpenseAttachmentRequest request, Optional options) throws Exception; } public interface MethodCallCreateTransferTransaction { - io.codat.sync.expenses.models.operations.CreateTransferTransactionResponse create( + CreateTransferTransactionResponse create( CreateTransferTransactionRequest request, Optional options) throws Exception; } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SetCompanyConfigurationRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SetCompanyConfigurationRequestBuilder.java index 5da8fe7a..97d3731f 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SetCompanyConfigurationRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/SetCompanyConfigurationRequestBuilder.java @@ -19,19 +19,19 @@ public SetCompanyConfigurationRequestBuilder(SDKMethodInterfaces.MethodCallSetCo this.sdk = sdk; } - public SetCompanyConfigurationRequestBuilder request(io.codat.sync.expenses.models.operations.SetCompanyConfigurationRequest request) { + public SetCompanyConfigurationRequestBuilder request(SetCompanyConfigurationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public SetCompanyConfigurationRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public SetCompanyConfigurationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public SetCompanyConfigurationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public SetCompanyConfigurationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UnlinkConnectionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UnlinkConnectionRequestBuilder.java index 698589ef..2a446441 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UnlinkConnectionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UnlinkConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public UnlinkConnectionRequestBuilder(SDKMethodInterfaces.MethodCallUnlinkConnec this.sdk = sdk; } - public UnlinkConnectionRequestBuilder request(io.codat.sync.expenses.models.operations.UnlinkConnectionRequest request) { + public UnlinkConnectionRequestBuilder request(UnlinkConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UnlinkConnectionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UnlinkConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UnlinkConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UnlinkConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCompanyRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCompanyRequestBuilder.java index 000ffa83..3bbeb078 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCompanyRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateCompanyRequestBuilder(SDKMethodInterfaces.MethodCallUpdateCompany s this.sdk = sdk; } - public UpdateCompanyRequestBuilder request(io.codat.sync.expenses.models.operations.UpdateCompanyRequest request) { + public UpdateCompanyRequestBuilder request(UpdateCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateCompanyRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UpdateCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCustomerRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCustomerRequestBuilder.java index feaab952..ab2e79b9 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCustomerRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateCustomerRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateCustomerRequestBuilder(SDKMethodInterfaces.MethodCallUpdateCustomer this.sdk = sdk; } - public UpdateCustomerRequestBuilder request(io.codat.sync.expenses.models.operations.UpdateCustomerRequest request) { + public UpdateCustomerRequestBuilder request(UpdateCustomerRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateCustomerRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UpdateCustomerRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateCustomerRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateCustomerRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateExpenseTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateExpenseTransactionRequestBuilder.java index b16c7337..c9861012 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateExpenseTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateExpenseTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateExpenseTransactionRequestBuilder(SDKMethodInterfaces.MethodCallUpda this.sdk = sdk; } - public UpdateExpenseTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.UpdateExpenseTransactionRequest request) { + public UpdateExpenseTransactionRequestBuilder request(UpdateExpenseTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateExpenseTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UpdateExpenseTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateExpenseTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateExpenseTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateReimbursableExpenseTransactionRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateReimbursableExpenseTransactionRequestBuilder.java index 8b12acfa..5af8f433 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateReimbursableExpenseTransactionRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateReimbursableExpenseTransactionRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateReimbursableExpenseTransactionRequestBuilder(SDKMethodInterfaces.Me this.sdk = sdk; } - public UpdateReimbursableExpenseTransactionRequestBuilder request(io.codat.sync.expenses.models.operations.UpdateReimbursableExpenseTransactionRequest request) { + public UpdateReimbursableExpenseTransactionRequestBuilder request(UpdateReimbursableExpenseTransactionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateReimbursableExpenseTransactionRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UpdateReimbursableExpenseTransactionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateReimbursableExpenseTransactionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateReimbursableExpenseTransactionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateSupplierRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateSupplierRequestBuilder.java index 56ea37c2..c40d8b2f 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateSupplierRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UpdateSupplierRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateSupplierRequestBuilder(SDKMethodInterfaces.MethodCallUpdateSupplier this.sdk = sdk; } - public UpdateSupplierRequestBuilder request(io.codat.sync.expenses.models.operations.UpdateSupplierRequest request) { + public UpdateSupplierRequestBuilder request(UpdateSupplierRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateSupplierRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UpdateSupplierRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateSupplierRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateSupplierRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UploadExpenseAttachmentRequestBuilder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UploadExpenseAttachmentRequestBuilder.java index 6a02452e..9d87cc2d 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UploadExpenseAttachmentRequestBuilder.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/operations/UploadExpenseAttachmentRequestBuilder.java @@ -19,19 +19,19 @@ public UploadExpenseAttachmentRequestBuilder(SDKMethodInterfaces.MethodCallUploa this.sdk = sdk; } - public UploadExpenseAttachmentRequestBuilder request(io.codat.sync.expenses.models.operations.UploadExpenseAttachmentRequest request) { + public UploadExpenseAttachmentRequestBuilder request(UploadExpenseAttachmentRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UploadExpenseAttachmentRequestBuilder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) { + public UploadExpenseAttachmentRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UploadExpenseAttachmentRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UploadExpenseAttachmentRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncSuccessfulResponse.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncSuccessfulResponse.java new file mode 100644 index 00000000..1fb6da0f --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncSuccessfulResponse.java @@ -0,0 +1,183 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.webhooks; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import io.codat.sync.expenses.utils.Response; +import io.codat.sync.expenses.utils.Utils; +import java.io.InputStream; +import java.lang.Integer; +import java.lang.Override; +import java.lang.String; +import java.net.http.HttpResponse; +import java.util.Objects; + + +public class ExpensesSyncSuccessfulResponse implements Response { + + /** + * HTTP response content type for this operation + */ + private String contentType; + + /** + * HTTP response status code for this operation + */ + private int statusCode; + + /** + * Raw HTTP response; suitable for custom response parsing + */ + private HttpResponse rawResponse; + + @JsonCreator + public ExpensesSyncSuccessfulResponse( + String contentType, + int statusCode, + HttpResponse rawResponse) { + Utils.checkNotNull(contentType, "contentType"); + Utils.checkNotNull(statusCode, "statusCode"); + Utils.checkNotNull(rawResponse, "rawResponse"); + this.contentType = contentType; + this.statusCode = statusCode; + this.rawResponse = rawResponse; + } + + /** + * HTTP response content type for this operation + */ + @JsonIgnore + public String contentType() { + return contentType; + } + + /** + * HTTP response status code for this operation + */ + @JsonIgnore + public int statusCode() { + return statusCode; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + @JsonIgnore + public HttpResponse rawResponse() { + return rawResponse; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * HTTP response content type for this operation + */ + public ExpensesSyncSuccessfulResponse withContentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public ExpensesSyncSuccessfulResponse withStatusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public ExpensesSyncSuccessfulResponse withRawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExpensesSyncSuccessfulResponse other = (ExpensesSyncSuccessfulResponse) o; + return + Objects.deepEquals(this.contentType, other.contentType) && + Objects.deepEquals(this.statusCode, other.statusCode) && + Objects.deepEquals(this.rawResponse, other.rawResponse); + } + + @Override + public int hashCode() { + return Objects.hash( + contentType, + statusCode, + rawResponse); + } + + @Override + public String toString() { + return Utils.toString(ExpensesSyncSuccessfulResponse.class, + "contentType", contentType, + "statusCode", statusCode, + "rawResponse", rawResponse); + } + + public final static class Builder { + + private String contentType; + + private Integer statusCode; + + private HttpResponse rawResponse; + + private Builder() { + // force use of static builder() method + } + + /** + * HTTP response content type for this operation + */ + public Builder contentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public Builder statusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public Builder rawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + public ExpensesSyncSuccessfulResponse build() { + return new ExpensesSyncSuccessfulResponse( + contentType, + statusCode, + rawResponse); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncUnsuccessfulResponse.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncUnsuccessfulResponse.java new file mode 100644 index 00000000..338ba5e6 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/ExpensesSyncUnsuccessfulResponse.java @@ -0,0 +1,183 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.models.webhooks; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import io.codat.sync.expenses.utils.Response; +import io.codat.sync.expenses.utils.Utils; +import java.io.InputStream; +import java.lang.Integer; +import java.lang.Override; +import java.lang.String; +import java.net.http.HttpResponse; +import java.util.Objects; + + +public class ExpensesSyncUnsuccessfulResponse implements Response { + + /** + * HTTP response content type for this operation + */ + private String contentType; + + /** + * HTTP response status code for this operation + */ + private int statusCode; + + /** + * Raw HTTP response; suitable for custom response parsing + */ + private HttpResponse rawResponse; + + @JsonCreator + public ExpensesSyncUnsuccessfulResponse( + String contentType, + int statusCode, + HttpResponse rawResponse) { + Utils.checkNotNull(contentType, "contentType"); + Utils.checkNotNull(statusCode, "statusCode"); + Utils.checkNotNull(rawResponse, "rawResponse"); + this.contentType = contentType; + this.statusCode = statusCode; + this.rawResponse = rawResponse; + } + + /** + * HTTP response content type for this operation + */ + @JsonIgnore + public String contentType() { + return contentType; + } + + /** + * HTTP response status code for this operation + */ + @JsonIgnore + public int statusCode() { + return statusCode; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + @JsonIgnore + public HttpResponse rawResponse() { + return rawResponse; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * HTTP response content type for this operation + */ + public ExpensesSyncUnsuccessfulResponse withContentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public ExpensesSyncUnsuccessfulResponse withStatusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public ExpensesSyncUnsuccessfulResponse withRawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ExpensesSyncUnsuccessfulResponse other = (ExpensesSyncUnsuccessfulResponse) o; + return + Objects.deepEquals(this.contentType, other.contentType) && + Objects.deepEquals(this.statusCode, other.statusCode) && + Objects.deepEquals(this.rawResponse, other.rawResponse); + } + + @Override + public int hashCode() { + return Objects.hash( + contentType, + statusCode, + rawResponse); + } + + @Override + public String toString() { + return Utils.toString(ExpensesSyncUnsuccessfulResponse.class, + "contentType", contentType, + "statusCode", statusCode, + "rawResponse", rawResponse); + } + + public final static class Builder { + + private String contentType; + + private Integer statusCode; + + private HttpResponse rawResponse; + + private Builder() { + // force use of static builder() method + } + + /** + * HTTP response content type for this operation + */ + public Builder contentType(String contentType) { + Utils.checkNotNull(contentType, "contentType"); + this.contentType = contentType; + return this; + } + + /** + * HTTP response status code for this operation + */ + public Builder statusCode(int statusCode) { + Utils.checkNotNull(statusCode, "statusCode"); + this.statusCode = statusCode; + return this; + } + + /** + * Raw HTTP response; suitable for custom response parsing + */ + public Builder rawResponse(HttpResponse rawResponse) { + Utils.checkNotNull(rawResponse, "rawResponse"); + this.rawResponse = rawResponse; + return this; + } + + public ExpensesSyncUnsuccessfulResponse build() { + return new ExpensesSyncUnsuccessfulResponse( + contentType, + statusCode, + rawResponse); + } + } +} + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompleteResponse.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompletedResponse.java similarity index 89% rename from sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompleteResponse.java rename to sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompletedResponse.java index ce9ed53f..1762e4cd 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompleteResponse.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/models/webhooks/SyncCompletedResponse.java @@ -17,7 +17,7 @@ import java.util.Objects; -public class SyncCompleteResponse implements Response { +public class SyncCompletedResponse implements Response { /** * HTTP response content type for this operation @@ -35,7 +35,7 @@ public class SyncCompleteResponse implements Response { private HttpResponse rawResponse; @JsonCreator - public SyncCompleteResponse( + public SyncCompletedResponse( String contentType, int statusCode, HttpResponse rawResponse) { @@ -78,7 +78,7 @@ public final static Builder builder() { /** * HTTP response content type for this operation */ - public SyncCompleteResponse withContentType(String contentType) { + public SyncCompletedResponse withContentType(String contentType) { Utils.checkNotNull(contentType, "contentType"); this.contentType = contentType; return this; @@ -87,7 +87,7 @@ public SyncCompleteResponse withContentType(String contentType) { /** * HTTP response status code for this operation */ - public SyncCompleteResponse withStatusCode(int statusCode) { + public SyncCompletedResponse withStatusCode(int statusCode) { Utils.checkNotNull(statusCode, "statusCode"); this.statusCode = statusCode; return this; @@ -96,7 +96,7 @@ public SyncCompleteResponse withStatusCode(int statusCode) { /** * Raw HTTP response; suitable for custom response parsing */ - public SyncCompleteResponse withRawResponse(HttpResponse rawResponse) { + public SyncCompletedResponse withRawResponse(HttpResponse rawResponse) { Utils.checkNotNull(rawResponse, "rawResponse"); this.rawResponse = rawResponse; return this; @@ -110,7 +110,7 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - SyncCompleteResponse other = (SyncCompleteResponse) o; + SyncCompletedResponse other = (SyncCompletedResponse) o; return Objects.deepEquals(this.contentType, other.contentType) && Objects.deepEquals(this.statusCode, other.statusCode) && @@ -127,7 +127,7 @@ public int hashCode() { @Override public String toString() { - return Utils.toString(SyncCompleteResponse.class, + return Utils.toString(SyncCompletedResponse.class, "contentType", contentType, "statusCode", statusCode, "rawResponse", rawResponse); @@ -172,8 +172,8 @@ public Builder rawResponse(HttpResponse rawResponse) { return this; } - public SyncCompleteResponse build() { - return new SyncCompleteResponse( + public SyncCompletedResponse build() { + return new SyncCompletedResponse( contentType, statusCode, rawResponse); diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/EventStream.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/EventStream.java index c940f849..a3126c37 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/EventStream.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/EventStream.java @@ -33,12 +33,14 @@ public final class EventStream implements AutoCloseable { private final EventStreamReader reader; private final TypeReference typeReference; private final ObjectMapper mapper; + private final Optional terminalMessage; // Internal use only - public EventStream(InputStream in, TypeReference typeReference, ObjectMapper mapper) { + public EventStream(InputStream in, TypeReference typeReference, ObjectMapper mapper, Optional terminalMessage) { this.reader = new EventStreamReader(in); this.typeReference = typeReference; this.mapper = mapper; + this.terminalMessage = terminalMessage; } /** @@ -50,6 +52,7 @@ public EventStream(InputStream in, TypeReference typeReference, ObjectMapper */ public Optional next() throws IOException { return reader.readMessage() // + .filter(x -> !terminalMessage.isPresent() || !terminalMessage.get().equals(x.data())) // .map(x -> Utils.asType(x, mapper, typeReference)); } @@ -124,3 +127,4 @@ public void close() throws Exception { } } + diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/HTTPRequest.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/HTTPRequest.java index aff9b71a..e69c05f6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/HTTPRequest.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/HTTPRequest.java @@ -4,6 +4,7 @@ package io.codat.sync.expenses.utils; +import java.net.URI; import java.net.URISyntaxException; import java.net.http.HttpRequest; import java.net.http.HttpRequest.BodyPublisher; @@ -15,15 +16,15 @@ import java.util.Map; import java.util.Optional; -import org.apache.http.NameValuePair; -import org.apache.http.client.utils.URIBuilder; -import org.apache.http.message.BasicNameValuePair; - public class HTTPRequest { + private static final String FRAGMENT_SEGMENT_START = "#"; + private static final String QUERY_NAME_VALUE_DELIMITER = "="; + private static final String QUERY_PARAMETER_DELIMITER = "&"; + private static final String QUERY_SEGMENT_START = "?"; private final String baseURL; private final String method; - private final List queryParams = new ArrayList<>(); + private final List queryParams = new ArrayList<>(); private final Map> headers = new HashMap<>(); private Optional body = Optional.empty(); // mutable @@ -54,21 +55,21 @@ public HTTPRequest addHeaders(Map> map) { return this; } - public HTTPRequest addQueryParam(String name, String value) { - addQueryParam(new BasicNameValuePair(name, value)); + public HTTPRequest addQueryParam(QueryParameter param) { + this.queryParams.add(param); return this; } - - public HTTPRequest addQueryParam(NameValuePair param) { - this.queryParams.add(param); + + public HTTPRequest addQueryParam(String key, String value, boolean allowReserved) { + this.queryParams.add(QueryParameter.of(key, value, allowReserved)); return this; } - public HTTPRequest addQueryParams(Collection params) { + public HTTPRequest addQueryParams(Collection params) { params.forEach(p -> addQueryParam(p)); return this; } - + public HttpRequest build() { HttpRequest.Builder requestBuilder = HttpRequest.newBuilder(); @@ -81,14 +82,49 @@ public HttpRequest build() { } requestBuilder.method(method, bodyPublisher); try { - URIBuilder b = new URIBuilder(this.baseURL); - queryParams.forEach(pair -> b.addParameter(pair.getName(), pair.getValue())); - requestBuilder.uri(b.build()); + requestBuilder.uri(new URI(buildUrl(baseURL, queryParams))); } catch (URISyntaxException e) { throw new RuntimeException(e); } headers.forEach((k, list) -> list.forEach(v -> requestBuilder.header(k, v))); return requestBuilder.build(); } - + + // VisibleForTesting + public static String buildUrl(String baseURL, Collection queryParams) { + if (queryParams.isEmpty()) { + return baseURL; + } else { + final String base; + final String fragment; + int i = baseURL.indexOf(FRAGMENT_SEGMENT_START); + if (i == -1) { + base = baseURL; + fragment = ""; + } else { + base = baseURL.substring(0, i); + fragment = baseURL.substring(i); + } + StringBuilder b = new StringBuilder(base); + if (!base.contains(QUERY_SEGMENT_START)) { + b.append(QUERY_SEGMENT_START); + } else { + b.append(QUERY_PARAMETER_DELIMITER); + } + boolean first = true; + for (QueryParameter p : queryParams) { + if (!first) { + b.append(QUERY_PARAMETER_DELIMITER); + } + first = false; + // don't allow reserved characters to be unencoded in key (??) + b.append(Utf8UrlEncoder.DEFAULT.encode(p.name())); + b.append(QUERY_NAME_VALUE_DELIMITER); + b.append(Utf8UrlEncoder.allowReserved(p.allowReserved()).encode(p.value())); + } + b.append(fragment); + return b.toString(); + } + } + } \ No newline at end of file diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/OneOfDeserializer.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/OneOfDeserializer.java index 2c63b187..6d5c35e5 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/OneOfDeserializer.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/OneOfDeserializer.java @@ -35,7 +35,7 @@ public class OneOfDeserializer extends StdDeserializer { private static final long serialVersionUID = -1; - private final List typeReferences; // oneOf subschemas + private final transient List typeReferences; // oneOf subschemas private final Class cls; private final boolean strict; private final ObjectMapper mapper; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Options.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Options.java index da1a8523..31b217bc 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Options.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Options.java @@ -13,14 +13,14 @@ public enum Option { RETRY_CONFIG; } - private Optional retryConfig = Optional.empty(); + private Optional retryConfig = Optional.empty(); - private Options(Optional retryConfig) { + private Options(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; } - public Optional retryConfig() { + public Optional retryConfig() { return retryConfig; } @@ -36,17 +36,17 @@ public final static Builder builder() { public final static class Builder { - private Optional retryConfig = Optional.empty(); + private Optional retryConfig = Optional.empty(); private Builder() {} - public Builder retryConfig(io.codat.sync.expenses.utils.RetryConfig retryConfig) throws IllegalArgumentException { + public Builder retryConfig(RetryConfig retryConfig) throws IllegalArgumentException { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public Builder retryConfig(Optional retryConfig) throws IllegalArgumentException { + public Builder retryConfig(Optional retryConfig) throws IllegalArgumentException { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/PathParamsMetadata.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/PathParamsMetadata.java index ce3002fc..4e8c6ee6 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/PathParamsMetadata.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/PathParamsMetadata.java @@ -8,15 +8,17 @@ class PathParamsMetadata { + // these fields set via reflection + String style = "simple"; boolean explode; String name; String serialization; + boolean allowReserved; private PathParamsMetadata() { } - // pathParam:style=simple,explode=false,name=apiID static PathParamsMetadata parse(Field field) throws IllegalArgumentException, IllegalAccessException { return Metadata.parse("pathParam", new PathParamsMetadata(), field); } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameter.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameter.java new file mode 100644 index 00000000..80b464c8 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameter.java @@ -0,0 +1,62 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.utils; + +import java.util.Objects; + +// internal class, not for public use +// TODO move to internal package +public final class QueryParameter { + + private final String name; + private final String value; + private final boolean allowReserved; + + private QueryParameter(String name, String value, boolean allowReserved) { + this.name = name; + this.value = value; + this.allowReserved = allowReserved; + } + + public static QueryParameter of(String name, String value, boolean allowReserved) { + return new QueryParameter(name, value, allowReserved); + } + + public String name() { + return name; + } + + public String value() { + return value; + } + + public boolean allowReserved() { + return allowReserved; + } + + @Override + public String toString() { + return "QueryParameter [name=" + name + ", value=" + value + ", allowReserved=" + allowReserved + "]"; + } + + @Override + public int hashCode() { + return Objects.hash(allowReserved, name, value); + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + QueryParameter other = (QueryParameter) obj; + return allowReserved == other.allowReserved && Objects.equals(name, other.name) + && Objects.equals(value, other.value); + } + +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameters.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameters.java index 1270b3a2..d1680e47 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameters.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParameters.java @@ -11,16 +11,13 @@ import java.util.Map; import java.util.stream.Collectors; -import org.apache.http.NameValuePair; -import org.apache.http.message.BasicNameValuePair; - import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; public class QueryParameters { - public static List parseQueryParams(Class type, T queryParams, + public static List parseQueryParams(Class type, T queryParams, Map>> globals) throws Exception { - List allParams = new ArrayList<>(); + List allParams = new ArrayList<>(); Field[] fields = type.getDeclaredFields(); @@ -45,22 +42,24 @@ public static List parseQueryParams(Class t } if (queryParamsMetadata.serialization != null && !queryParamsMetadata.serialization.isBlank()) { - List params = parseSerializedParams(queryParamsMetadata, value); + List params = parseSerializedParams(queryParamsMetadata, value); allParams.addAll(params); } else { switch (queryParamsMetadata.style) { case "form": - List formParams = parseDelimitedParams(queryParamsMetadata, value, ","); + List formParams = parseDelimitedParams(queryParamsMetadata, value, ","); allParams.addAll(formParams); break; case "deepObject": - List deepObjectParams = parseDeepObjectParams(queryParamsMetadata, value); + List deepObjectParams = parseDeepObjectParams(queryParamsMetadata, value); allParams.addAll(deepObjectParams); break; case "pipeDelimited": - List pipeDelimitedParams = parseDelimitedParams(queryParamsMetadata, value, "|"); + List pipeDelimitedParams = parseDelimitedParams(queryParamsMetadata, value, "|"); allParams.addAll(pipeDelimitedParams); break; + default: + break; } } } @@ -68,25 +67,24 @@ public static List parseQueryParams(Class t return allParams; } - private static List parseSerializedParams(QueryParamsMetadata queryParamsMetadata, Object value) + private static List parseSerializedParams(QueryParamsMetadata queryParamsMetadata, Object value) throws JsonProcessingException { - List params = new ArrayList<>(); - + List params = new ArrayList<>(); switch (queryParamsMetadata.serialization) { case "json": ObjectMapper mapper = JSON.getMapper(); String json = mapper.writeValueAsString(value); - - params.add(new BasicNameValuePair(queryParamsMetadata.name, json)); + params.add(QueryParameter.of(queryParamsMetadata.name, json, queryParamsMetadata.allowReserved)); + break; + default: break; } - return params; } - private static List parseDelimitedParams(QueryParamsMetadata queryParamsMetadata, Object value, String delimiter) + private static List parseDelimitedParams(QueryParamsMetadata queryParamsMetadata, Object value, String delimiter) throws IllegalArgumentException, IllegalAccessException { - List params = new ArrayList<>(); + List params = new ArrayList<>(); switch (Types.getType(value.getClass())) { case ARRAY: { @@ -106,7 +104,7 @@ private static List parseDelimitedParams(QueryParamsMetadata quer values.add(String.join(delimiter, items)); } - params.addAll(values.stream().map(v -> new BasicNameValuePair(queryParamsMetadata.name, v)) + params.addAll(values.stream().map(v -> QueryParameter.of(queryParamsMetadata.name, v, queryParamsMetadata.allowReserved)) .collect(Collectors.toList())); break; } @@ -120,20 +118,20 @@ private static List parseDelimitedParams(QueryParamsMetadata quer String val = Utils.valToString(entry.getValue()); if (queryParamsMetadata.explode) { - params.add(new BasicNameValuePair(key, val)); + params.add(QueryParameter.of(key, val, queryParamsMetadata.allowReserved)); } else { items.add(String.format("%s%s%s", key, delimiter, val)); } } if (items.size() > 0) { - params.add(new BasicNameValuePair(queryParamsMetadata.name, String.join(delimiter, items))); + params.add(QueryParameter.of(queryParamsMetadata.name, String.join(delimiter, items), queryParamsMetadata.allowReserved)); } break; } case OBJECT: { if (!Utils.allowIntrospection(value.getClass())) { - params.add(new BasicNameValuePair(queryParamsMetadata.name, Utils.valToString(value))); + params.add(QueryParameter.of(queryParamsMetadata.name, Utils.valToString(value), queryParamsMetadata.allowReserved)); break; } Field[] fields = value.getClass().getDeclaredFields(); @@ -154,29 +152,29 @@ private static List parseDelimitedParams(QueryParamsMetadata quer } if (queryParamsMetadata.explode) { - params.add(new BasicNameValuePair(metadata.name, Utils.valToString(val))); + params.add(QueryParameter.of(metadata.name, Utils.valToString(val), metadata.allowReserved)); } else { items.add(String.format("%s%s%s", metadata.name, delimiter, Utils.valToString(val))); } } if (items.size() > 0) { - params.add(new BasicNameValuePair(queryParamsMetadata.name, String.join(delimiter, items))); + params.add(QueryParameter.of(queryParamsMetadata.name, String.join(delimiter, items), queryParamsMetadata.allowReserved)); } break; } default: - params.add(new BasicNameValuePair(queryParamsMetadata.name, Utils.valToString(value))); + params.add(QueryParameter.of(queryParamsMetadata.name, Utils.valToString(value), queryParamsMetadata.allowReserved)); break; } return params; } - private static List parseDeepObjectParams(QueryParamsMetadata queryParamsMetadata, Object value) + private static List parseDeepObjectParams(QueryParamsMetadata queryParamsMetadata, Object value) throws Exception { - List params = new ArrayList<>(); + List params = new ArrayList<>(); switch (Types.getType(value.getClass())) { case MAP: { @@ -188,12 +186,12 @@ private static List parseDeepObjectParams(QueryParamsMetadata que if (val instanceof List || val.getClass().isArray()) { for (Object v : Utils.toList(val)) { - params.add(new BasicNameValuePair(String.format("%s[%s]", queryParamsMetadata.name, key), - Utils.valToString(v))); + params.add(QueryParameter.of(String.format("%s[%s]", queryParamsMetadata.name, key), + Utils.valToString(v), queryParamsMetadata.allowReserved)); } } else { - params.add(new BasicNameValuePair(String.format("%s[%s]", queryParamsMetadata.name, key), - Utils.valToString(val))); + params.add(QueryParameter.of(String.format("%s[%s]", queryParamsMetadata.name, key), + Utils.valToString(val), queryParamsMetadata.allowReserved)); } } @@ -220,14 +218,14 @@ private static List parseDeepObjectParams(QueryParamsMetadata que if (val instanceof List || val.getClass().isArray()) { for (Object v : Utils.toList(val)) { - params.add(new BasicNameValuePair( + params.add(QueryParameter.of( String.format("%s[%s]", queryParamsMetadata.name, metadata.name), - Utils.valToString(v))); + Utils.valToString(v), metadata.allowReserved)); } } else { params.add( - new BasicNameValuePair(String.format("%s[%s]", queryParamsMetadata.name, metadata.name), - Utils.valToString(val))); + QueryParameter.of(String.format("%s[%s]", queryParamsMetadata.name, metadata.name), + Utils.valToString(val), metadata.allowReserved)); } } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParamsMetadata.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParamsMetadata.java index 77e224b0..746b34d0 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParamsMetadata.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/QueryParamsMetadata.java @@ -8,12 +8,14 @@ class QueryParamsMetadata { + // these parameters set via reflection + String style = "form"; boolean explode = true; String name; String serialization; + boolean allowReserved; - // queryParam:style=simple,explode=false,name=apiID static QueryParamsMetadata parse(Field field) throws IllegalArgumentException, IllegalAccessException { return Metadata.parse("queryParam", new QueryParamsMetadata(), field); } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Security.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Security.java index f72c26b6..9a5a1856 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Security.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Security.java @@ -5,6 +5,7 @@ package io.codat.sync.expenses.utils; import java.lang.reflect.Field; +import java.nio.charset.StandardCharsets; import java.util.Base64; public final class Security { @@ -107,7 +108,7 @@ private static void parseSecuritySchemeValue(HTTPRequest request, SecurityMetada break; case "query": request.addQueryParam( - securityMetadata.name, Utils.valToString(value)); + securityMetadata.name, Utils.valToString(value), false); break; case "cookie": request.addHeader("Cookie", @@ -122,7 +123,9 @@ private static void parseSecuritySchemeValue(HTTPRequest request, SecurityMetada request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); break; case "oauth2": - request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); + if (!"client_credentials".equals(schemeMetadata.subtype)) { + request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); + } break; case "http": switch (schemeMetadata.subtype) { @@ -171,6 +174,9 @@ private static void parseBasicAuthScheme(HTTPRequest requestBuilder, Object sche } requestBuilder.addHeader("Authorization", - "Basic " + Base64.getEncoder().encodeToString(String.format("%s:%s", username, password).getBytes())); + "Basic " + + Base64.getEncoder() + .encodeToString(String.format("%s:%s", username, password) + .getBytes(StandardCharsets.UTF_8))); } } \ No newline at end of file diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/TypedObject.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/TypedObject.java index 95f2824b..5a32b803 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/TypedObject.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/TypedObject.java @@ -37,7 +37,12 @@ public TypeReference typeReference() { public JsonShape shape() { return shape; } - + + @Override + public String toString() { + return String.valueOf(value); + } + public static TypedObject of(T value, JsonShape shape, TypeReference typeReference) { return new TypedObject(value, shape, typeReference); } diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utf8UrlEncoder.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utf8UrlEncoder.java new file mode 100644 index 00000000..b2294109 --- /dev/null +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utf8UrlEncoder.java @@ -0,0 +1,117 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.sync.expenses.utils; + +import java.io.CharArrayWriter; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.BitSet; +import java.util.Objects; + +// Internal use only +// TODO move to an internal package +public final class Utf8UrlEncoder { + + private static final BitSet DO_NOT_ENCODE_CHARS = createDoNotEncodeChars(); + private static final int CASE_DIFF = ('a' - 'A'); + + private final BitSet safeChars; + + public static final Utf8UrlEncoder ALLOW_RESERVED = new Utf8UrlEncoder(":/?#[]@!$&'()*+,;="); + public static final Utf8UrlEncoder DEFAULT = new Utf8UrlEncoder(""); + + public static Utf8UrlEncoder allowReserved(boolean allowReserved) { + return allowReserved ? ALLOW_RESERVED : DEFAULT; + } + + private Utf8UrlEncoder(String safeCharacters) { + Objects.requireNonNull(safeCharacters, "safeCharacters"); + int max = -1; + for (int i = 0; i < safeCharacters.length(); i++) { + char ch = safeCharacters.charAt(i); + max = Math.max(ch, max); + } + BitSet safeChars = new BitSet(max + 1); + for (int i = 0; i < safeCharacters.length(); i++) { + char ch = safeCharacters.charAt(i); + safeChars.set(ch); + } + this.safeChars = safeChars; + } + + public String encode(String s) { + return encode(s, StandardCharsets.UTF_8); + } + + private String encode(String s, Charset charset) { + boolean changed = false; + StringBuilder out = new StringBuilder(s.length()); + CharArrayWriter writer = new CharArrayWriter(); + + for (int i = 0; i < s.length();) { + int c = (int) s.charAt(i); + if (DO_NOT_ENCODE_CHARS.get(c) || safeChars.get(c)) { + out.append((char) c); + i++; + } else { + // convert to external encoding before hex conversion + do { + writer.write(c); + if (c >= 0xD800 && c <= 0xDBFF) { + if ((i + 1) < s.length()) { + int d = (int) s.charAt(i + 1); + if (d >= 0xDC00 && d <= 0xDFFF) { + writer.write(d); + i++; + } + } + } + i++; + } while (i < s.length() && !DO_NOT_ENCODE_CHARS.get((c = (int) s.charAt(i)))); + + writer.flush(); + String str = new String(writer.toCharArray()); + byte[] ba = str.getBytes(charset); + for (int j = 0; j < ba.length; j++) { + out.append('%'); + char ch = Character.forDigit((ba[j] >> 4) & 0xF, 16); + // converting to use uppercase letter as part of + // the hex value if ch is a letter. + if (Character.isLetter(ch)) { + ch -= CASE_DIFF; + } + out.append(ch); + ch = Character.forDigit(ba[j] & 0xF, 16); + if (Character.isLetter(ch)) { + ch -= CASE_DIFF; + } + out.append(ch); + } + writer.reset(); + changed = true; + } + } + + return (changed ? out.toString() : s); + } + + private static BitSet createDoNotEncodeChars() { + BitSet b = new BitSet(256); + for (int i = 'a'; i <= 'z'; i++) { + b.set(i); + } + for (int i = 'A'; i <= 'Z'; i++) { + b.set(i); + } + for (int i = '0'; i <= '9'; i++) { + b.set(i); + } + b.set('-'); + b.set('_'); + b.set('.'); + b.set('*'); + return b; + } +} diff --git a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utils.java b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utils.java index cde6038e..08221647 100644 --- a/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utils.java +++ b/sync-for-expenses/src/main/java/io/codat/sync/expenses/utils/Utils.java @@ -4,9 +4,11 @@ package io.codat.sync.expenses.utils; -import java.io.InputStream; import java.io.ByteArrayInputStream; +import java.io.File; import java.io.IOException; +import java.io.InputStream; +import java.io.UncheckedIOException; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; @@ -19,21 +21,26 @@ import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.nio.file.StandardOpenOption; import java.time.LocalDate; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; -import java.util.concurrent.Callable; -import java.util.function.BiPredicate; import java.util.HashMap; import java.util.Iterator; +import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Map.Entry; import java.util.NoSuchElementException; import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.Callable; +import java.util.function.BiPredicate; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Collectors; @@ -44,7 +51,6 @@ import org.apache.commons.io.IOUtils; import org.apache.http.NameValuePair; - import org.openapitools.jackson.nullable.JsonNullable; import com.fasterxml.jackson.core.JsonProcessingException; @@ -137,7 +143,9 @@ public static String generateURL(Class type, String baseURL, String path, pathParams.put(pathParamsMetadata.name, String.join(",", - array.stream().map(v -> Utils.valToString(v)) + array.stream() + .map(v -> valToString(v)) + .map(v -> pathEncode(v, pathParamsMetadata.allowReserved)) .collect(Collectors.toList()))); break; case MAP: @@ -149,17 +157,17 @@ public static String generateURL(Class type, String baseURL, String path, pathParams.put(pathParamsMetadata.name, String.join(",", map.entrySet().stream().map(e -> { if (pathParamsMetadata.explode) { - return String.format("%s=%s", Utils.valToString(e.getKey()), - Utils.valToString(e.getValue())); + return String.format("%s=%s", pathEncode(valToString(e.getKey()), false), + pathEncode(valToString(e.getValue()), false)); } else { - return String.format("%s,%s", Utils.valToString(e.getKey()), - Utils.valToString(e.getValue())); + return String.format("%s,%s", pathEncode(valToString(e.getKey()), false), + pathEncode(valToString(e.getValue()), false)); } }).collect(Collectors.toList()))); break; case OBJECT: if (!allowIntrospection(value.getClass())) { - pathParams.put(pathParamsMetadata.name, Utils.valToString(value)); + pathParams.put(pathParamsMetadata.name, pathEncode(valToString(value), pathParamsMetadata.allowReserved)); break; } List values = new ArrayList<>(); @@ -180,17 +188,17 @@ public static String generateURL(Class type, String baseURL, String path, if (pathParamsMetadata.explode) { values.add(String.format("%s=%s", valuePathParamsMetadata.name, - Utils.valToString(val))); + pathEncode(valToString(val), valuePathParamsMetadata.allowReserved))); } else { values.add(String.format("%s,%s", valuePathParamsMetadata.name, - Utils.valToString(val))); + pathEncode(valToString(val), valuePathParamsMetadata.allowReserved))); } } pathParams.put(pathParamsMetadata.name, String.join(",", values)); break; default: - pathParams.put(pathParamsMetadata.name, Utils.valToString(value)); + pathParams.put(pathParamsMetadata.name, pathEncode(valToString(value), pathParamsMetadata.allowReserved)); break; } } @@ -199,6 +207,10 @@ public static String generateURL(Class type, String baseURL, String path, return baseURL + templateUrl(path, pathParams); } + + private static String pathEncode(String s, boolean allowReserved) { + return Utf8UrlEncoder.allowReserved(allowReserved).encode(s); + } public static boolean contentTypeMatches(String contentType, String pattern) { if (contentType == null || contentType.isBlank()) { @@ -249,7 +261,7 @@ public static SerializedBody serializeRequestBody(Object request, String request return RequestBody.serialize(request, requestField, serializationMethod, nullable); } - public static List getQueryParams(Class type, Optional params, + public static List getQueryParams(Class type, Optional params, Map>> globals) throws Exception { if (params.isEmpty()) { return Collections.emptyList(); @@ -258,7 +270,7 @@ public static List getQueryParams(Class typ } } - public static List getQueryParams(Class type, JsonNullable params, + public static List getQueryParams(Class type, JsonNullable params, Map>> globals) throws Exception { if (!params.isPresent() || params.get() == null) { return Collections.emptyList(); @@ -267,7 +279,7 @@ public static List getQueryParams(Class typ } } - public static List getQueryParams(Class type, T params, + public static List getQueryParams(Class type, T params, Map>> globals) throws Exception { return QueryParameters.parseQueryParams(type, params, globals); } @@ -275,6 +287,8 @@ public static List getQueryParams(Class typ public static HTTPRequest configureSecurity(HTTPRequest request, Object security) throws Exception { return Security.configureSecurity(request, security); } + + private static final String DOLLAR_MARKER = "D9qPtyhOYzkHGu3c"; public static String templateUrl(String url, Map params) { StringBuilder sb = new StringBuilder(); @@ -287,12 +301,16 @@ public static String templateUrl(String url, Map params) { String key = match.substring(1, match.length() - 1); String value = params.get(key); if (value != null) { - m.appendReplacement(sb, value); + // note that we replace $ characters in values with a marker + // and then replace the markers at the end with the $ characters + // because the presence of dollar signs can stuff up the next + // regex find + m.appendReplacement(sb, value.replace("$", DOLLAR_MARKER)); } } m.appendTail(sb); - return sb.toString(); + return sb.toString().replace(DOLLAR_MARKER, "$"); } public static Map> getHeadersFromMetadata(Object headers, Map>> globals) throws Exception { @@ -344,10 +362,10 @@ public static Map> getHeadersFromMetadata(Object headers, M if (headerMetadata.explode) { items.add( String.format("%s=%s", valueHeaderMetadata.name, - Utils.valToString(valueFieldValue))); + valToString(valueFieldValue))); } else { items.add(valueHeaderMetadata.name); - items.add(Utils.valToString(valueFieldValue)); + items.add(valToString(valueFieldValue)); } } @@ -370,11 +388,11 @@ public static Map> getHeadersFromMetadata(Object headers, M for (Map.Entry entry : map.entrySet()) { if (headerMetadata.explode) { - items.add(String.format("%s=%s", Utils.valToString(entry.getKey()), - Utils.valToString(entry.getValue()))); + items.add(String.format("%s=%s", valToString(entry.getKey()), + valToString(entry.getValue()))); } else { - items.add(Utils.valToString(entry.getKey())); - items.add(Utils.valToString(entry.getValue())); + items.add(valToString(entry.getKey())); + items.add(valToString(entry.getValue())); } } @@ -397,7 +415,7 @@ public static Map> getHeadersFromMetadata(Object headers, M List items = new ArrayList<>(); for (Object item : array) { - items.add(Utils.valToString(item)); + items.add(valToString(item)); } if (!result.containsKey(headerMetadata.name)) { @@ -415,7 +433,7 @@ public static Map> getHeadersFromMetadata(Object headers, M } List values = result.get(headerMetadata.name); - values.add(Utils.valToString(value)); + values.add(valToString(value)); break; } } @@ -425,17 +443,16 @@ public static Map> getHeadersFromMetadata(Object headers, M } public static String valToString(Object value) { - switch (Types.getType(value.getClass())) { - case ENUM: - try { - Field field = value.getClass().getDeclaredField("value"); - field.setAccessible(true); - return String.valueOf(field.get(value)); - } catch (Exception e) { - return "ERROR_UNKNOWN_VALUE"; - } - default: - return String.valueOf(resolveOptionals(value)); + if (value.getClass().isEnum()) { + try { + Field field = value.getClass().getDeclaredField("value"); + field.setAccessible(true); + return String.valueOf(field.get(value)); + } catch (IllegalArgumentException | IllegalAccessException | NoSuchFieldException | SecurityException e) { + return "ERROR_UNKNOWN_VALUE"; + } + } else { + return String.valueOf(resolveOptionals(value)); } } @@ -464,16 +481,15 @@ public static Object populateGlobal(Object value, String fieldName, String param private static Map parseSerializedParams(PathParamsMetadata pathParamsMetadata, Object value) throws JsonProcessingException { Map params = new HashMap<>(); - switch (pathParamsMetadata.serialization) { case "json": ObjectMapper mapper = JSON.getMapper(); String json = mapper.writeValueAsString(value); - - params.put(pathParamsMetadata.name, URLEncoder.encode(json, StandardCharsets.UTF_8)); + params.put(pathParamsMetadata.name, pathEncode(json, pathParamsMetadata.allowReserved)); + break; + default: break; } - return params; } @@ -961,7 +977,7 @@ public static final class HttpResponseCached implements HttpResponse response) throws IOException { this.response = response; - this.bytes = Utils.toByteArrayAndClose(response.body()); + this.bytes = toByteArrayAndClose(response.body()); } public String bodyAsUtf8() { @@ -1050,4 +1066,130 @@ public static String discriminatorToString(Object o) { return (String) o; } } + + public static void recordTest(String id) { + try { + new File("build").mkdir(); + Files.writeString(Paths.get("build/test-javav2-record.txt"), id + "\n", StandardOpenOption.CREATE, + StandardOpenOption.APPEND); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + /** + * Returns an equivalent url with query parameters sorted by name. Sort is + * stable in that parameters with the same name will not be reordered. + * + * @param url input + * @return url with query parameters sorted by name + */ + public static String sortQueryParameters(String url) { + if (url == null || url.isBlank()) { + return ""; + } + String[] parts = url.split("\\?"); + if (parts.length == 1) { + return url; + } + String query = parts[1]; + String[] params = query.split("&"); + sortByDelimitedKey(params, "="); + return parts[0] + "?" + Arrays.stream(params).collect(Collectors.joining("&")); + } + + public static Object sortSerializedMaps(Object input, String regex, String delim) { + if (input == null) { + return input; + } else if (input instanceof String) { + return sortMapString((String) input, regex, delim); + } else if (input.getClass().isArray()) { + Object[] a = (Object[]) input; + String[] b = new String[a.length]; + for (int i = 0; i < a.length; i++) { + if (!(a[i] instanceof String)) { + throw new IllegalArgumentException("expected array item type of String, found " + a[i]); + } + b[i] = sortMapString((String) a[i], regex, delim); + } + return b; + } else if (input instanceof Map) { + @SuppressWarnings("unchecked") + Map a = (Map) input; + Map b = new LinkedHashMap<>(); + for (Entry entry: a.entrySet()) { + if (!(entry.getKey() instanceof String)) { + throw new IllegalArgumentException("expected map key type of String, found " + entry.getKey()); + } + if (!(entry.getValue() instanceof String)) { + throw new IllegalArgumentException("expected map value type of String, found " + entry.getValue()); + } + b.put((String) entry.getKey(), sortMapString((String) entry.getValue(), regex, delim)); + } + return b; + } else { + throw new IllegalArgumentException("unexpected type: " + input.getClass()); + } + } + + private static String sortMapString(String input, String regex, String delim) { + return Pattern.compile(regex).matcher(input).replaceAll(m -> { + String escapedDelim = Pattern.quote(delim); + String result = m.group(); + for (int i = 1; i <= m.groupCount(); i++) { + final String match = m.group(i); + String[] pairs; + if (match.contains("=")) { + pairs = match.split(escapedDelim); + sortByDelimitedKey(pairs, "="); + } else { + String[] values = match.split(escapedDelim); + if (values.length == 1) { + pairs = values; + } else { + pairs = new String[values.length / 2]; + for (int j = 0; j < values.length; j += 2) { + pairs[j / 2] = values[j] + delim + values[j + 1]; + } + } + sortByDelimitedKey(pairs, delim); + } + String joined = Arrays.stream(pairs).collect(Collectors.joining(delim)); + result = result.replace(m.group(i), joined); + } + return result; + }); + } + + private static void sortByDelimitedKey(String[] array, String delim) { + Arrays.sort(array, (a, b) -> { + String escapedDelim = Pattern.quote(delim); + String aKey = a.split(escapedDelim)[0]; + String bKey = b.split(escapedDelim)[0]; + return aKey.compareTo(bKey); + }); + } + + public static boolean isPresentAndNotNull(Optional x) { + return x.isPresent(); + } + + public static boolean isPresentAndNotNull(JsonNullable x) { + return x.isPresent() && x.get() != null; + } + + public static void setSseSentinel(Object o, String value) { + if (o == null || value.isBlank()) { + return; + } else { + try { + Field field = o.getClass().getDeclaredField("_eventSentinel"); + field.setAccessible(true); + field.set(o, Optional.of(value)); + } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) { + // ignore + } + } + } + }